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

   1 //! The top-level channel management and payment tracking stuff lives here.
   2 //!
   3 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
   4 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
   5 //! upon reconnect to the relevant peer(s).
   6 //!
   7 //! It does not manage routing logic (see ln::router for that) nor does it manage constructing
   8 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
   9 //! imply it needs to fail HTLCs/payments/channels it manages).
  10
  11 use bitcoin::blockdata::block::BlockHeader;
  12 use bitcoin::blockdata::transaction::Transaction;
  13 use bitcoin::blockdata::constants::genesis_block;
  14 use bitcoin::network::constants::Network;
  15 use bitcoin::network::serialize::BitcoinHash;
  16 use bitcoin::util::hash::Sha256dHash;
  17
  18 use secp256k1::key::{SecretKey,PublicKey};
  19 use secp256k1::{Secp256k1,Message};
  20 use secp256k1::ecdh::SharedSecret;
  21 use secp256k1;
  22
  23 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
  24 use chain::transaction::OutPoint;
  25 use ln::channel::{Channel, ChannelError};
  26 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS};
  27 use ln::router::{Route,RouteHop};
  28 use ln::msgs;
  29 use ln::msgs::{ChannelMessageHandler, DecodeError, HandleError};
  30 use chain::keysinterface::KeysInterface;
  31 use util::config::UserConfig;
  32 use util::{byte_utils, events, internal_traits, rng};
  33 use util::sha2::Sha256;
  34 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
  35 use util::chacha20poly1305rfc::ChaCha20;
  36 use util::logger::Logger;
  37 use util::errors::APIError;
  38
  39 use crypto;
  40 use crypto::mac::{Mac,MacResult};
  41 use crypto::hmac::Hmac;
  42 use crypto::digest::Digest;
  43 use crypto::symmetriccipher::SynchronousStreamCipher;
  44
  45 use std::{cmp, ptr, mem};
  46 use std::collections::{HashMap, hash_map, HashSet};
  47 use std::io::Cursor;
  48 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
  49 use std::sync::atomic::{AtomicUsize, Ordering};
  50 use std::time::{Instant,Duration};
  51
  52 /// We hold various information about HTLC relay in the HTLC objects in Channel itself:
  53 ///
  54 /// Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
  55 /// forward the HTLC with information it will give back to us when it does so, or if it should Fail
  56 /// the HTLC with the relevant message for the Channel to handle giving to the remote peer.
  57 ///
  58 /// When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo
  59 /// which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData
  60 /// filled in to indicate where it came from (which we can use to either fail-backwards or fulfill
  61 /// the HTLC backwards along the relevant path).
  62 /// Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
  63 /// our payment, which we can use to decode errors or inform the user that the payment was sent.
  64 mod channel_held_info {
  65         use ln::msgs;
  66         use ln::router::Route;
  67         use secp256k1::key::SecretKey;
  68
  69         /// Stores the info we will need to send when we want to forward an HTLC onwards
  70         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
  71         pub struct PendingForwardHTLCInfo {
  72                 pub(super) onion_packet: Option<msgs::OnionPacket>,
  73                 pub(super) incoming_shared_secret: [u8; 32],
  74                 pub(super) payment_hash: [u8; 32],
  75                 pub(super) short_channel_id: u64,
  76                 pub(super) amt_to_forward: u64,
  77                 pub(super) outgoing_cltv_value: u32,
  78         }
  79
  80         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
  81         pub enum HTLCFailureMsg {
  82                 Relay(msgs::UpdateFailHTLC),
  83                 Malformed(msgs::UpdateFailMalformedHTLC),
  84         }
  85
  86         /// Stores whether we can't forward an HTLC or relevant forwarding info
  87         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
  88         pub enum PendingHTLCStatus {
  89                 Forward(PendingForwardHTLCInfo),
  90                 Fail(HTLCFailureMsg),
  91         }
  92
  93         /// Tracks the inbound corresponding to an outbound HTLC
  94         #[derive(Clone)]
  95         pub struct HTLCPreviousHopData {
  96                 pub(super) short_channel_id: u64,
  97                 pub(super) htlc_id: u64,
  98                 pub(super) incoming_packet_shared_secret: [u8; 32],
  99         }
 100
 101         /// Tracks the inbound corresponding to an outbound HTLC
 102         #[derive(Clone)]
 103         pub enum HTLCSource {
 104                 PreviousHopData(HTLCPreviousHopData),
 105                 OutboundRoute {
 106                         route: Route,
 107                         session_priv: SecretKey,
 108                         /// Technically we can recalculate this from the route, but we cache it here to avoid
 109                         /// doing a double-pass on route when we get a failure back
 110                         first_hop_htlc_msat: u64,
 111                 },
 112         }
 113         #[cfg(test)]
 114         impl HTLCSource {
 115                 pub fn dummy() -> Self {
 116                         HTLCSource::OutboundRoute {
 117                                 route: Route { hops: Vec::new() },
 118                                 session_priv: SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[1; 32]).unwrap(),
 119                                 first_hop_htlc_msat: 0,
 120                         }
 121                 }
 122         }
 123
 124         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
 125         pub(crate) enum HTLCFailReason {
 126                 ErrorPacket {
 127                         err: msgs::OnionErrorPacket,
 128                 },
 129                 Reason {
 130                         failure_code: u16,
 131                         data: Vec<u8>,
 132                 }
 133         }
 134 }
 135 pub(super) use self::channel_held_info::*;
 136
 137 struct MsgHandleErrInternal {
 138         err: msgs::HandleError,
 139         needs_channel_force_close: bool,
 140 }
 141 impl MsgHandleErrInternal {
 142         #[inline]
 143         fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
 144                 Self {
 145                         err: HandleError {
 146                                 err,
 147                                 action: Some(msgs::ErrorAction::SendErrorMessage {
 148                                         msg: msgs::ErrorMessage {
 149                                                 channel_id,
 150                                                 data: err.to_string()
 151                                         },
 152                                 }),
 153                         },
 154                         needs_channel_force_close: false,
 155                 }
 156         }
 157         #[inline]
 158         fn send_err_msg_close_chan(err: &'static str, channel_id: [u8; 32]) -> Self {
 159                 Self {
 160                         err: HandleError {
 161                                 err,
 162                                 action: Some(msgs::ErrorAction::SendErrorMessage {
 163                                         msg: msgs::ErrorMessage {
 164                                                 channel_id,
 165                                                 data: err.to_string()
 166                                         },
 167                                 }),
 168                         },
 169                         needs_channel_force_close: true,
 170                 }
 171         }
 172         #[inline]
 173         fn from_maybe_close(err: msgs::HandleError) -> Self {
 174                 Self { err, needs_channel_force_close: true }
 175         }
 176         #[inline]
 177         fn from_no_close(err: msgs::HandleError) -> Self {
 178                 Self { err, needs_channel_force_close: false }
 179         }
 180         #[inline]
 181         fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
 182                 Self {
 183                         err: match err {
 184                                 ChannelError::Ignore(msg) => HandleError {
 185                                         err: msg,
 186                                         action: Some(msgs::ErrorAction::IgnoreError),
 187                                 },
 188                                 ChannelError::Close(msg) => HandleError {
 189                                         err: msg,
 190                                         action: Some(msgs::ErrorAction::SendErrorMessage {
 191                                                 msg: msgs::ErrorMessage {
 192                                                         channel_id,
 193                                                         data: msg.to_string()
 194                                                 },
 195                                         }),
 196                                 },
 197                         },
 198                         needs_channel_force_close: false,
 199                 }
 200         }
 201         #[inline]
 202         fn from_chan_maybe_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
 203                 Self {
 204                         err: match err {
 205                                 ChannelError::Ignore(msg) => HandleError {
 206                                         err: msg,
 207                                         action: Some(msgs::ErrorAction::IgnoreError),
 208                                 },
 209                                 ChannelError::Close(msg) => HandleError {
 210                                         err: msg,
 211                                         action: Some(msgs::ErrorAction::SendErrorMessage {
 212                                                 msg: msgs::ErrorMessage {
 213                                                         channel_id,
 214                                                         data: msg.to_string()
 215                                                 },
 216                                         }),
 217                                 },
 218                         },
 219                         needs_channel_force_close: true,
 220                 }
 221         }
 222 }
 223
 224 /// Pass to fail_htlc_backwwards to indicate the reason to fail the payment
 225 /// after a PaymentReceived event.
 226 #[derive(PartialEq)]
 227 pub enum PaymentFailReason {
 228         /// Indicate the preimage for payment_hash is not known after a PaymentReceived event
 229         PreimageUnknown,
 230         /// Indicate the payment amount is incorrect ( received is < expected or > 2*expected ) after a PaymentReceived event
 231         AmountMismatch,
 232 }
 233
 234 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
 235 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
 236 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
 237 /// probably increase this significantly.
 238 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
 239
 240 struct HTLCForwardInfo {
 241         prev_short_channel_id: u64,
 242         prev_htlc_id: u64,
 243         forward_info: PendingForwardHTLCInfo,
 244 }
 245
 246 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
 247 /// be sent in the order they appear in the return value, however sometimes the order needs to be
 248 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
 249 /// they were originally sent). In those cases, this enum is also returned.
 250 #[derive(Clone, PartialEq)]
 251 pub(super) enum RAACommitmentOrder {
 252         /// Send the CommitmentUpdate messages first
 253         CommitmentFirst,
 254         /// Send the RevokeAndACK message first
 255         RevokeAndACKFirst,
 256 }
 257
 258 struct ChannelHolder {
 259         by_id: HashMap<[u8; 32], Channel>,
 260         short_to_id: HashMap<u64, [u8; 32]>,
 261         next_forward: Instant,
 262         /// short channel id -> forward infos. Key of 0 means payments received
 263         /// Note that while this is held in the same mutex as the channels themselves, no consistency
 264         /// guarantees are made about there existing a channel with the short id here, nor the short
 265         /// ids in the PendingForwardHTLCInfo!
 266         forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
 267         /// Note that while this is held in the same mutex as the channels themselves, no consistency
 268         /// guarantees are made about the channels given here actually existing anymore by the time you
 269         /// go to read them!
 270         claimable_htlcs: HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
 271         /// Messages to send to peers - pushed to in the same lock that they are generated in (except
 272         /// for broadcast messages, where ordering isn't as strict).
 273         pending_msg_events: Vec<events::MessageSendEvent>,
 274 }
 275 struct MutChannelHolder<'a> {
 276         by_id: &'a mut HashMap<[u8; 32], Channel>,
 277         short_to_id: &'a mut HashMap<u64, [u8; 32]>,
 278         next_forward: &'a mut Instant,
 279         forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
 280         claimable_htlcs: &'a mut HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
 281         pending_msg_events: &'a mut Vec<events::MessageSendEvent>,
 282 }
 283 impl ChannelHolder {
 284         fn borrow_parts(&mut self) -> MutChannelHolder {
 285                 MutChannelHolder {
 286                         by_id: &mut self.by_id,
 287                         short_to_id: &mut self.short_to_id,
 288                         next_forward: &mut self.next_forward,
 289                         forward_htlcs: &mut self.forward_htlcs,
 290                         claimable_htlcs: &mut self.claimable_htlcs,
 291                         pending_msg_events: &mut self.pending_msg_events,
 292                 }
 293         }
 294 }
 295
 296 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
 297 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
 298
 299 /// Manager which keeps track of a number of channels and sends messages to the appropriate
 300 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
 301 ///
 302 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
 303 /// to individual Channels.
 304 ///
 305 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
 306 /// all peers during write/read (though does not modify this instance, only the instance being
 307 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
 308 /// called funding_transaction_generated for outbound channels).
 309 ///
 310 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
 311 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
 312 /// returning from ManyChannelMonitor::add_update_monitor, with ChannelManagers, writing updates
 313 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
 314 /// the serialization process). If the deserialized version is out-of-date compared to the
 315 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
 316 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
 317 ///
 318 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
 319 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
 320 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
 321 /// block_connected() to step towards your best block) upon deserialization before using the
 322 /// object!
 323 pub struct ChannelManager {
 324         default_configuration: UserConfig,
 325         genesis_hash: Sha256dHash,
 326         fee_estimator: Arc<FeeEstimator>,
 327         monitor: Arc<ManyChannelMonitor>,
 328         chain_monitor: Arc<ChainWatchInterface>,
 329         tx_broadcaster: Arc<BroadcasterInterface>,
 330
 331         latest_block_height: AtomicUsize,
 332         last_block_hash: Mutex<Sha256dHash>,
 333         secp_ctx: Secp256k1<secp256k1::All>,
 334
 335         channel_state: Mutex<ChannelHolder>,
 336         our_network_key: SecretKey,
 337
 338         pending_events: Mutex<Vec<events::Event>>,
 339         /// Used when we have to take a BIG lock to make sure everything is self-consistent.
 340         /// Essentially just when we're serializing ourselves out.
 341         /// Taken first everywhere where we are making changes before any other locks.
 342         total_consistency_lock: RwLock<()>,
 343
 344         keys_manager: Arc<KeysInterface>,
 345
 346         logger: Arc<Logger>,
 347 }
 348
 349 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
 350 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
 351 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
 352 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
 353 /// CLTV_CLAIM_BUFFER point (we static assert that its at least 3 blocks more).
 354 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
 355 const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
 356
 357 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + 2*HTLC_FAIL_TIMEOUT_BLOCKS, ie that
 358 // if the next-hop peer fails the HTLC within HTLC_FAIL_TIMEOUT_BLOCKS then we'll still have
 359 // HTLC_FAIL_TIMEOUT_BLOCKS left to fail it backwards ourselves before hitting the
 360 // CLTV_CLAIM_BUFFER point and failing the channel on-chain to time out the HTLC.
 361 #[deny(const_err)]
 362 #[allow(dead_code)]
 363 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - 2*HTLC_FAIL_TIMEOUT_BLOCKS - CLTV_CLAIM_BUFFER;
 364
 365 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
 366 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
 367 #[deny(const_err)]
 368 #[allow(dead_code)]
 369 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - HTLC_FAIL_TIMEOUT_BLOCKS - 2*CLTV_CLAIM_BUFFER;
 370
 371 macro_rules! secp_call {
 372         ( $res: expr, $err: expr ) => {
 373                 match $res {
 374                         Ok(key) => key,
 375                         Err(_) => return Err($err),
 376                 }
 377         };
 378 }
 379
 380 struct OnionKeys {
 381         #[cfg(test)]
 382         shared_secret: SharedSecret,
 383         #[cfg(test)]
 384         blinding_factor: [u8; 32],
 385         ephemeral_pubkey: PublicKey,
 386         rho: [u8; 32],
 387         mu: [u8; 32],
 388 }
 389
 390 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
 391 pub struct ChannelDetails {
 392         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
 393         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
 394         /// Note that this means this value is *not* persistent - it can change once during the
 395         /// lifetime of the channel.
 396         pub channel_id: [u8; 32],
 397         /// The position of the funding transaction in the chain. None if the funding transaction has
 398         /// not yet been confirmed and the channel fully opened.
 399         pub short_channel_id: Option<u64>,
 400         /// The node_id of our counterparty
 401         pub remote_network_id: PublicKey,
 402         /// The value, in satoshis, of this channel as appears in the funding output
 403         pub channel_value_satoshis: u64,
 404         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
 405         pub user_id: u64,
 406 }
 407
 408 impl ChannelManager {
 409         /// Constructs a new ChannelManager to hold several channels and route between them.
 410         ///
 411         /// This is the main "logic hub" for all channel-related actions, and implements
 412         /// ChannelMessageHandler.
 413         ///
 414         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
 415         ///
 416         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
 417         pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface>, config: UserConfig) -> Result<Arc<ChannelManager>, secp256k1::Error> {
 418                 let secp_ctx = Secp256k1::new();
 419
 420                 let res = Arc::new(ChannelManager {
 421                         default_configuration: config.clone(),
 422                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
 423                         fee_estimator: feeest.clone(),
 424                         monitor: monitor.clone(),
 425                         chain_monitor,
 426                         tx_broadcaster,
 427
 428                         latest_block_height: AtomicUsize::new(0), //TODO: Get an init value
 429                         last_block_hash: Mutex::new(Default::default()),
 430                         secp_ctx,
 431
 432                         channel_state: Mutex::new(ChannelHolder{
 433                                 by_id: HashMap::new(),
 434                                 short_to_id: HashMap::new(),
 435                                 next_forward: Instant::now(),
 436                                 forward_htlcs: HashMap::new(),
 437                                 claimable_htlcs: HashMap::new(),
 438                                 pending_msg_events: Vec::new(),
 439                         }),
 440                         our_network_key: keys_manager.get_node_secret(),
 441
 442                         pending_events: Mutex::new(Vec::new()),
 443                         total_consistency_lock: RwLock::new(()),
 444
 445                         keys_manager,
 446
 447                         logger,
 448                 });
 449                 let weak_res = Arc::downgrade(&res);
 450                 res.chain_monitor.register_listener(weak_res);
 451                 Ok(res)
 452         }
 453
 454         /// Creates a new outbound channel to the given remote node and with the given value.
 455         ///
 456         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
 457         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
 458         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
 459         /// may wish to avoid using 0 for user_id here.
 460         ///
 461         /// If successful, will generate a SendOpenChannel message event, so you should probably poll
 462         /// PeerManager::process_events afterwards.
 463         ///
 464         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
 465         /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
 466         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
 467                 if channel_value_satoshis < 1000 {
 468                         return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
 469                 }
 470
 471                 let channel = Channel::new_outbound(&*self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, Arc::clone(&self.logger), &self.default_configuration)?;
 472                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
 473
 474                 let _ = self.total_consistency_lock.read().unwrap();
 475                 let mut channel_state = self.channel_state.lock().unwrap();
 476                 match channel_state.by_id.entry(channel.channel_id()) {
 477                         hash_map::Entry::Occupied(_) => {
 478                                 if cfg!(feature = "fuzztarget") {
 479                                         return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
 480                                 } else {
 481                                         panic!("RNG is bad???");
 482                                 }
 483                         },
 484                         hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
 485                 }
 486                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
 487                         node_id: their_network_key,
 488                         msg: res,
 489                 });
 490                 Ok(())
 491         }
 492
 493         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
 494         /// more information.
 495         pub fn list_channels(&self) -> Vec<ChannelDetails> {
 496                 let channel_state = self.channel_state.lock().unwrap();
 497                 let mut res = Vec::with_capacity(channel_state.by_id.len());
 498                 for (channel_id, channel) in channel_state.by_id.iter() {
 499                         res.push(ChannelDetails {
 500                                 channel_id: (*channel_id).clone(),
 501                                 short_channel_id: channel.get_short_channel_id(),
 502                                 remote_network_id: channel.get_their_node_id(),
 503                                 channel_value_satoshis: channel.get_value_satoshis(),
 504                                 user_id: channel.get_user_id(),
 505                         });
 506                 }
 507                 res
 508         }
 509
 510         /// Gets the list of usable channels, in random order. Useful as an argument to
 511         /// Router::get_route to ensure non-announced channels are used.
 512         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
 513                 let channel_state = self.channel_state.lock().unwrap();
 514                 let mut res = Vec::with_capacity(channel_state.by_id.len());
 515                 for (channel_id, channel) in channel_state.by_id.iter() {
 516                         // Note we use is_live here instead of usable which leads to somewhat confused
 517                         // internal/external nomenclature, but that's ok cause that's probably what the user
 518                         // really wanted anyway.
 519                         if channel.is_live() {
 520                                 res.push(ChannelDetails {
 521                                         channel_id: (*channel_id).clone(),
 522                                         short_channel_id: channel.get_short_channel_id(),
 523                                         remote_network_id: channel.get_their_node_id(),
 524                                         channel_value_satoshis: channel.get_value_satoshis(),
 525                                         user_id: channel.get_user_id(),
 526                                 });
 527                         }
 528                 }
 529                 res
 530         }
 531
 532         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
 533         /// will be accepted on the given channel, and after additional timeout/the closing of all
 534         /// pending HTLCs, the channel will be closed on chain.
 535         ///
 536         /// May generate a SendShutdown message event on success, which should be relayed.
 537         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
 538                 let _ = self.total_consistency_lock.read().unwrap();
 539
 540                 let (mut failed_htlcs, chan_option) = {
 541                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 542                         let channel_state = channel_state_lock.borrow_parts();
 543                         match channel_state.by_id.entry(channel_id.clone()) {
 544                                 hash_map::Entry::Occupied(mut chan_entry) => {
 545                                         let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
 546                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
 547                                                 node_id: chan_entry.get().get_their_node_id(),
 548                                                 msg: shutdown_msg
 549                                         });
 550                                         if chan_entry.get().is_shutdown() {
 551                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
 552                                                         channel_state.short_to_id.remove(&short_id);
 553                                                 }
 554                                                 (failed_htlcs, Some(chan_entry.remove_entry().1))
 555                                         } else { (failed_htlcs, None) }
 556                                 },
 557                                 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
 558                         }
 559                 };
 560                 for htlc_source in failed_htlcs.drain(..) {
 561                         // unknown_next_peer...I dunno who that is anymore....
 562                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
 563                 }
 564                 let chan_update = if let Some(chan) = chan_option {
 565                         if let Ok(update) = self.get_channel_update(&chan) {
 566                                 Some(update)
 567                         } else { None }
 568                 } else { None };
 569
 570                 if let Some(update) = chan_update {
 571                         let mut channel_state = self.channel_state.lock().unwrap();
 572                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
 573                                 msg: update
 574                         });
 575                 }
 576
 577                 Ok(())
 578         }
 579
 580         #[inline]
 581         fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>)) {
 582                 let (local_txn, mut failed_htlcs) = shutdown_res;
 583                 for htlc_source in failed_htlcs.drain(..) {
 584                         // unknown_next_peer...I dunno who that is anymore....
 585                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
 586                 }
 587                 for tx in local_txn {
 588                         self.tx_broadcaster.broadcast_transaction(&tx);
 589                 }
 590                 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
 591                 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
 592                 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
 593                 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
 594                 //timeouts are hit and our claims confirm).
 595                 //TODO: In any case, we need to make sure we remove any pending htlc tracking (via
 596                 //fail_backwards or claim_funds) eventually for all HTLCs that were in the channel
 597         }
 598
 599         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
 600         /// the chain and rejecting new HTLCs on the given channel.
 601         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
 602                 let _ = self.total_consistency_lock.read().unwrap();
 603
 604                 let mut chan = {
 605                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 606                         let channel_state = channel_state_lock.borrow_parts();
 607                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
 608                                 if let Some(short_id) = chan.get_short_channel_id() {
 609                                         channel_state.short_to_id.remove(&short_id);
 610                                 }
 611                                 chan
 612                         } else {
 613                                 return;
 614                         }
 615                 };
 616                 self.finish_force_close_channel(chan.force_shutdown());
 617                 if let Ok(update) = self.get_channel_update(&chan) {
 618                         let mut channel_state = self.channel_state.lock().unwrap();
 619                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
 620                                 msg: update
 621                         });
 622                 }
 623         }
 624
 625         /// Force close all channels, immediately broadcasting the latest local commitment transaction
 626         /// for each to the chain and rejecting new HTLCs on each.
 627         pub fn force_close_all_channels(&self) {
 628                 for chan in self.list_channels() {
 629                         self.force_close_channel(&chan.channel_id);
 630                 }
 631         }
 632
 633         fn handle_monitor_update_fail(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, channel_id: &[u8; 32], err: ChannelMonitorUpdateErr, reason: RAACommitmentOrder) {
 634                 match err {
 635                         ChannelMonitorUpdateErr::PermanentFailure => {
 636                                 let mut chan = {
 637                                         let channel_state = channel_state_lock.borrow_parts();
 638                                         let chan = channel_state.by_id.remove(channel_id).expect("monitor_update_failed must be called within the same lock as the channel get!");
 639                                         if let Some(short_id) = chan.get_short_channel_id() {
 640                                                 channel_state.short_to_id.remove(&short_id);
 641                                         }
 642                                         chan
 643                                 };
 644                                 mem::drop(channel_state_lock);
 645                                 self.finish_force_close_channel(chan.force_shutdown());
 646                                 if let Ok(update) = self.get_channel_update(&chan) {
 647                                         let mut channel_state = self.channel_state.lock().unwrap();
 648                                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
 649                                                 msg: update
 650                                         });
 651                                 }
 652                         },
 653                         ChannelMonitorUpdateErr::TemporaryFailure => {
 654                                 let channel = channel_state_lock.by_id.get_mut(channel_id).expect("monitor_update_failed must be called within the same lock as the channel get!");
 655                                 channel.monitor_update_failed(reason);
 656                         },
 657                 }
 658         }
 659
 660         #[inline]
 661         fn gen_rho_mu_from_shared_secret(shared_secret: &[u8]) -> ([u8; 32], [u8; 32]) {
 662                 assert_eq!(shared_secret.len(), 32);
 663                 ({
 664                         let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
 665                         hmac.input(&shared_secret[..]);
 666                         let mut res = [0; 32];
 667                         hmac.raw_result(&mut res);
 668                         res
 669                 },
 670                 {
 671                         let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
 672                         hmac.input(&shared_secret[..]);
 673                         let mut res = [0; 32];
 674                         hmac.raw_result(&mut res);
 675                         res
 676                 })
 677         }
 678
 679         #[inline]
 680         fn gen_um_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
 681                 assert_eq!(shared_secret.len(), 32);
 682                 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
 683                 hmac.input(&shared_secret[..]);
 684                 let mut res = [0; 32];
 685                 hmac.raw_result(&mut res);
 686                 res
 687         }
 688
 689         #[inline]
 690         fn gen_ammag_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
 691                 assert_eq!(shared_secret.len(), 32);
 692                 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
 693                 hmac.input(&shared_secret[..]);
 694                 let mut res = [0; 32];
 695                 hmac.raw_result(&mut res);
 696                 res
 697         }
 698
 699         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 700         #[inline]
 701         fn construct_onion_keys_callback<T: secp256k1::Signing, FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey, mut callback: FType) -> Result<(), secp256k1::Error> {
 702                 let mut blinded_priv = session_priv.clone();
 703                 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 704
 705                 for hop in route.hops.iter() {
 706                         let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
 707
 708                         let mut sha = Sha256::new();
 709                         sha.input(&blinded_pub.serialize()[..]);
 710                         sha.input(&shared_secret[..]);
 711                         let mut blinding_factor = [0u8; 32];
 712                         sha.result(&mut blinding_factor);
 713
 714                         let ephemeral_pubkey = blinded_pub;
 715
 716                         blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
 717                         blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 718
 719                         callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
 720                 }
 721
 722                 Ok(())
 723         }
 724
 725         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 726         fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
 727                 let mut res = Vec::with_capacity(route.hops.len());
 728
 729                 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
 730                         let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret[..]);
 731
 732                         res.push(OnionKeys {
 733                                 #[cfg(test)]
 734                                 shared_secret,
 735                                 #[cfg(test)]
 736                                 blinding_factor: _blinding_factor,
 737                                 ephemeral_pubkey,
 738                                 rho,
 739                                 mu,
 740                         });
 741                 })?;
 742
 743                 Ok(res)
 744         }
 745
 746         /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
 747         fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
 748                 let mut cur_value_msat = 0u64;
 749                 let mut cur_cltv = starting_htlc_offset;
 750                 let mut last_short_channel_id = 0;
 751                 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
 752                 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
 753                 unsafe { res.set_len(route.hops.len()); }
 754
 755                 for (idx, hop) in route.hops.iter().enumerate().rev() {
 756                         // First hop gets special values so that it can check, on receipt, that everything is
 757                         // exactly as it should be (and the next hop isn't trying to probe to find out if we're
 758                         // the intended recipient).
 759                         let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
 760                         let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
 761                         res[idx] = msgs::OnionHopData {
 762                                 realm: 0,
 763                                 data: msgs::OnionRealm0HopData {
 764                                         short_channel_id: last_short_channel_id,
 765                                         amt_to_forward: value_msat,
 766                                         outgoing_cltv_value: cltv,
 767                                 },
 768                                 hmac: [0; 32],
 769                         };
 770                         cur_value_msat += hop.fee_msat;
 771                         if cur_value_msat >= 21000000 * 100000000 * 1000 {
 772                                 return Err(APIError::RouteError{err: "Channel fees overflowed?!"});
 773                         }
 774                         cur_cltv += hop.cltv_expiry_delta as u32;
 775                         if cur_cltv >= 500000000 {
 776                                 return Err(APIError::RouteError{err: "Channel CLTV overflowed?!"});
 777                         }
 778                         last_short_channel_id = hop.short_channel_id;
 779                 }
 780                 Ok((res, cur_value_msat, cur_cltv))
 781         }
 782
 783         #[inline]
 784         fn shift_arr_right(arr: &mut [u8; 20*65]) {
 785                 unsafe {
 786                         ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
 787                 }
 788                 for i in 0..65 {
 789                         arr[i] = 0;
 790                 }
 791         }
 792
 793         #[inline]
 794         fn xor_bufs(dst: &mut[u8], src: &[u8]) {
 795                 assert_eq!(dst.len(), src.len());
 796
 797                 for i in 0..dst.len() {
 798                         dst[i] ^= src[i];
 799                 }
 800         }
 801
 802         const ZERO:[u8; 21*65] = [0; 21*65];
 803         fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> msgs::OnionPacket {
 804                 let mut buf = Vec::with_capacity(21*65);
 805                 buf.resize(21*65, 0);
 806
 807                 let filler = {
 808                         let iters = payloads.len() - 1;
 809                         let end_len = iters * 65;
 810                         let mut res = Vec::with_capacity(end_len);
 811                         res.resize(end_len, 0);
 812
 813                         for (i, keys) in onion_keys.iter().enumerate() {
 814                                 if i == payloads.len() - 1 { continue; }
 815                                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 816                                 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
 817                                 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
 818                         }
 819                         res
 820                 };
 821
 822                 let mut packet_data = [0; 20*65];
 823                 let mut hmac_res = [0; 32];
 824
 825                 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
 826                         ChannelManager::shift_arr_right(&mut packet_data);
 827                         payload.hmac = hmac_res;
 828                         packet_data[0..65].copy_from_slice(&payload.encode()[..]);
 829
 830                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 831                         chacha.process(&packet_data, &mut buf[0..20*65]);
 832                         packet_data[..].copy_from_slice(&buf[0..20*65]);
 833
 834                         if i == 0 {
 835                                 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
 836                         }
 837
 838                         let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
 839                         hmac.input(&packet_data);
 840                         hmac.input(&associated_data[..]);
 841                         hmac.raw_result(&mut hmac_res);
 842                 }
 843
 844                 msgs::OnionPacket{
 845                         version: 0,
 846                         public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
 847                         hop_data: packet_data,
 848                         hmac: hmac_res,
 849                 }
 850         }
 851
 852         /// Encrypts a failure packet. raw_packet can either be a
 853         /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
 854         fn encrypt_failure_packet(shared_secret: &[u8], raw_packet: &[u8]) -> msgs::OnionErrorPacket {
 855                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
 856
 857                 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
 858                 packet_crypted.resize(raw_packet.len(), 0);
 859                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
 860                 chacha.process(&raw_packet, &mut packet_crypted[..]);
 861                 msgs::OnionErrorPacket {
 862                         data: packet_crypted,
 863                 }
 864         }
 865
 866         fn build_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
 867                 assert_eq!(shared_secret.len(), 32);
 868                 assert!(failure_data.len() <= 256 - 2);
 869
 870                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
 871
 872                 let failuremsg = {
 873                         let mut res = Vec::with_capacity(2 + failure_data.len());
 874                         res.push(((failure_type >> 8) & 0xff) as u8);
 875                         res.push(((failure_type >> 0) & 0xff) as u8);
 876                         res.extend_from_slice(&failure_data[..]);
 877                         res
 878                 };
 879                 let pad = {
 880                         let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
 881                         res.resize(256 - 2 - failure_data.len(), 0);
 882                         res
 883                 };
 884                 let mut packet = msgs::DecodedOnionErrorPacket {
 885                         hmac: [0; 32],
 886                         failuremsg: failuremsg,
 887                         pad: pad,
 888                 };
 889
 890                 let mut hmac = Hmac::new(Sha256::new(), &um);
 891                 hmac.input(&packet.encode()[32..]);
 892                 hmac.raw_result(&mut packet.hmac);
 893
 894                 packet
 895         }
 896
 897         #[inline]
 898         fn build_first_hop_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
 899                 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
 900                 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
 901         }
 902
 903         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
 904                 macro_rules! get_onion_hash {
 905                         () => {
 906                                 {
 907                                         let mut sha = Sha256::new();
 908                                         sha.input(&msg.onion_routing_packet.hop_data);
 909                                         let mut onion_hash = [0; 32];
 910                                         sha.result(&mut onion_hash);
 911                                         onion_hash
 912                                 }
 913                         }
 914                 }
 915
 916                 if let Err(_) = msg.onion_routing_packet.public_key {
 917                         log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
 918                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
 919                                 channel_id: msg.channel_id,
 920                                 htlc_id: msg.htlc_id,
 921                                 sha256_of_onion: get_onion_hash!(),
 922                                 failure_code: 0x8000 | 0x4000 | 6,
 923                         })), self.channel_state.lock().unwrap());
 924                 }
 925
 926                 let shared_secret = {
 927                         let mut arr = [0; 32];
 928                         arr.copy_from_slice(&SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
 929                         arr
 930                 };
 931                 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
 932
 933                 let mut channel_state = None;
 934                 macro_rules! return_err {
 935                         ($msg: expr, $err_code: expr, $data: expr) => {
 936                                 {
 937                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
 938                                         if channel_state.is_none() {
 939                                                 channel_state = Some(self.channel_state.lock().unwrap());
 940                                         }
 941                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 942                                                 channel_id: msg.channel_id,
 943                                                 htlc_id: msg.htlc_id,
 944                                                 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
 945                                         })), channel_state.unwrap());
 946                                 }
 947                         }
 948                 }
 949
 950                 if msg.onion_routing_packet.version != 0 {
 951                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
 952                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
 953                         //the hash doesn't really serve any purpuse - in the case of hashing all data, the
 954                         //receiving node would have to brute force to figure out which version was put in the
 955                         //packet by the node that send us the message, in the case of hashing the hop_data, the
 956                         //node knows the HMAC matched, so they already know what is there...
 957                         return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
 958                 }
 959
 960                 let mut hmac = Hmac::new(Sha256::new(), &mu);
 961                 hmac.input(&msg.onion_routing_packet.hop_data);
 962                 hmac.input(&msg.payment_hash);
 963                 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
 964                         return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
 965                 }
 966
 967                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
 968                 let next_hop_data = {
 969                         let mut decoded = [0; 65];
 970                         chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
 971                         match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
 972                                 Err(err) => {
 973                                         let error_code = match err {
 974                                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
 975                                                 _ => 0x2000 | 2, // Should never happen
 976                                         };
 977                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
 978                                 },
 979                                 Ok(msg) => msg
 980                         }
 981                 };
 982
 983                 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
 984                                 // OUR PAYMENT!
 985                                 // final_expiry_too_soon
 986                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS) as u64 {
 987                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
 988                                 }
 989                                 // final_incorrect_htlc_amount
 990                                 if next_hop_data.data.amt_to_forward > msg.amount_msat {
 991                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
 992                                 }
 993                                 // final_incorrect_cltv_expiry
 994                                 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
 995                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
 996                                 }
 997
 998                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
 999                                 // message, however that would leak that we are the recipient of this payment, so
1000                                 // instead we stay symmetric with the forwarding case, only responding (after a
1001                                 // delay) once they've send us a commitment_signed!
1002
1003                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1004                                         onion_packet: None,
1005                                         payment_hash: msg.payment_hash.clone(),
1006                                         short_channel_id: 0,
1007                                         incoming_shared_secret: shared_secret,
1008                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1009                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1010                                 })
1011                         } else {
1012                                 let mut new_packet_data = [0; 20*65];
1013                                 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
1014                                 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
1015
1016                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1017
1018                                 let blinding_factor = {
1019                                         let mut sha = Sha256::new();
1020                                         sha.input(&new_pubkey.serialize()[..]);
1021                                         sha.input(&shared_secret);
1022                                         let mut res = [0u8; 32];
1023                                         sha.result(&mut res);
1024                                         match SecretKey::from_slice(&self.secp_ctx, &res) {
1025                                                 Err(_) => {
1026                                                         return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1027                                                 },
1028                                                 Ok(key) => key
1029                                         }
1030                                 };
1031
1032                                 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
1033                                         return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1034                                 }
1035
1036                                 let outgoing_packet = msgs::OnionPacket {
1037                                         version: 0,
1038                                         public_key: Ok(new_pubkey),
1039                                         hop_data: new_packet_data,
1040                                         hmac: next_hop_data.hmac.clone(),
1041                                 };
1042
1043                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1044                                         onion_packet: Some(outgoing_packet),
1045                                         payment_hash: msg.payment_hash.clone(),
1046                                         short_channel_id: next_hop_data.data.short_channel_id,
1047                                         incoming_shared_secret: shared_secret,
1048                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1049                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1050                                 })
1051                         };
1052
1053                 channel_state = Some(self.channel_state.lock().unwrap());
1054                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1055                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1056                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1057                                 let forwarding_id = match id_option {
1058                                         None => { // unknown_next_peer
1059                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1060                                         },
1061                                         Some(id) => id.clone(),
1062                                 };
1063                                 if let Some((err, code, chan_update)) = loop {
1064                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1065
1066                                         // Note that we could technically not return an error yet here and just hope
1067                                         // that the connection is reestablished or monitor updated by the time we get
1068                                         // around to doing the actual forward, but better to fail early if we can and
1069                                         // hopefully an attacker trying to path-trace payments cannot make this occur
1070                                         // on a small/per-node/per-channel scale.
1071                                         if !chan.is_live() { // channel_disabled
1072                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1073                                         }
1074                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1075                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1076                                         }
1077                                         let fee = amt_to_forward.checked_mul(chan.get_fee_proportional_millionths() as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan.get_our_fee_base_msat(&*self.fee_estimator) as u64) });
1078                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1079                                                 break Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, Some(self.get_channel_update(chan).unwrap())));
1080                                         }
1081                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1082                                                 break Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, Some(self.get_channel_update(chan).unwrap())));
1083                                         }
1084                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1085                                         // We want to have at least HTLC_FAIL_TIMEOUT_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1086                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS as u32 { // expiry_too_soon
1087                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1088                                         }
1089                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1090                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1091                                         }
1092                                         break None;
1093                                 }
1094                                 {
1095                                         let mut res = Vec::with_capacity(8 + 128);
1096                                         if code == 0x1000 | 11 || code == 0x1000 | 12 {
1097                                                 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1098                                         }
1099                                         else if code == 0x1000 | 13 {
1100                                                 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1101                                         }
1102                                         if let Some(chan_update) = chan_update {
1103                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1104                                         }
1105                                         return_err!(err, code, &res[..]);
1106                                 }
1107                         }
1108                 }
1109
1110                 (pending_forward_info, channel_state.unwrap())
1111         }
1112
1113         /// only fails if the channel does not yet have an assigned short_id
1114         /// May be called with channel_state already locked!
1115         fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
1116                 let short_channel_id = match chan.get_short_channel_id() {
1117                         None => return Err(HandleError{err: "Channel not yet established", action: None}),
1118                         Some(id) => id,
1119                 };
1120
1121                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1122
1123                 let unsigned = msgs::UnsignedChannelUpdate {
1124                         chain_hash: self.genesis_hash,
1125                         short_channel_id: short_channel_id,
1126                         timestamp: chan.get_channel_update_count(),
1127                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1128                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1129                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1130                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1131                         fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1132                         excess_data: Vec::new(),
1133                 };
1134
1135                 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
1136                 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key);
1137
1138                 Ok(msgs::ChannelUpdate {
1139                         signature: sig,
1140                         contents: unsigned
1141                 })
1142         }
1143
1144         /// Sends a payment along a given route.
1145         ///
1146         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1147         /// fields for more info.
1148         ///
1149         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1150         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1151         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1152         /// specified in the last hop in the route! Thus, you should probably do your own
1153         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1154         /// payment") and prevent double-sends yourself.
1155         ///
1156         /// May generate a SendHTLCs message event on success, which should be relayed.
1157         ///
1158         /// Raises APIError::RoutError when invalid route or forward parameter
1159         /// (cltv_delta, fee, node public key) is specified
1160         pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), APIError> {
1161                 if route.hops.len() < 1 || route.hops.len() > 20 {
1162                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1163                 }
1164                 let our_node_id = self.get_our_node_id();
1165                 for (idx, hop) in route.hops.iter().enumerate() {
1166                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1167                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1168                         }
1169                 }
1170
1171                 let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
1172                         let mut session_key = [0; 32];
1173                         rng::fill_bytes(&mut session_key);
1174                         session_key
1175                 }).expect("RNG is bad!");
1176
1177                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1178
1179                 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1180                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1181                 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
1182                 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1183
1184                 let _ = self.total_consistency_lock.read().unwrap();
1185                 let mut channel_state = self.channel_state.lock().unwrap();
1186
1187                 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1188                         None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1189                         Some(id) => id.clone(),
1190                 };
1191
1192                 let res = {
1193                         let chan = channel_state.by_id.get_mut(&id).unwrap();
1194                         if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
1195                                 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1196                         }
1197                         if chan.is_awaiting_monitor_update() {
1198                                 return Err(APIError::MonitorUpdateFailed);
1199                         }
1200                         if !chan.is_live() {
1201                                 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected!"});
1202                         }
1203                         chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1204                                 route: route.clone(),
1205                                 session_priv: session_priv.clone(),
1206                                 first_hop_htlc_msat: htlc_msat,
1207                         }, onion_packet).map_err(|he| APIError::ChannelUnavailable{err: he.err})?
1208                 };
1209                 match res {
1210                         Some((update_add, commitment_signed, chan_monitor)) => {
1211                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1212                                         self.handle_monitor_update_fail(channel_state, &id, e, RAACommitmentOrder::CommitmentFirst);
1213                                         return Err(APIError::MonitorUpdateFailed);
1214                                 }
1215
1216                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1217                                         node_id: route.hops.first().unwrap().pubkey,
1218                                         updates: msgs::CommitmentUpdate {
1219                                                 update_add_htlcs: vec![update_add],
1220                                                 update_fulfill_htlcs: Vec::new(),
1221                                                 update_fail_htlcs: Vec::new(),
1222                                                 update_fail_malformed_htlcs: Vec::new(),
1223                                                 update_fee: None,
1224                                                 commitment_signed,
1225                                         },
1226                                 });
1227                         },
1228                         None => {},
1229                 }
1230
1231                 Ok(())
1232         }
1233
1234         /// Call this upon creation of a funding transaction for the given channel.
1235         ///
1236         /// Panics if a funding transaction has already been provided for this channel.
1237         ///
1238         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1239         /// be trivially prevented by using unique funding transaction keys per-channel).
1240         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1241                 let _ = self.total_consistency_lock.read().unwrap();
1242
1243                 let (chan, msg, chan_monitor) = {
1244                         let mut channel_state = self.channel_state.lock().unwrap();
1245                         match channel_state.by_id.remove(temporary_channel_id) {
1246                                 Some(mut chan) => {
1247                                         match chan.get_outbound_funding_created(funding_txo) {
1248                                                 Ok(funding_msg) => {
1249                                                         (chan, funding_msg.0, funding_msg.1)
1250                                                 },
1251                                                 Err(e) => {
1252                                                         log_error!(self, "Got bad signatures: {}!", e.err);
1253                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1254                                                                 node_id: chan.get_their_node_id(),
1255                                                                 action: e.action,
1256                                                         });
1257                                                         return;
1258                                                 },
1259                                         }
1260                                 },
1261                                 None => return
1262                         }
1263                 };
1264                 // Because we have exclusive ownership of the channel here we can release the channel_state
1265                 // lock before add_update_monitor
1266                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1267                         unimplemented!();
1268                 }
1269
1270                 let mut channel_state = self.channel_state.lock().unwrap();
1271                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1272                         node_id: chan.get_their_node_id(),
1273                         msg: msg,
1274                 });
1275                 match channel_state.by_id.entry(chan.channel_id()) {
1276                         hash_map::Entry::Occupied(_) => {
1277                                 panic!("Generated duplicate funding txid?");
1278                         },
1279                         hash_map::Entry::Vacant(e) => {
1280                                 e.insert(chan);
1281                         }
1282                 }
1283         }
1284
1285         fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1286                 if !chan.should_announce() { return None }
1287
1288                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1289                         Ok(res) => res,
1290                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1291                 };
1292                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1293                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1294
1295                 Some(msgs::AnnouncementSignatures {
1296                         channel_id: chan.channel_id(),
1297                         short_channel_id: chan.get_short_channel_id().unwrap(),
1298                         node_signature: our_node_sig,
1299                         bitcoin_signature: our_bitcoin_sig,
1300                 })
1301         }
1302
1303         /// Processes HTLCs which are pending waiting on random forward delay.
1304         ///
1305         /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1306         /// Will likely generate further events.
1307         pub fn process_pending_htlc_forwards(&self) {
1308                 let _ = self.total_consistency_lock.read().unwrap();
1309
1310                 let mut new_events = Vec::new();
1311                 let mut failed_forwards = Vec::new();
1312                 {
1313                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1314                         let channel_state = channel_state_lock.borrow_parts();
1315
1316                         if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1317                                 return;
1318                         }
1319
1320                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1321                                 if short_chan_id != 0 {
1322                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1323                                                 Some(chan_id) => chan_id.clone(),
1324                                                 None => {
1325                                                         failed_forwards.reserve(pending_forwards.len());
1326                                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1327                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1328                                                                         short_channel_id: prev_short_channel_id,
1329                                                                         htlc_id: prev_htlc_id,
1330                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1331                                                                 });
1332                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1333                                                         }
1334                                                         continue;
1335                                                 }
1336                                         };
1337                                         let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1338
1339                                         let mut add_htlc_msgs = Vec::new();
1340                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1341                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1342                                                         short_channel_id: prev_short_channel_id,
1343                                                         htlc_id: prev_htlc_id,
1344                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1345                                                 });
1346                                                 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, htlc_source.clone(), forward_info.onion_packet.unwrap()) {
1347                                                         Err(_e) => {
1348                                                                 let chan_update = self.get_channel_update(forward_chan).unwrap();
1349                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1350                                                                 continue;
1351                                                         },
1352                                                         Ok(update_add) => {
1353                                                                 match update_add {
1354                                                                         Some(msg) => { add_htlc_msgs.push(msg); },
1355                                                                         None => {
1356                                                                                 // Nothing to do here...we're waiting on a remote
1357                                                                                 // revoke_and_ack before we can add anymore HTLCs. The Channel
1358                                                                                 // will automatically handle building the update_add_htlc and
1359                                                                                 // commitment_signed messages when we can.
1360                                                                                 // TODO: Do some kind of timer to set the channel as !is_live()
1361                                                                                 // as we don't really want others relying on us relaying through
1362                                                                                 // this channel currently :/.
1363                                                                         }
1364                                                                 }
1365                                                         }
1366                                                 }
1367                                         }
1368
1369                                         if !add_htlc_msgs.is_empty() {
1370                                                 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1371                                                         Ok(res) => res,
1372                                                         Err(e) => {
1373                                                                 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(ref _err_msg)}) = &e.action {
1374                                                                 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: ref _err_msg}) = &e.action {
1375                                                                 } else {
1376                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1377                                                                 }
1378                                                                 //TODO: Handle...this is bad!
1379                                                                 continue;
1380                                                         },
1381                                                 };
1382                                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1383                                                         unimplemented!();// but def dont push the event...
1384                                                 }
1385                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1386                                                         node_id: forward_chan.get_their_node_id(),
1387                                                         updates: msgs::CommitmentUpdate {
1388                                                                 update_add_htlcs: add_htlc_msgs,
1389                                                                 update_fulfill_htlcs: Vec::new(),
1390                                                                 update_fail_htlcs: Vec::new(),
1391                                                                 update_fail_malformed_htlcs: Vec::new(),
1392                                                                 update_fee: None,
1393                                                                 commitment_signed: commitment_msg,
1394                                                         },
1395                                                 });
1396                                         }
1397                                 } else {
1398                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1399                                                 let prev_hop_data = HTLCPreviousHopData {
1400                                                         short_channel_id: prev_short_channel_id,
1401                                                         htlc_id: prev_htlc_id,
1402                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1403                                                 };
1404                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1405                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(prev_hop_data),
1406                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![prev_hop_data]); },
1407                                                 };
1408                                                 new_events.push(events::Event::PaymentReceived {
1409                                                         payment_hash: forward_info.payment_hash,
1410                                                         amt: forward_info.amt_to_forward,
1411                                                 });
1412                                         }
1413                                 }
1414                         }
1415                 }
1416
1417                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1418                         match update {
1419                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1420                                 Some(chan_update) => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: chan_update.encode_with_len() }),
1421                         };
1422                 }
1423
1424                 if new_events.is_empty() { return }
1425                 let mut events = self.pending_events.lock().unwrap();
1426                 events.append(&mut new_events);
1427         }
1428
1429         /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect after a PaymentReceived event.
1430         pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32], reason: PaymentFailReason) -> bool {
1431                 let _ = self.total_consistency_lock.read().unwrap();
1432
1433                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1434                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1435                 if let Some(mut sources) = removed_source {
1436                         for htlc_with_hash in sources.drain(..) {
1437                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1438                                 self.fail_htlc_backwards_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_hash, HTLCFailReason::Reason { failure_code: if reason == PaymentFailReason::PreimageUnknown {0x4000 | 15} else {0x4000 | 16}, data: Vec::new() });
1439                         }
1440                         true
1441                 } else { false }
1442         }
1443
1444         /// Fails an HTLC backwards to the sender of it to us.
1445         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1446         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1447         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1448         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1449         /// still-available channels.
1450         fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &[u8; 32], onion_error: HTLCFailReason) {
1451                 match source {
1452                         HTLCSource::OutboundRoute { .. } => {
1453                                 mem::drop(channel_state_lock);
1454                                 if let &HTLCFailReason::ErrorPacket { ref err } = &onion_error {
1455                                         let (channel_update, payment_retryable) = self.process_onion_failure(&source, err.data.clone());
1456                                         if let Some(update) = channel_update {
1457                                                 self.channel_state.lock().unwrap().pending_msg_events.push(
1458                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate {
1459                                                                 update,
1460                                                         }
1461                                                 );
1462                                         }
1463                                         self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1464                                                 payment_hash: payment_hash.clone(),
1465                                                 rejected_by_dest: !payment_retryable,
1466                                         });
1467                                 } else {
1468                                         panic!("should have onion error packet here");
1469                                 }
1470                         },
1471                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1472                                 let err_packet = match onion_error {
1473                                         HTLCFailReason::Reason { failure_code, data } => {
1474                                                 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1475                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1476                                         },
1477                                         HTLCFailReason::ErrorPacket { err } => {
1478                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1479                                         }
1480                                 };
1481
1482                                 let channel_state = channel_state_lock.borrow_parts();
1483
1484                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1485                                         Some(chan_id) => chan_id.clone(),
1486                                         None => return
1487                                 };
1488
1489                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1490                                 match chan.get_update_fail_htlc_and_commit(htlc_id, err_packet) {
1491                                         Ok(Some((msg, commitment_msg, chan_monitor))) => {
1492                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1493                                                         unimplemented!();
1494                                                 }
1495                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1496                                                         node_id: chan.get_their_node_id(),
1497                                                         updates: msgs::CommitmentUpdate {
1498                                                                 update_add_htlcs: Vec::new(),
1499                                                                 update_fulfill_htlcs: Vec::new(),
1500                                                                 update_fail_htlcs: vec![msg],
1501                                                                 update_fail_malformed_htlcs: Vec::new(),
1502                                                                 update_fee: None,
1503                                                                 commitment_signed: commitment_msg,
1504                                                         },
1505                                                 });
1506                                         },
1507                                         Ok(None) => {},
1508                                         Err(_e) => {
1509                                                 //TODO: Do something with e?
1510                                                 return;
1511                                         },
1512                                 }
1513                         },
1514                 }
1515         }
1516
1517         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1518         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1519         /// should probably kick the net layer to go send messages if this returns true!
1520         ///
1521         /// May panic if called except in response to a PaymentReceived event.
1522         pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1523                 let mut sha = Sha256::new();
1524                 sha.input(&payment_preimage);
1525                 let mut payment_hash = [0; 32];
1526                 sha.result(&mut payment_hash);
1527
1528                 let _ = self.total_consistency_lock.read().unwrap();
1529
1530                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1531                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1532                 if let Some(mut sources) = removed_source {
1533                         for htlc_with_hash in sources.drain(..) {
1534                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1535                                 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1536                         }
1537                         true
1538                 } else { false }
1539         }
1540         fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: [u8; 32]) {
1541                 match source {
1542                         HTLCSource::OutboundRoute { .. } => {
1543                                 mem::drop(channel_state_lock);
1544                                 let mut pending_events = self.pending_events.lock().unwrap();
1545                                 pending_events.push(events::Event::PaymentSent {
1546                                         payment_preimage
1547                                 });
1548                         },
1549                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1550                                 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1551                                 let channel_state = channel_state_lock.borrow_parts();
1552
1553                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1554                                         Some(chan_id) => chan_id.clone(),
1555                                         None => {
1556                                                 // TODO: There is probably a channel manager somewhere that needs to
1557                                                 // learn the preimage as the channel already hit the chain and that's
1558                                                 // why its missing.
1559                                                 return
1560                                         }
1561                                 };
1562
1563                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1564                                 match chan.get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1565                                         Ok((msgs, monitor_option)) => {
1566                                                 if let Some(chan_monitor) = monitor_option {
1567                                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1568                                                                 unimplemented!();// but def dont push the event...
1569                                                         }
1570                                                 }
1571                                                 if let Some((msg, commitment_signed)) = msgs {
1572                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1573                                                                 node_id: chan.get_their_node_id(),
1574                                                                 updates: msgs::CommitmentUpdate {
1575                                                                         update_add_htlcs: Vec::new(),
1576                                                                         update_fulfill_htlcs: vec![msg],
1577                                                                         update_fail_htlcs: Vec::new(),
1578                                                                         update_fail_malformed_htlcs: Vec::new(),
1579                                                                         update_fee: None,
1580                                                                         commitment_signed,
1581                                                                 }
1582                                                         });
1583                                                 }
1584                                         },
1585                                         Err(_e) => {
1586                                                 // TODO: There is probably a channel manager somewhere that needs to
1587                                                 // learn the preimage as the channel may be about to hit the chain.
1588                                                 //TODO: Do something with e?
1589                                                 return
1590                                         },
1591                                 }
1592                         },
1593                 }
1594         }
1595
1596         /// Gets the node_id held by this ChannelManager
1597         pub fn get_our_node_id(&self) -> PublicKey {
1598                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1599         }
1600
1601         /// Used to restore channels to normal operation after a
1602         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1603         /// operation.
1604         pub fn test_restore_channel_monitor(&self) {
1605                 let mut close_results = Vec::new();
1606                 let mut htlc_forwards = Vec::new();
1607                 let mut htlc_failures = Vec::new();
1608                 let _ = self.total_consistency_lock.read().unwrap();
1609
1610                 {
1611                         let mut channel_lock = self.channel_state.lock().unwrap();
1612                         let channel_state = channel_lock.borrow_parts();
1613                         let short_to_id = channel_state.short_to_id;
1614                         let pending_msg_events = channel_state.pending_msg_events;
1615                         channel_state.by_id.retain(|_, channel| {
1616                                 if channel.is_awaiting_monitor_update() {
1617                                         let chan_monitor = channel.channel_monitor();
1618                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1619                                                 match e {
1620                                                         ChannelMonitorUpdateErr::PermanentFailure => {
1621                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1622                                                                         short_to_id.remove(&short_id);
1623                                                                 }
1624                                                                 close_results.push(channel.force_shutdown());
1625                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1626                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1627                                                                                 msg: update
1628                                                                         });
1629                                                                 }
1630                                                                 false
1631                                                         },
1632                                                         ChannelMonitorUpdateErr::TemporaryFailure => true,
1633                                                 }
1634                                         } else {
1635                                                 let (raa, commitment_update, order, pending_forwards, mut pending_failures) = channel.monitor_updating_restored();
1636                                                 if !pending_forwards.is_empty() {
1637                                                         htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1638                                                 }
1639                                                 htlc_failures.append(&mut pending_failures);
1640
1641                                                 macro_rules! handle_cs { () => {
1642                                                         if let Some(update) = commitment_update {
1643                                                                 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1644                                                                         node_id: channel.get_their_node_id(),
1645                                                                         updates: update,
1646                                                                 });
1647                                                         }
1648                                                 } }
1649                                                 macro_rules! handle_raa { () => {
1650                                                         if let Some(revoke_and_ack) = raa {
1651                                                                 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1652                                                                         node_id: channel.get_their_node_id(),
1653                                                                         msg: revoke_and_ack,
1654                                                                 });
1655                                                         }
1656                                                 } }
1657                                                 match order {
1658                                                         RAACommitmentOrder::CommitmentFirst => {
1659                                                                 handle_cs!();
1660                                                                 handle_raa!();
1661                                                         },
1662                                                         RAACommitmentOrder::RevokeAndACKFirst => {
1663                                                                 handle_raa!();
1664                                                                 handle_cs!();
1665                                                         },
1666                                                 }
1667                                                 true
1668                                         }
1669                                 } else { true }
1670                         });
1671                 }
1672
1673                 for failure in htlc_failures.drain(..) {
1674                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1675                 }
1676                 self.forward_htlcs(&mut htlc_forwards[..]);
1677
1678                 for res in close_results.drain(..) {
1679                         self.finish_force_close_channel(res);
1680                 }
1681         }
1682
1683         fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1684                 if msg.chain_hash != self.genesis_hash {
1685                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1686                 }
1687
1688                 let channel = Channel::new_from_req(&*self.fee_estimator, &self.keys_manager, their_node_id.clone(), msg, 0, Arc::clone(&self.logger), &self.default_configuration)
1689                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1690                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1691                 let channel_state = channel_state_lock.borrow_parts();
1692                 match channel_state.by_id.entry(channel.channel_id()) {
1693                         hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1694                         hash_map::Entry::Vacant(entry) => {
1695                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1696                                         node_id: their_node_id.clone(),
1697                                         msg: channel.get_accept_channel(),
1698                                 });
1699                                 entry.insert(channel);
1700                         }
1701                 }
1702                 Ok(())
1703         }
1704
1705         fn internal_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1706                 let (value, output_script, user_id) = {
1707                         let mut channel_state = self.channel_state.lock().unwrap();
1708                         match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1709                                 Some(chan) => {
1710                                         if chan.get_their_node_id() != *their_node_id {
1711                                                 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1712                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1713                                         }
1714                                         chan.accept_channel(&msg, &self.default_configuration)
1715                                                 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.temporary_channel_id))?;
1716                                         (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1717                                 },
1718                                 //TODO: same as above
1719                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1720                         }
1721                 };
1722                 let mut pending_events = self.pending_events.lock().unwrap();
1723                 pending_events.push(events::Event::FundingGenerationReady {
1724                         temporary_channel_id: msg.temporary_channel_id,
1725                         channel_value_satoshis: value,
1726                         output_script: output_script,
1727                         user_channel_id: user_id,
1728                 });
1729                 Ok(())
1730         }
1731
1732         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1733                 let (chan, funding_msg, monitor_update) = {
1734                         let mut channel_state = self.channel_state.lock().unwrap();
1735                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1736                                 hash_map::Entry::Occupied(mut chan) => {
1737                                         if chan.get().get_their_node_id() != *their_node_id {
1738                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1739                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1740                                         }
1741                                         match chan.get_mut().funding_created(msg) {
1742                                                 Ok((funding_msg, monitor_update)) => {
1743                                                         (chan.remove(), funding_msg, monitor_update)
1744                                                 },
1745                                                 Err(e) => {
1746                                                         return Err(e).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1747                                                 }
1748                                         }
1749                                 },
1750                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1751                         }
1752                 };
1753                 // Because we have exclusive ownership of the channel here we can release the channel_state
1754                 // lock before add_update_monitor
1755                 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1756                         unimplemented!();
1757                 }
1758                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1759                 let channel_state = channel_state_lock.borrow_parts();
1760                 match channel_state.by_id.entry(funding_msg.channel_id) {
1761                         hash_map::Entry::Occupied(_) => {
1762                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1763                         },
1764                         hash_map::Entry::Vacant(e) => {
1765                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1766                                         node_id: their_node_id.clone(),
1767                                         msg: funding_msg,
1768                                 });
1769                                 e.insert(chan);
1770                         }
1771                 }
1772                 Ok(())
1773         }
1774
1775         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1776                 let (funding_txo, user_id) = {
1777                         let mut channel_state = self.channel_state.lock().unwrap();
1778                         match channel_state.by_id.get_mut(&msg.channel_id) {
1779                                 Some(chan) => {
1780                                         if chan.get_their_node_id() != *their_node_id {
1781                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1782                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1783                                         }
1784                                         let chan_monitor = chan.funding_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1785                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1786                                                 unimplemented!();
1787                                         }
1788                                         (chan.get_funding_txo().unwrap(), chan.get_user_id())
1789                                 },
1790                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1791                         }
1792                 };
1793                 let mut pending_events = self.pending_events.lock().unwrap();
1794                 pending_events.push(events::Event::FundingBroadcastSafe {
1795                         funding_txo: funding_txo,
1796                         user_channel_id: user_id,
1797                 });
1798                 Ok(())
1799         }
1800
1801         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
1802                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1803                 let channel_state = channel_state_lock.borrow_parts();
1804                 match channel_state.by_id.get_mut(&msg.channel_id) {
1805                         Some(chan) => {
1806                                 if chan.get_their_node_id() != *their_node_id {
1807                                         //TODO: here and below MsgHandleErrInternal, #153 case
1808                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1809                                 }
1810                                 chan.funding_locked(&msg)
1811                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1812                                 if let Some(announcement_sigs) = self.get_announcement_sigs(chan) {
1813                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1814                                                 node_id: their_node_id.clone(),
1815                                                 msg: announcement_sigs,
1816                                         });
1817                                 }
1818                                 Ok(())
1819                         },
1820                         None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1821                 }
1822         }
1823
1824         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
1825                 let (mut dropped_htlcs, chan_option) = {
1826                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1827                         let channel_state = channel_state_lock.borrow_parts();
1828
1829                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1830                                 hash_map::Entry::Occupied(mut chan_entry) => {
1831                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1832                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1833                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1834                                         }
1835                                         let (shutdown, closing_signed, dropped_htlcs) = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1836                                         if let Some(msg) = shutdown {
1837                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1838                                                         node_id: their_node_id.clone(),
1839                                                         msg,
1840                                                 });
1841                                         }
1842                                         if let Some(msg) = closing_signed {
1843                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1844                                                         node_id: their_node_id.clone(),
1845                                                         msg,
1846                                                 });
1847                                         }
1848                                         if chan_entry.get().is_shutdown() {
1849                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1850                                                         channel_state.short_to_id.remove(&short_id);
1851                                                 }
1852                                                 (dropped_htlcs, Some(chan_entry.remove_entry().1))
1853                                         } else { (dropped_htlcs, None) }
1854                                 },
1855                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1856                         }
1857                 };
1858                 for htlc_source in dropped_htlcs.drain(..) {
1859                         // unknown_next_peer...I dunno who that is anymore....
1860                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1861                 }
1862                 if let Some(chan) = chan_option {
1863                         if let Ok(update) = self.get_channel_update(&chan) {
1864                                 let mut channel_state = self.channel_state.lock().unwrap();
1865                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1866                                         msg: update
1867                                 });
1868                         }
1869                 }
1870                 Ok(())
1871         }
1872
1873         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
1874                 let (tx, chan_option) = {
1875                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1876                         let channel_state = channel_state_lock.borrow_parts();
1877                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1878                                 hash_map::Entry::Occupied(mut chan_entry) => {
1879                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1880                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1881                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1882                                         }
1883                                         let (closing_signed, tx) = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1884                                         if let Some(msg) = closing_signed {
1885                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1886                                                         node_id: their_node_id.clone(),
1887                                                         msg,
1888                                                 });
1889                                         }
1890                                         if tx.is_some() {
1891                                                 // We're done with this channel, we've got a signed closing transaction and
1892                                                 // will send the closing_signed back to the remote peer upon return. This
1893                                                 // also implies there are no pending HTLCs left on the channel, so we can
1894                                                 // fully delete it from tracking (the channel monitor is still around to
1895                                                 // watch for old state broadcasts)!
1896                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1897                                                         channel_state.short_to_id.remove(&short_id);
1898                                                 }
1899                                                 (tx, Some(chan_entry.remove_entry().1))
1900                                         } else { (tx, None) }
1901                                 },
1902                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1903                         }
1904                 };
1905                 if let Some(broadcast_tx) = tx {
1906                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1907                 }
1908                 if let Some(chan) = chan_option {
1909                         if let Ok(update) = self.get_channel_update(&chan) {
1910                                 let mut channel_state = self.channel_state.lock().unwrap();
1911                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1912                                         msg: update
1913                                 });
1914                         }
1915                 }
1916                 Ok(())
1917         }
1918
1919         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
1920                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1921                 //determine the state of the payment based on our response/if we forward anything/the time
1922                 //we take to respond. We should take care to avoid allowing such an attack.
1923                 //
1924                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1925                 //us repeatedly garbled in different ways, and compare our error messages, which are
1926                 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1927                 //but we should prevent it anyway.
1928
1929                 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1930                 let channel_state = channel_state_lock.borrow_parts();
1931
1932                 match channel_state.by_id.get_mut(&msg.channel_id) {
1933                         Some(chan) => {
1934                                 if chan.get_their_node_id() != *their_node_id {
1935                                         //TODO: here MsgHandleErrInternal, #153 case
1936                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1937                                 }
1938                                 if !chan.is_usable() {
1939                                         return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Channel not yet available for receiving HTLCs", action: Some(msgs::ErrorAction::IgnoreError)}));
1940                                 }
1941                                 chan.update_add_htlc(&msg, pending_forward_info).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1942                         },
1943                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1944                 }
1945         }
1946
1947         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
1948                 let mut channel_state = self.channel_state.lock().unwrap();
1949                 let htlc_source = match channel_state.by_id.get_mut(&msg.channel_id) {
1950                         Some(chan) => {
1951                                 if chan.get_their_node_id() != *their_node_id {
1952                                         //TODO: here and below MsgHandleErrInternal, #153 case
1953                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1954                                 }
1955                                 chan.update_fulfill_htlc(&msg)
1956                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?.clone()
1957                         },
1958                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1959                 };
1960                 self.claim_funds_internal(channel_state, htlc_source, msg.payment_preimage.clone());
1961                 Ok(())
1962         }
1963
1964         // Process failure we got back from upstream on a payment we sent. Returns update and a boolean
1965         // indicating that the payment itself failed
1966         fn process_onion_failure(&self, htlc_source: &HTLCSource, mut packet_decrypted: Vec<u8>) -> (Option<msgs::HTLCFailChannelUpdate>, bool) {
1967                 if let &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } = htlc_source {
1968                         macro_rules! onion_failure_log {
1969                                 ( $error_code_textual: expr, $error_code: expr, $reported_name: expr, $reported_value: expr ) => {
1970                                         log_trace!(self, "{}({:#x}) {}({})", $error_code_textual, $error_code, $reported_name, $reported_value);
1971                                 };
1972                                 ( $error_code_textual: expr, $error_code: expr ) => {
1973                                         log_trace!(self, "{}({})", $error_code_textual, $error_code);
1974                                 };
1975                         }
1976
1977                         const BADONION: u16 = 0x8000;
1978                         const PERM: u16 = 0x4000;
1979                         const UPDATE: u16 = 0x1000;
1980
1981                         let mut res = None;
1982                         let mut htlc_msat = *first_hop_htlc_msat;
1983
1984                         // Handle packed channel/node updates for passing back for the route handler
1985                         Self::construct_onion_keys_callback(&self.secp_ctx, route, session_priv, |shared_secret, _, _, route_hop| {
1986                                 if res.is_some() { return; }
1987
1988                                 let incoming_htlc_msat = htlc_msat;
1989                                 let amt_to_forward = htlc_msat - route_hop.fee_msat;
1990                                 htlc_msat = amt_to_forward;
1991
1992                                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret[..]);
1993
1994                                 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1995                                 decryption_tmp.resize(packet_decrypted.len(), 0);
1996                                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1997                                 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1998                                 packet_decrypted = decryption_tmp;
1999
2000                                 let is_from_final_node = route.hops.last().unwrap().pubkey == route_hop.pubkey;
2001
2002                                 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
2003                                         let um = ChannelManager::gen_um_from_shared_secret(&shared_secret[..]);
2004                                         let mut hmac = Hmac::new(Sha256::new(), &um);
2005                                         hmac.input(&err_packet.encode()[32..]);
2006                                         let mut calc_tag = [0u8; 32];
2007                                         hmac.raw_result(&mut calc_tag);
2008
2009                                         if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
2010                                                 if err_packet.failuremsg.len() < 2 {
2011                                                         // Useless packet that we can't use but it passed HMAC, so it
2012                                                         // definitely came from the peer in question
2013                                                         res = Some((None, !is_from_final_node));
2014                                                 } else {
2015                                                         let error_code = byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]);
2016
2017                                                         match error_code & 0xff {
2018                                                                 1|2|3 => {
2019                                                                         // either from an intermediate or final node
2020                                                                         //   invalid_realm(PERM|1),
2021                                                                         //   temporary_node_failure(NODE|2)
2022                                                                         //   permanent_node_failure(PERM|NODE|2)
2023                                                                         //   required_node_feature_mssing(PERM|NODE|3)
2024                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2025                                                                                 node_id: route_hop.pubkey,
2026                                                                                 is_permanent: error_code & PERM == PERM,
2027                                                                         }), !(error_code & PERM == PERM && is_from_final_node)));
2028                                                                         // node returning invalid_realm is removed from network_map,
2029                                                                         // although NODE flag is not set, TODO: or remove channel only?
2030                                                                         // retry payment when removed node is not a final node
2031                                                                         return;
2032                                                                 },
2033                                                                 _ => {}
2034                                                         }
2035
2036                                                         if is_from_final_node {
2037                                                                 let payment_retryable = match error_code {
2038                                                                         c if c == PERM|15 => false, // unknown_payment_hash
2039                                                                         c if c == PERM|16 => false, // incorrect_payment_amount
2040                                                                         17 => true, // final_expiry_too_soon
2041                                                                         18 if err_packet.failuremsg.len() == 6 => { // final_incorrect_cltv_expiry
2042                                                                                 let _reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2043                                                                                 true
2044                                                                         },
2045                                                                         19 if err_packet.failuremsg.len() == 10 => { // final_incorrect_htlc_amount
2046                                                                                 let _reported_incoming_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2047                                                                                 true
2048                                                                         },
2049                                                                         _ => {
2050                                                                                 // A final node has sent us either an invalid code or an error_code that
2051                                                                                 // MUST be sent from the processing node, or the formmat of failuremsg
2052                                                                                 // does not coform to the spec.
2053                                                                                 // Remove it from the network map and don't may retry payment
2054                                                                                 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2055                                                                                         node_id: route_hop.pubkey,
2056                                                                                         is_permanent: true,
2057                                                                                 }), false));
2058                                                                                 return;
2059                                                                         }
2060                                                                 };
2061                                                                 res = Some((None, payment_retryable));
2062                                                                 return;
2063                                                         }
2064
2065                                                         // now, error_code should be only from the intermediate nodes
2066                                                         match error_code {
2067                                                                 _c if error_code & PERM == PERM => {
2068                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
2069                                                                                 short_channel_id: route_hop.short_channel_id,
2070                                                                                 is_permanent: true,
2071                                                                         }), false));
2072                                                                 },
2073                                                                 _c if error_code & UPDATE == UPDATE => {
2074                                                                         let offset = match error_code {
2075                                                                                 c if c == UPDATE|7  => 0, // temporary_channel_failure
2076                                                                                 c if c == UPDATE|11 => 8, // amount_below_minimum
2077                                                                                 c if c == UPDATE|12 => 8, // fee_insufficient
2078                                                                                 c if c == UPDATE|13 => 4, // incorrect_cltv_expiry
2079                                                                                 c if c == UPDATE|14 => 0, // expiry_too_soon
2080                                                                                 c if c == UPDATE|20 => 2, // channel_disabled
2081                                                                                 _ =>  {
2082                                                                                         // node sending unknown code
2083                                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2084                                                                                                 node_id: route_hop.pubkey,
2085                                                                                                 is_permanent: true,
2086                                                                                         }), false));
2087                                                                                         return;
2088                                                                                 }
2089                                                                         };
2090
2091                                                                         if err_packet.failuremsg.len() >= offset + 2 {
2092                                                                                 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[offset+2..offset+4]) as usize;
2093                                                                                 if err_packet.failuremsg.len() >= offset + 4 + update_len {
2094                                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&err_packet.failuremsg[offset + 4..offset + 4 + update_len])) {
2095                                                                                                 // if channel_update should NOT have caused the failure:
2096                                                                                                 // MAY treat the channel_update as invalid.
2097                                                                                                 let is_chan_update_invalid = match error_code {
2098                                                                                                         c if c == UPDATE|7 => { // temporary_channel_failure
2099                                                                                                                 false
2100                                                                                                         },
2101                                                                                                         c if c == UPDATE|11 => { // amount_below_minimum
2102                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2103                                                                                                                 onion_failure_log!("amount_below_minimum", UPDATE|11, "htlc_msat", reported_htlc_msat);
2104                                                                                                                 incoming_htlc_msat > chan_update.contents.htlc_minimum_msat
2105                                                                                                         },
2106                                                                                                         c if c == UPDATE|12 => { // fee_insufficient
2107                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2108                                                                                                                 let new_fee =  amt_to_forward.checked_mul(chan_update.contents.fee_proportional_millionths as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan_update.contents.fee_base_msat as u64) });
2109                                                                                                                 onion_failure_log!("fee_insufficient", UPDATE|12, "htlc_msat", reported_htlc_msat);
2110                                                                                                                 new_fee.is_none() || incoming_htlc_msat >= new_fee.unwrap() && incoming_htlc_msat >= amt_to_forward + new_fee.unwrap()
2111                                                                                                         }
2112                                                                                                         c if c == UPDATE|13 => { // incorrect_cltv_expiry
2113                                                                                                                 let reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2114                                                                                                                 onion_failure_log!("incorrect_cltv_expiry", UPDATE|13, "cltv_expiry", reported_cltv_expiry);
2115                                                                                                                 route_hop.cltv_expiry_delta as u16 >= chan_update.contents.cltv_expiry_delta
2116                                                                                                         },
2117                                                                                                         c if c == UPDATE|20 => { // channel_disabled
2118                                                                                                                 let reported_flags = byte_utils::slice_to_be16(&err_packet.failuremsg[2..2+2]);
2119                                                                                                                 onion_failure_log!("channel_disabled", UPDATE|20, "flags", reported_flags);
2120                                                                                                                 chan_update.contents.flags & 0x01 == 0x01
2121                                                                                                         },
2122                                                                                                         c if c == UPDATE|21 => true, // expiry_too_far
2123                                                                                                         _ => { unreachable!(); },
2124                                                                                                 };
2125
2126                                                                                                 let msg = if is_chan_update_invalid { None } else {
2127                                                                                                         Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
2128                                                                                                                 msg: chan_update,
2129                                                                                                         })
2130                                                                                                 };
2131                                                                                                 res = Some((msg, true));
2132                                                                                                 return;
2133                                                                                         }
2134                                                                                 }
2135                                                                         }
2136                                                                 },
2137                                                                 _c if error_code & BADONION == BADONION => {
2138                                                                         //TODO
2139                                                                 },
2140                                                                 14 => { // expiry_too_soon
2141                                                                         res = Some((None, true));
2142                                                                         return;
2143                                                                 }
2144                                                                 _ => {
2145                                                                         // node sending unknown code
2146                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2147                                                                                 node_id: route_hop.pubkey,
2148                                                                                 is_permanent: true,
2149                                                                         }), false));
2150                                                                         return;
2151                                                                 }
2152                                                         }
2153                                                 }
2154                                         }
2155                                 }
2156                         }).expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
2157                         res.unwrap_or((None, true))
2158                 } else { ((None, true)) }
2159         }
2160
2161         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2162                 let mut channel_state = self.channel_state.lock().unwrap();
2163                 match channel_state.by_id.get_mut(&msg.channel_id) {
2164                         Some(chan) => {
2165                                 if chan.get_their_node_id() != *their_node_id {
2166                                         //TODO: here and below MsgHandleErrInternal, #153 case
2167                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2168                                 }
2169                                 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
2170                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2171                         },
2172                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2173                 }?;
2174                 Ok(())
2175         }
2176
2177         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2178                 let mut channel_state = self.channel_state.lock().unwrap();
2179                 match channel_state.by_id.get_mut(&msg.channel_id) {
2180                         Some(chan) => {
2181                                 if chan.get_their_node_id() != *their_node_id {
2182                                         //TODO: here and below MsgHandleErrInternal, #153 case
2183                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2184                                 }
2185                                 if (msg.failure_code & 0x8000) != 0 {
2186                                         return Err(MsgHandleErrInternal::send_err_msg_close_chan("Got update_fail_malformed_htlc with BADONION set", msg.channel_id));
2187                                 }
2188                                 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
2189                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2190                                 Ok(())
2191                         },
2192                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2193                 }
2194         }
2195
2196         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2197                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2198                 let channel_state = channel_state_lock.borrow_parts();
2199                 match channel_state.by_id.get_mut(&msg.channel_id) {
2200                         Some(chan) => {
2201                                 if chan.get_their_node_id() != *their_node_id {
2202                                         //TODO: here and below MsgHandleErrInternal, #153 case
2203                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2204                                 }
2205                                 let (revoke_and_ack, commitment_signed, chan_monitor) = chan.commitment_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
2206                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2207                                         unimplemented!();
2208                                 }
2209                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2210                                         node_id: their_node_id.clone(),
2211                                         msg: revoke_and_ack,
2212                                 });
2213                                 if let Some(msg) = commitment_signed {
2214                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2215                                                 node_id: their_node_id.clone(),
2216                                                 updates: msgs::CommitmentUpdate {
2217                                                         update_add_htlcs: Vec::new(),
2218                                                         update_fulfill_htlcs: Vec::new(),
2219                                                         update_fail_htlcs: Vec::new(),
2220                                                         update_fail_malformed_htlcs: Vec::new(),
2221                                                         update_fee: None,
2222                                                         commitment_signed: msg,
2223                                                 },
2224                                         });
2225                                 }
2226                                 Ok(())
2227                         },
2228                         None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2229                 }
2230         }
2231
2232         #[inline]
2233         fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2234                 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2235                         let mut forward_event = None;
2236                         if !pending_forwards.is_empty() {
2237                                 let mut channel_state = self.channel_state.lock().unwrap();
2238                                 if channel_state.forward_htlcs.is_empty() {
2239                                         forward_event = Some(Instant::now() + Duration::from_millis(((rng::rand_f32() * 4.0 + 1.0) * MIN_HTLC_RELAY_HOLDING_CELL_MILLIS as f32) as u64));
2240                                         channel_state.next_forward = forward_event.unwrap();
2241                                 }
2242                                 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2243                                         match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2244                                                 hash_map::Entry::Occupied(mut entry) => {
2245                                                         entry.get_mut().push(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info });
2246                                                 },
2247                                                 hash_map::Entry::Vacant(entry) => {
2248                                                         entry.insert(vec!(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info }));
2249                                                 }
2250                                         }
2251                                 }
2252                         }
2253                         match forward_event {
2254                                 Some(time) => {
2255                                         let mut pending_events = self.pending_events.lock().unwrap();
2256                                         pending_events.push(events::Event::PendingHTLCsForwardable {
2257                                                 time_forwardable: time
2258                                         });
2259                                 }
2260                                 None => {},
2261                         }
2262                 }
2263         }
2264
2265         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2266                 let (pending_forwards, mut pending_failures, short_channel_id) = {
2267                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2268                         let channel_state = channel_state_lock.borrow_parts();
2269                         match channel_state.by_id.get_mut(&msg.channel_id) {
2270                                 Some(chan) => {
2271                                         if chan.get_their_node_id() != *their_node_id {
2272                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2273                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2274                                         }
2275                                         let (commitment_update, pending_forwards, pending_failures, chan_monitor) = chan.revoke_and_ack(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
2276                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2277                                                 unimplemented!();
2278                                         }
2279                                         if let Some(updates) = commitment_update {
2280                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2281                                                         node_id: their_node_id.clone(),
2282                                                         updates,
2283                                                 });
2284                                         }
2285                                         (pending_forwards, pending_failures, chan.get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2286                                 },
2287                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2288                         }
2289                 };
2290                 for failure in pending_failures.drain(..) {
2291                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2292                 }
2293                 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2294
2295                 Ok(())
2296         }
2297
2298         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2299                 let mut channel_state = self.channel_state.lock().unwrap();
2300                 match channel_state.by_id.get_mut(&msg.channel_id) {
2301                         Some(chan) => {
2302                                 if chan.get_their_node_id() != *their_node_id {
2303                                         //TODO: here and below MsgHandleErrInternal, #153 case
2304                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2305                                 }
2306                                 chan.update_fee(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2307                         },
2308                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2309                 }
2310         }
2311
2312         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2313                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2314                 let channel_state = channel_state_lock.borrow_parts();
2315
2316                 match channel_state.by_id.get_mut(&msg.channel_id) {
2317                         Some(chan) => {
2318                                 if chan.get_their_node_id() != *their_node_id {
2319                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2320                                 }
2321                                 if !chan.is_usable() {
2322                                         return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
2323                                 }
2324
2325                                 let our_node_id = self.get_our_node_id();
2326                                 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())
2327                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2328
2329                                 let were_node_one = announcement.node_id_1 == our_node_id;
2330                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2331                                 let bad_sig_action = MsgHandleErrInternal::send_err_msg_close_chan("Bad announcement_signatures node_signature", msg.channel_id);
2332                                 secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }), bad_sig_action);
2333                                 secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }), bad_sig_action);
2334
2335                                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2336
2337                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2338                                         msg: msgs::ChannelAnnouncement {
2339                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2340                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2341                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2342                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2343                                                 contents: announcement,
2344                                         },
2345                                         update_msg: self.get_channel_update(chan).unwrap(), // can only fail if we're not in a ready state
2346                                 });
2347                         },
2348                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2349                 }
2350                 Ok(())
2351         }
2352
2353         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2354                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2355                 let channel_state = channel_state_lock.borrow_parts();
2356
2357                 match channel_state.by_id.get_mut(&msg.channel_id) {
2358                         Some(chan) => {
2359                                 if chan.get_their_node_id() != *their_node_id {
2360                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2361                                 }
2362                                 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, order) = chan.channel_reestablish(msg)
2363                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2364                                 if let Some(monitor) = channel_monitor {
2365                                         if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2366                                                 unimplemented!();
2367                                         }
2368                                 }
2369                                 if let Some(msg) = funding_locked {
2370                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2371                                                 node_id: their_node_id.clone(),
2372                                                 msg
2373                                         });
2374                                 }
2375                                 macro_rules! send_raa { () => {
2376                                         if let Some(msg) = revoke_and_ack {
2377                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2378                                                         node_id: their_node_id.clone(),
2379                                                         msg
2380                                                 });
2381                                         }
2382                                 } }
2383                                 macro_rules! send_cu { () => {
2384                                         if let Some(updates) = commitment_update {
2385                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2386                                                         node_id: their_node_id.clone(),
2387                                                         updates
2388                                                 });
2389                                         }
2390                                 } }
2391                                 match order {
2392                                         RAACommitmentOrder::RevokeAndACKFirst => {
2393                                                 send_raa!();
2394                                                 send_cu!();
2395                                         },
2396                                         RAACommitmentOrder::CommitmentFirst => {
2397                                                 send_cu!();
2398                                                 send_raa!();
2399                                         },
2400                                 }
2401                                 Ok(())
2402                         },
2403                         None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2404                 }
2405         }
2406
2407         /// Begin Update fee process. Allowed only on an outbound channel.
2408         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2409         /// PeerManager::process_events afterwards.
2410         /// Note: This API is likely to change!
2411         #[doc(hidden)]
2412         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2413                 let _ = self.total_consistency_lock.read().unwrap();
2414                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2415                 let channel_state = channel_state_lock.borrow_parts();
2416
2417                 match channel_state.by_id.get_mut(&channel_id) {
2418                         None => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2419                         Some(chan) => {
2420                                 if !chan.is_outbound() {
2421                                         return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2422                                 }
2423                                 if chan.is_awaiting_monitor_update() {
2424                                         return Err(APIError::MonitorUpdateFailed);
2425                                 }
2426                                 if !chan.is_live() {
2427                                         return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2428                                 }
2429                                 if let Some((update_fee, commitment_signed, chan_monitor)) = chan.send_update_fee_and_commit(feerate_per_kw).map_err(|e| APIError::APIMisuseError{err: e.err})? {
2430                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2431                                                 unimplemented!();
2432                                         }
2433                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2434                                                 node_id: chan.get_their_node_id(),
2435                                                 updates: msgs::CommitmentUpdate {
2436                                                         update_add_htlcs: Vec::new(),
2437                                                         update_fulfill_htlcs: Vec::new(),
2438                                                         update_fail_htlcs: Vec::new(),
2439                                                         update_fail_malformed_htlcs: Vec::new(),
2440                                                         update_fee: Some(update_fee),
2441                                                         commitment_signed,
2442                                                 },
2443                                         });
2444                                 }
2445                         },
2446                 }
2447                 Ok(())
2448         }
2449 }
2450
2451 impl events::MessageSendEventsProvider for ChannelManager {
2452         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2453                 let mut ret = Vec::new();
2454                 let mut channel_state = self.channel_state.lock().unwrap();
2455                 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2456                 ret
2457         }
2458 }
2459
2460 impl events::EventsProvider for ChannelManager {
2461         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2462                 let mut ret = Vec::new();
2463                 let mut pending_events = self.pending_events.lock().unwrap();
2464                 mem::swap(&mut ret, &mut *pending_events);
2465                 ret
2466         }
2467 }
2468
2469 impl ChainListener for ChannelManager {
2470         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2471                 let _ = self.total_consistency_lock.read().unwrap();
2472                 let mut failed_channels = Vec::new();
2473                 {
2474                         let mut channel_lock = self.channel_state.lock().unwrap();
2475                         let channel_state = channel_lock.borrow_parts();
2476                         let short_to_id = channel_state.short_to_id;
2477                         let pending_msg_events = channel_state.pending_msg_events;
2478                         channel_state.by_id.retain(|_, channel| {
2479                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2480                                 if let Ok(Some(funding_locked)) = chan_res {
2481                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2482                                                 node_id: channel.get_their_node_id(),
2483                                                 msg: funding_locked,
2484                                         });
2485                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2486                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2487                                                         node_id: channel.get_their_node_id(),
2488                                                         msg: announcement_sigs,
2489                                                 });
2490                                         }
2491                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2492                                 } else if let Err(e) = chan_res {
2493                                         pending_msg_events.push(events::MessageSendEvent::HandleError {
2494                                                 node_id: channel.get_their_node_id(),
2495                                                 action: e.action,
2496                                         });
2497                                         if channel.is_shutdown() {
2498                                                 return false;
2499                                         }
2500                                 }
2501                                 if let Some(funding_txo) = channel.get_funding_txo() {
2502                                         for tx in txn_matched {
2503                                                 for inp in tx.input.iter() {
2504                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2505                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2506                                                                         short_to_id.remove(&short_id);
2507                                                                 }
2508                                                                 // It looks like our counterparty went on-chain. We go ahead and
2509                                                                 // broadcast our latest local state as well here, just in case its
2510                                                                 // some kind of SPV attack, though we expect these to be dropped.
2511                                                                 failed_channels.push(channel.force_shutdown());
2512                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2513                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2514                                                                                 msg: update
2515                                                                         });
2516                                                                 }
2517                                                                 return false;
2518                                                         }
2519                                                 }
2520                                         }
2521                                 }
2522                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2523                                         if let Some(short_id) = channel.get_short_channel_id() {
2524                                                 short_to_id.remove(&short_id);
2525                                         }
2526                                         failed_channels.push(channel.force_shutdown());
2527                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2528                                         // the latest local tx for us, so we should skip that here (it doesn't really
2529                                         // hurt anything, but does make tests a bit simpler).
2530                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2531                                         if let Ok(update) = self.get_channel_update(&channel) {
2532                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2533                                                         msg: update
2534                                                 });
2535                                         }
2536                                         return false;
2537                                 }
2538                                 true
2539                         });
2540                 }
2541                 for failure in failed_channels.drain(..) {
2542                         self.finish_force_close_channel(failure);
2543                 }
2544                 self.latest_block_height.store(height as usize, Ordering::Release);
2545                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2546         }
2547
2548         /// We force-close the channel without letting our counterparty participate in the shutdown
2549         fn block_disconnected(&self, header: &BlockHeader) {
2550                 let _ = self.total_consistency_lock.read().unwrap();
2551                 let mut failed_channels = Vec::new();
2552                 {
2553                         let mut channel_lock = self.channel_state.lock().unwrap();
2554                         let channel_state = channel_lock.borrow_parts();
2555                         let short_to_id = channel_state.short_to_id;
2556                         let pending_msg_events = channel_state.pending_msg_events;
2557                         channel_state.by_id.retain(|_,  v| {
2558                                 if v.block_disconnected(header) {
2559                                         if let Some(short_id) = v.get_short_channel_id() {
2560                                                 short_to_id.remove(&short_id);
2561                                         }
2562                                         failed_channels.push(v.force_shutdown());
2563                                         if let Ok(update) = self.get_channel_update(&v) {
2564                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2565                                                         msg: update
2566                                                 });
2567                                         }
2568                                         false
2569                                 } else {
2570                                         true
2571                                 }
2572                         });
2573                 }
2574                 for failure in failed_channels.drain(..) {
2575                         self.finish_force_close_channel(failure);
2576                 }
2577                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2578                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2579         }
2580 }
2581
2582 macro_rules! handle_error {
2583         ($self: ident, $internal: expr, $their_node_id: expr) => {
2584                 match $internal {
2585                         Ok(msg) => Ok(msg),
2586                         Err(MsgHandleErrInternal { err, needs_channel_force_close }) => {
2587                                 if needs_channel_force_close {
2588                                         match &err.action {
2589                                                 &Some(msgs::ErrorAction::DisconnectPeer { msg: Some(ref msg) }) => {
2590                                                         if msg.channel_id == [0; 32] {
2591                                                                 $self.peer_disconnected(&$their_node_id, true);
2592                                                         } else {
2593                                                                 $self.force_close_channel(&msg.channel_id);
2594                                                         }
2595                                                 },
2596                                                 &Some(msgs::ErrorAction::DisconnectPeer { msg: None }) => {},
2597                                                 &Some(msgs::ErrorAction::IgnoreError) => {},
2598                                                 &Some(msgs::ErrorAction::SendErrorMessage { ref msg }) => {
2599                                                         if msg.channel_id == [0; 32] {
2600                                                                 $self.peer_disconnected(&$their_node_id, true);
2601                                                         } else {
2602                                                                 $self.force_close_channel(&msg.channel_id);
2603                                                         }
2604                                                 },
2605                                                 &None => {},
2606                                         }
2607                                 }
2608                                 Err(err)
2609                         },
2610                 }
2611         }
2612 }
2613
2614 impl ChannelMessageHandler for ChannelManager {
2615         //TODO: Handle errors and close channel (or so)
2616         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), HandleError> {
2617                 let _ = self.total_consistency_lock.read().unwrap();
2618                 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
2619         }
2620
2621         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2622                 let _ = self.total_consistency_lock.read().unwrap();
2623                 handle_error!(self, self.internal_accept_channel(their_node_id, msg), their_node_id)
2624         }
2625
2626         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), HandleError> {
2627                 let _ = self.total_consistency_lock.read().unwrap();
2628                 handle_error!(self, self.internal_funding_created(their_node_id, msg), their_node_id)
2629         }
2630
2631         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2632                 let _ = self.total_consistency_lock.read().unwrap();
2633                 handle_error!(self, self.internal_funding_signed(their_node_id, msg), their_node_id)
2634         }
2635
2636         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
2637                 let _ = self.total_consistency_lock.read().unwrap();
2638                 handle_error!(self, self.internal_funding_locked(their_node_id, msg), their_node_id)
2639         }
2640
2641         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), HandleError> {
2642                 let _ = self.total_consistency_lock.read().unwrap();
2643                 handle_error!(self, self.internal_shutdown(their_node_id, msg), their_node_id)
2644         }
2645
2646         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), HandleError> {
2647                 let _ = self.total_consistency_lock.read().unwrap();
2648                 handle_error!(self, self.internal_closing_signed(their_node_id, msg), their_node_id)
2649         }
2650
2651         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2652                 let _ = self.total_consistency_lock.read().unwrap();
2653                 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), their_node_id)
2654         }
2655
2656         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2657                 let _ = self.total_consistency_lock.read().unwrap();
2658                 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), their_node_id)
2659         }
2660
2661         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
2662                 let _ = self.total_consistency_lock.read().unwrap();
2663                 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), their_node_id)
2664         }
2665
2666         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2667                 let _ = self.total_consistency_lock.read().unwrap();
2668                 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), their_node_id)
2669         }
2670
2671         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), HandleError> {
2672                 let _ = self.total_consistency_lock.read().unwrap();
2673                 handle_error!(self, self.internal_commitment_signed(their_node_id, msg), their_node_id)
2674         }
2675
2676         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), HandleError> {
2677                 let _ = self.total_consistency_lock.read().unwrap();
2678                 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), their_node_id)
2679         }
2680
2681         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2682                 let _ = self.total_consistency_lock.read().unwrap();
2683                 handle_error!(self, self.internal_update_fee(their_node_id, msg), their_node_id)
2684         }
2685
2686         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2687                 let _ = self.total_consistency_lock.read().unwrap();
2688                 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2689         }
2690
2691         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), HandleError> {
2692                 let _ = self.total_consistency_lock.read().unwrap();
2693                 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), their_node_id)
2694         }
2695
2696         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2697                 let _ = self.total_consistency_lock.read().unwrap();
2698                 let mut failed_channels = Vec::new();
2699                 let mut failed_payments = Vec::new();
2700                 {
2701                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2702                         let channel_state = channel_state_lock.borrow_parts();
2703                         let short_to_id = channel_state.short_to_id;
2704                         let pending_msg_events = channel_state.pending_msg_events;
2705                         if no_connection_possible {
2706                                 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2707                                 channel_state.by_id.retain(|_, chan| {
2708                                         if chan.get_their_node_id() == *their_node_id {
2709                                                 if let Some(short_id) = chan.get_short_channel_id() {
2710                                                         short_to_id.remove(&short_id);
2711                                                 }
2712                                                 failed_channels.push(chan.force_shutdown());
2713                                                 if let Ok(update) = self.get_channel_update(&chan) {
2714                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2715                                                                 msg: update
2716                                                         });
2717                                                 }
2718                                                 false
2719                                         } else {
2720                                                 true
2721                                         }
2722                                 });
2723                         } else {
2724                                 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2725                                 channel_state.by_id.retain(|_, chan| {
2726                                         if chan.get_their_node_id() == *their_node_id {
2727                                                 //TODO: mark channel disabled (and maybe announce such after a timeout).
2728                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2729                                                 if !failed_adds.is_empty() {
2730                                                         let chan_update = self.get_channel_update(&chan).map(|u| u.encode_with_len()).unwrap(); // Cannot add/recv HTLCs before we have a short_id so unwrap is safe
2731                                                         failed_payments.push((chan_update, failed_adds));
2732                                                 }
2733                                                 if chan.is_shutdown() {
2734                                                         if let Some(short_id) = chan.get_short_channel_id() {
2735                                                                 short_to_id.remove(&short_id);
2736                                                         }
2737                                                         return false;
2738                                                 }
2739                                         }
2740                                         true
2741                                 })
2742                         }
2743                 }
2744                 for failure in failed_channels.drain(..) {
2745                         self.finish_force_close_channel(failure);
2746                 }
2747                 for (chan_update, mut htlc_sources) in failed_payments {
2748                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2749                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2750                         }
2751                 }
2752         }
2753
2754         fn peer_connected(&self, their_node_id: &PublicKey) {
2755                 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2756
2757                 let _ = self.total_consistency_lock.read().unwrap();
2758                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2759                 let channel_state = channel_state_lock.borrow_parts();
2760                 let pending_msg_events = channel_state.pending_msg_events;
2761                 channel_state.by_id.retain(|_, chan| {
2762                         if chan.get_their_node_id() == *their_node_id {
2763                                 if !chan.have_received_message() {
2764                                         // If we created this (outbound) channel while we were disconnected from the
2765                                         // peer we probably failed to send the open_channel message, which is now
2766                                         // lost. We can't have had anything pending related to this channel, so we just
2767                                         // drop it.
2768                                         false
2769                                 } else {
2770                                         pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2771                                                 node_id: chan.get_their_node_id(),
2772                                                 msg: chan.get_channel_reestablish(),
2773                                         });
2774                                         true
2775                                 }
2776                         } else { true }
2777                 });
2778                 //TODO: Also re-broadcast announcement_signatures
2779         }
2780
2781         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2782                 let _ = self.total_consistency_lock.read().unwrap();
2783
2784                 if msg.channel_id == [0; 32] {
2785                         for chan in self.list_channels() {
2786                                 if chan.remote_network_id == *their_node_id {
2787                                         self.force_close_channel(&chan.channel_id);
2788                                 }
2789                         }
2790                 } else {
2791                         self.force_close_channel(&msg.channel_id);
2792                 }
2793         }
2794 }
2795
2796 const SERIALIZATION_VERSION: u8 = 1;
2797 const MIN_SERIALIZATION_VERSION: u8 = 1;
2798
2799 impl Writeable for PendingForwardHTLCInfo {
2800         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2801                 if let &Some(ref onion) = &self.onion_packet {
2802                         1u8.write(writer)?;
2803                         onion.write(writer)?;
2804                 } else {
2805                         0u8.write(writer)?;
2806                 }
2807                 self.incoming_shared_secret.write(writer)?;
2808                 self.payment_hash.write(writer)?;
2809                 self.short_channel_id.write(writer)?;
2810                 self.amt_to_forward.write(writer)?;
2811                 self.outgoing_cltv_value.write(writer)?;
2812                 Ok(())
2813         }
2814 }
2815
2816 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
2817         fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
2818                 let onion_packet = match <u8 as Readable<R>>::read(reader)? {
2819                         0 => None,
2820                         1 => Some(msgs::OnionPacket::read(reader)?),
2821                         _ => return Err(DecodeError::InvalidValue),
2822                 };
2823                 Ok(PendingForwardHTLCInfo {
2824                         onion_packet,
2825                         incoming_shared_secret: Readable::read(reader)?,
2826                         payment_hash: Readable::read(reader)?,
2827                         short_channel_id: Readable::read(reader)?,
2828                         amt_to_forward: Readable::read(reader)?,
2829                         outgoing_cltv_value: Readable::read(reader)?,
2830                 })
2831         }
2832 }
2833
2834 impl Writeable for HTLCFailureMsg {
2835         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2836                 match self {
2837                         &HTLCFailureMsg::Relay(ref fail_msg) => {
2838                                 0u8.write(writer)?;
2839                                 fail_msg.write(writer)?;
2840                         },
2841                         &HTLCFailureMsg::Malformed(ref fail_msg) => {
2842                                 1u8.write(writer)?;
2843                                 fail_msg.write(writer)?;
2844                         }
2845                 }
2846                 Ok(())
2847         }
2848 }
2849
2850 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
2851         fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
2852                 match <u8 as Readable<R>>::read(reader)? {
2853                         0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
2854                         1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
2855                         _ => Err(DecodeError::InvalidValue),
2856                 }
2857         }
2858 }
2859
2860 impl Writeable for PendingHTLCStatus {
2861         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2862                 match self {
2863                         &PendingHTLCStatus::Forward(ref forward_info) => {
2864                                 0u8.write(writer)?;
2865                                 forward_info.write(writer)?;
2866                         },
2867                         &PendingHTLCStatus::Fail(ref fail_msg) => {
2868                                 1u8.write(writer)?;
2869                                 fail_msg.write(writer)?;
2870                         }
2871                 }
2872                 Ok(())
2873         }
2874 }
2875
2876 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
2877         fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
2878                 match <u8 as Readable<R>>::read(reader)? {
2879                         0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
2880                         1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
2881                         _ => Err(DecodeError::InvalidValue),
2882                 }
2883         }
2884 }
2885
2886 impl_writeable!(HTLCPreviousHopData, 0, {
2887         short_channel_id,
2888         htlc_id,
2889         incoming_packet_shared_secret
2890 });
2891
2892 impl Writeable for HTLCSource {
2893         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2894                 match self {
2895                         &HTLCSource::PreviousHopData(ref hop_data) => {
2896                                 0u8.write(writer)?;
2897                                 hop_data.write(writer)?;
2898                         },
2899                         &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
2900                                 1u8.write(writer)?;
2901                                 route.write(writer)?;
2902                                 session_priv.write(writer)?;
2903                                 first_hop_htlc_msat.write(writer)?;
2904                         }
2905                 }
2906                 Ok(())
2907         }
2908 }
2909
2910 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
2911         fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
2912                 match <u8 as Readable<R>>::read(reader)? {
2913                         0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
2914                         1 => Ok(HTLCSource::OutboundRoute {
2915                                 route: Readable::read(reader)?,
2916                                 session_priv: Readable::read(reader)?,
2917                                 first_hop_htlc_msat: Readable::read(reader)?,
2918                         }),
2919                         _ => Err(DecodeError::InvalidValue),
2920                 }
2921         }
2922 }
2923
2924 impl Writeable for HTLCFailReason {
2925         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2926                 match self {
2927                         &HTLCFailReason::ErrorPacket { ref err } => {
2928                                 0u8.write(writer)?;
2929                                 err.write(writer)?;
2930                         },
2931                         &HTLCFailReason::Reason { ref failure_code, ref data } => {
2932                                 1u8.write(writer)?;
2933                                 failure_code.write(writer)?;
2934                                 data.write(writer)?;
2935                         }
2936                 }
2937                 Ok(())
2938         }
2939 }
2940
2941 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
2942         fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
2943                 match <u8 as Readable<R>>::read(reader)? {
2944                         0 => Ok(HTLCFailReason::ErrorPacket { err: Readable::read(reader)? }),
2945                         1 => Ok(HTLCFailReason::Reason {
2946                                 failure_code: Readable::read(reader)?,
2947                                 data: Readable::read(reader)?,
2948                         }),
2949                         _ => Err(DecodeError::InvalidValue),
2950                 }
2951         }
2952 }
2953
2954 impl_writeable!(HTLCForwardInfo, 0, {
2955         prev_short_channel_id,
2956         prev_htlc_id,
2957         forward_info
2958 });
2959
2960 impl Writeable for ChannelManager {
2961         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2962                 let _ = self.total_consistency_lock.write().unwrap();
2963
2964                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
2965                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
2966
2967                 self.genesis_hash.write(writer)?;
2968                 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
2969                 self.last_block_hash.lock().unwrap().write(writer)?;
2970
2971                 let channel_state = self.channel_state.lock().unwrap();
2972                 let mut unfunded_channels = 0;
2973                 for (_, channel) in channel_state.by_id.iter() {
2974                         if !channel.is_funding_initiated() {
2975                                 unfunded_channels += 1;
2976                         }
2977                 }
2978                 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
2979                 for (_, channel) in channel_state.by_id.iter() {
2980                         if channel.is_funding_initiated() {
2981                                 channel.write(writer)?;
2982                         }
2983                 }
2984
2985                 (channel_state.forward_htlcs.len() as u64).write(writer)?;
2986                 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
2987                         short_channel_id.write(writer)?;
2988                         (pending_forwards.len() as u64).write(writer)?;
2989                         for forward in pending_forwards {
2990                                 forward.write(writer)?;
2991                         }
2992                 }
2993
2994                 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
2995                 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
2996                         payment_hash.write(writer)?;
2997                         (previous_hops.len() as u64).write(writer)?;
2998                         for previous_hop in previous_hops {
2999                                 previous_hop.write(writer)?;
3000                         }
3001                 }
3002
3003                 Ok(())
3004         }
3005 }
3006
3007 /// Arguments for the creation of a ChannelManager that are not deserialized.
3008 ///
3009 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3010 /// is:
3011 /// 1) Deserialize all stored ChannelMonitors.
3012 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3013 ///    ChannelManager)>::read(reader, args).
3014 ///    This may result in closing some Channels if the ChannelMonitor is newer than the stored
3015 ///    ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3016 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3017 ///    ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3018 /// 4) Reconnect blocks on your ChannelMonitors.
3019 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3020 /// 6) Disconnect/connect blocks on the ChannelManager.
3021 /// 7) Register the new ChannelManager with your ChainWatchInterface (this does not happen
3022 ///    automatically as it does in ChannelManager::new()).
3023 pub struct ChannelManagerReadArgs<'a> {
3024         /// The keys provider which will give us relevant keys. Some keys will be loaded during
3025         /// deserialization.
3026         pub keys_manager: Arc<KeysInterface>,
3027
3028         /// The fee_estimator for use in the ChannelManager in the future.
3029         ///
3030         /// No calls to the FeeEstimator will be made during deserialization.
3031         pub fee_estimator: Arc<FeeEstimator>,
3032         /// The ManyChannelMonitor for use in the ChannelManager in the future.
3033         ///
3034         /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3035         /// you have deserialized ChannelMonitors separately and will add them to your
3036         /// ManyChannelMonitor after deserializing this ChannelManager.
3037         pub monitor: Arc<ManyChannelMonitor>,
3038         /// The ChainWatchInterface for use in the ChannelManager in the future.
3039         ///
3040         /// No calls to the ChainWatchInterface will be made during deserialization.
3041         pub chain_monitor: Arc<ChainWatchInterface>,
3042         /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3043         /// used to broadcast the latest local commitment transactions of channels which must be
3044         /// force-closed during deserialization.
3045         pub tx_broadcaster: Arc<BroadcasterInterface>,
3046         /// The Logger for use in the ChannelManager and which may be used to log information during
3047         /// deserialization.
3048         pub logger: Arc<Logger>,
3049         /// Default settings used for new channels. Any existing channels will continue to use the
3050         /// runtime settings which were stored when the ChannelManager was serialized.
3051         pub default_config: UserConfig,
3052
3053         /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3054         /// value.get_funding_txo() should be the key).
3055         ///
3056         /// If a monitor is inconsistent with the channel state during deserialization the channel will
3057         /// be force-closed using the data in the channelmonitor and the Channel will be dropped. This
3058         /// is true for missing channels as well. If there is a monitor missing for which we find
3059         /// channel data Err(DecodeError::InvalidValue) will be returned.
3060         ///
3061         /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3062         /// this struct.
3063         pub channel_monitors: &'a HashMap<OutPoint, &'a ChannelMonitor>,
3064 }
3065
3066 impl<'a, R : ::std::io::Read> ReadableArgs<R, ChannelManagerReadArgs<'a>> for (Sha256dHash, ChannelManager) {
3067         fn read(reader: &mut R, args: ChannelManagerReadArgs<'a>) -> Result<Self, DecodeError> {
3068                 let _ver: u8 = Readable::read(reader)?;
3069                 let min_ver: u8 = Readable::read(reader)?;
3070                 if min_ver > SERIALIZATION_VERSION {
3071                         return Err(DecodeError::UnknownVersion);
3072                 }
3073
3074                 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3075                 let latest_block_height: u32 = Readable::read(reader)?;
3076                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3077
3078                 let mut closed_channels = Vec::new();
3079
3080                 let channel_count: u64 = Readable::read(reader)?;
3081                 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3082                 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3083                 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3084                 for _ in 0..channel_count {
3085                         let mut channel: Channel = ReadableArgs::read(reader, args.logger.clone())?;
3086                         if channel.last_block_connected != last_block_hash {
3087                                 return Err(DecodeError::InvalidValue);
3088                         }
3089
3090                         let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3091                         funding_txo_set.insert(funding_txo.clone());
3092                         if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
3093                                 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3094                                                 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3095                                                 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3096                                         let mut force_close_res = channel.force_shutdown();
3097                                         force_close_res.0 = monitor.get_latest_local_commitment_txn();
3098                                         closed_channels.push(force_close_res);
3099                                 } else {
3100                                         if let Some(short_channel_id) = channel.get_short_channel_id() {
3101                                                 short_to_id.insert(short_channel_id, channel.channel_id());
3102                                         }
3103                                         by_id.insert(channel.channel_id(), channel);
3104                                 }
3105                         } else {
3106                                 return Err(DecodeError::InvalidValue);
3107                         }
3108                 }
3109
3110                 for (ref funding_txo, ref monitor) in args.channel_monitors.iter() {
3111                         if !funding_txo_set.contains(funding_txo) {
3112                                 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3113                         }
3114                 }
3115
3116                 let forward_htlcs_count: u64 = Readable::read(reader)?;
3117                 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3118                 for _ in 0..forward_htlcs_count {
3119                         let short_channel_id = Readable::read(reader)?;
3120                         let pending_forwards_count: u64 = Readable::read(reader)?;
3121                         let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3122                         for _ in 0..pending_forwards_count {
3123                                 pending_forwards.push(Readable::read(reader)?);
3124                         }
3125                         forward_htlcs.insert(short_channel_id, pending_forwards);
3126                 }
3127
3128                 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3129                 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3130                 for _ in 0..claimable_htlcs_count {
3131                         let payment_hash = Readable::read(reader)?;
3132                         let previous_hops_len: u64 = Readable::read(reader)?;
3133                         let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3134                         for _ in 0..previous_hops_len {
3135                                 previous_hops.push(Readable::read(reader)?);
3136                         }
3137                         claimable_htlcs.insert(payment_hash, previous_hops);
3138                 }
3139
3140                 let channel_manager = ChannelManager {
3141                         genesis_hash,
3142                         fee_estimator: args.fee_estimator,
3143                         monitor: args.monitor,
3144                         chain_monitor: args.chain_monitor,
3145                         tx_broadcaster: args.tx_broadcaster,
3146
3147                         latest_block_height: AtomicUsize::new(latest_block_height as usize),
3148                         last_block_hash: Mutex::new(last_block_hash),
3149                         secp_ctx: Secp256k1::new(),
3150
3151                         channel_state: Mutex::new(ChannelHolder {
3152                                 by_id,
3153                                 short_to_id,
3154                                 next_forward: Instant::now(),
3155                                 forward_htlcs,
3156                                 claimable_htlcs,
3157                                 pending_msg_events: Vec::new(),
3158                         }),
3159                         our_network_key: args.keys_manager.get_node_secret(),
3160
3161                         pending_events: Mutex::new(Vec::new()),
3162                         total_consistency_lock: RwLock::new(()),
3163                         keys_manager: args.keys_manager,
3164                         logger: args.logger,
3165                         default_configuration: args.default_config,
3166                 };
3167
3168                 for close_res in closed_channels.drain(..) {
3169                         channel_manager.finish_force_close_channel(close_res);
3170                         //TODO: Broadcast channel update for closed channels, but only after we've made a
3171                         //connection or two.
3172                 }
3173
3174                 Ok((last_block_hash.clone(), channel_manager))
3175         }
3176 }
3177
3178 #[cfg(test)]
3179 mod tests {
3180         use chain::chaininterface;
3181         use chain::transaction::OutPoint;
3182         use chain::chaininterface::{ChainListener, ChainWatchInterface};
3183         use chain::keysinterface::KeysInterface;
3184         use chain::keysinterface;
3185         use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,OnionKeys,PaymentFailReason,RAACommitmentOrder};
3186         use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS, ManyChannelMonitor};
3187         use ln::router::{Route, RouteHop, Router};
3188         use ln::msgs;
3189         use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
3190         use util::test_utils;
3191         use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
3192         use util::errors::APIError;
3193         use util::logger::Logger;
3194         use util::ser::{Writeable, Writer, ReadableArgs};
3195         use util::config::UserConfig;
3196
3197         use bitcoin::util::hash::Sha256dHash;
3198         use bitcoin::blockdata::block::{Block, BlockHeader};
3199         use bitcoin::blockdata::transaction::{Transaction, TxOut};
3200         use bitcoin::blockdata::constants::genesis_block;
3201         use bitcoin::network::constants::Network;
3202         use bitcoin::network::serialize::serialize;
3203         use bitcoin::network::serialize::BitcoinHash;
3204
3205         use hex;
3206
3207         use secp256k1::{Secp256k1, Message};
3208         use secp256k1::key::{PublicKey,SecretKey};
3209
3210         use crypto::sha2::Sha256;
3211         use crypto::digest::Digest;
3212
3213         use rand::{thread_rng,Rng};
3214
3215         use std::cell::RefCell;
3216         use std::collections::{BTreeSet, HashMap};
3217         use std::default::Default;
3218         use std::rc::Rc;
3219         use std::sync::{Arc, Mutex};
3220         use std::sync::atomic::Ordering;
3221         use std::time::Instant;
3222         use std::mem;
3223
3224         fn build_test_onion_keys() -> Vec<OnionKeys> {
3225                 // Keys from BOLT 4, used in both test vector tests
3226                 let secp_ctx = Secp256k1::new();
3227
3228                 let route = Route {
3229                         hops: vec!(
3230                                         RouteHop {
3231                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
3232                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
3233                                         },
3234                                         RouteHop {
3235                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
3236                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
3237                                         },
3238                                         RouteHop {
3239                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
3240                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
3241                                         },
3242                                         RouteHop {
3243                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
3244                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
3245                                         },
3246                                         RouteHop {
3247                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
3248                                                 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
3249                                         },
3250                         ),
3251                 };
3252
3253                 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
3254
3255                 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
3256                 assert_eq!(onion_keys.len(), route.hops.len());
3257                 onion_keys
3258         }
3259
3260         #[test]
3261         fn onion_vectors() {
3262                 // Packet creation test vectors from BOLT 4
3263                 let onion_keys = build_test_onion_keys();
3264
3265                 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
3266                 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
3267                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
3268                 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
3269                 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
3270
3271                 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
3272                 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
3273                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
3274                 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
3275                 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
3276
3277                 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
3278                 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
3279                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
3280                 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
3281                 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
3282
3283                 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
3284                 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
3285                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
3286                 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
3287                 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
3288
3289                 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
3290                 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
3291                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
3292                 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
3293                 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
3294
3295                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
3296                 let payloads = vec!(
3297                         msgs::OnionHopData {
3298                                 realm: 0,
3299                                 data: msgs::OnionRealm0HopData {
3300                                         short_channel_id: 0,
3301                                         amt_to_forward: 0,
3302                                         outgoing_cltv_value: 0,
3303                                 },
3304                                 hmac: [0; 32],
3305                         },
3306                         msgs::OnionHopData {
3307                                 realm: 0,
3308                                 data: msgs::OnionRealm0HopData {
3309                                         short_channel_id: 0x0101010101010101,
3310                                         amt_to_forward: 0x0100000001,
3311                                         outgoing_cltv_value: 0,
3312                                 },
3313                                 hmac: [0; 32],
3314                         },
3315                         msgs::OnionHopData {
3316                                 realm: 0,
3317                                 data: msgs::OnionRealm0HopData {
3318                                         short_channel_id: 0x0202020202020202,
3319                                         amt_to_forward: 0x0200000002,
3320                                         outgoing_cltv_value: 0,
3321                                 },
3322                                 hmac: [0; 32],
3323                         },
3324                         msgs::OnionHopData {
3325                                 realm: 0,
3326                                 data: msgs::OnionRealm0HopData {
3327                                         short_channel_id: 0x0303030303030303,
3328                                         amt_to_forward: 0x0300000003,
3329                                         outgoing_cltv_value: 0,
3330                                 },
3331                                 hmac: [0; 32],
3332                         },
3333                         msgs::OnionHopData {
3334                                 realm: 0,
3335                                 data: msgs::OnionRealm0HopData {
3336                                         short_channel_id: 0x0404040404040404,
3337                                         amt_to_forward: 0x0400000004,
3338                                         outgoing_cltv_value: 0,
3339                                 },
3340                                 hmac: [0; 32],
3341                         },
3342                 );
3343
3344                 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]);
3345                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
3346                 // anyway...
3347                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
3348         }
3349
3350         #[test]
3351         fn test_failure_packet_onion() {
3352                 // Returning Errors test vectors from BOLT 4
3353
3354                 let onion_keys = build_test_onion_keys();
3355                 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret[..], 0x2002, &[0; 0]);
3356                 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
3357
3358                 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret[..], &onion_error.encode()[..]);
3359                 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
3360
3361                 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret[..], &onion_packet_1.data[..]);
3362                 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
3363
3364                 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret[..], &onion_packet_2.data[..]);
3365                 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
3366
3367                 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret[..], &onion_packet_3.data[..]);
3368                 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
3369
3370                 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret[..], &onion_packet_4.data[..]);
3371                 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
3372         }
3373
3374         fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
3375                 assert!(chain.does_match_tx(tx));
3376                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3377                 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
3378                 for i in 2..100 {
3379                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3380                         chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
3381                 }
3382         }
3383
3384         struct Node {
3385                 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
3386                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
3387                 chan_monitor: Arc<test_utils::TestChannelMonitor>,
3388                 node: Arc<ChannelManager>,
3389                 router: Router,
3390                 node_seed: [u8; 32],
3391                 network_payment_count: Rc<RefCell<u8>>,
3392                 network_chan_count: Rc<RefCell<u32>>,
3393         }
3394         impl Drop for Node {
3395                 fn drop(&mut self) {
3396                         if !::std::thread::panicking() {
3397                                 // Check that we processed all pending events
3398                                 assert_eq!(self.node.get_and_clear_pending_msg_events().len(), 0);
3399                                 assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
3400                                 assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3401                         }
3402                 }
3403         }
3404
3405         fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3406                 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
3407         }
3408
3409         fn create_chan_between_nodes_with_value(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3410                 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
3411                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
3412                 (announcement, as_update, bs_update, channel_id, tx)
3413         }
3414
3415         macro_rules! get_revoke_commit_msgs {
3416                 ($node: expr, $node_id: expr) => {
3417                         {
3418                                 let events = $node.node.get_and_clear_pending_msg_events();
3419                                 assert_eq!(events.len(), 2);
3420                                 (match events[0] {
3421                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3422                                                 assert_eq!(*node_id, $node_id);
3423                                                 (*msg).clone()
3424                                         },
3425                                         _ => panic!("Unexpected event"),
3426                                 }, match events[1] {
3427                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3428                                                 assert_eq!(*node_id, $node_id);
3429                                                 assert!(updates.update_add_htlcs.is_empty());
3430                                                 assert!(updates.update_fulfill_htlcs.is_empty());
3431                                                 assert!(updates.update_fail_htlcs.is_empty());
3432                                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
3433                                                 assert!(updates.update_fee.is_none());
3434                                                 updates.commitment_signed.clone()
3435                                         },
3436                                         _ => panic!("Unexpected event"),
3437                                 })
3438                         }
3439                 }
3440         }
3441
3442         macro_rules! get_event_msg {
3443                 ($node: expr, $event_type: path, $node_id: expr) => {
3444                         {
3445                                 let events = $node.node.get_and_clear_pending_msg_events();
3446                                 assert_eq!(events.len(), 1);
3447                                 match events[0] {
3448                                         $event_type { ref node_id, ref msg } => {
3449                                                 assert_eq!(*node_id, $node_id);
3450                                                 (*msg).clone()
3451                                         },
3452                                         _ => panic!("Unexpected event"),
3453                                 }
3454                         }
3455                 }
3456         }
3457
3458         macro_rules! get_htlc_update_msgs {
3459                 ($node: expr, $node_id: expr) => {
3460                         {
3461                                 let events = $node.node.get_and_clear_pending_msg_events();
3462                                 assert_eq!(events.len(), 1);
3463                                 match events[0] {
3464                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3465                                                 assert_eq!(*node_id, $node_id);
3466                                                 (*updates).clone()
3467                                         },
3468                                         _ => panic!("Unexpected event"),
3469                                 }
3470                         }
3471                 }
3472         }
3473
3474         fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
3475                 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
3476                 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id())).unwrap();
3477                 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id())).unwrap();
3478
3479                 let chan_id = *node_a.network_chan_count.borrow();
3480                 let tx;
3481                 let funding_output;
3482
3483                 let events_2 = node_a.node.get_and_clear_pending_events();
3484                 assert_eq!(events_2.len(), 1);
3485                 match events_2[0] {
3486                         Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
3487                                 assert_eq!(*channel_value_satoshis, channel_value);
3488                                 assert_eq!(user_channel_id, 42);
3489
3490                                 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
3491                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3492                                 }]};
3493                                 funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
3494
3495                                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
3496                                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3497                                 assert_eq!(added_monitors.len(), 1);
3498                                 assert_eq!(added_monitors[0].0, funding_output);
3499                                 added_monitors.clear();
3500                         },
3501                         _ => panic!("Unexpected event"),
3502                 }
3503
3504                 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id())).unwrap();
3505                 {
3506                         let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
3507                         assert_eq!(added_monitors.len(), 1);
3508                         assert_eq!(added_monitors[0].0, funding_output);
3509                         added_monitors.clear();
3510                 }
3511
3512                 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id())).unwrap();
3513                 {
3514                         let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3515                         assert_eq!(added_monitors.len(), 1);
3516                         assert_eq!(added_monitors[0].0, funding_output);
3517                         added_monitors.clear();
3518                 }
3519
3520                 let events_4 = node_a.node.get_and_clear_pending_events();
3521                 assert_eq!(events_4.len(), 1);
3522                 match events_4[0] {
3523                         Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
3524                                 assert_eq!(user_channel_id, 42);
3525                                 assert_eq!(*funding_txo, funding_output);
3526                         },
3527                         _ => panic!("Unexpected event"),
3528                 };
3529
3530                 tx
3531         }
3532
3533         fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
3534                 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
3535                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingLocked, node_a.node.get_our_node_id())).unwrap();
3536
3537                 let channel_id;
3538
3539                 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
3540                 let events_6 = node_a.node.get_and_clear_pending_msg_events();
3541                 assert_eq!(events_6.len(), 2);
3542                 ((match events_6[0] {
3543                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3544                                 channel_id = msg.channel_id.clone();
3545                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3546                                 msg.clone()
3547                         },
3548                         _ => panic!("Unexpected event"),
3549                 }, match events_6[1] {
3550                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3551                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3552                                 msg.clone()
3553                         },
3554                         _ => panic!("Unexpected event"),
3555                 }), channel_id)
3556         }
3557
3558         fn create_chan_between_nodes_with_value_a(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
3559                 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
3560                 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
3561                 (msgs, chan_id, tx)
3562         }
3563
3564         fn create_chan_between_nodes_with_value_b(node_a: &Node, node_b: &Node, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
3565                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap();
3566                 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
3567                 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
3568
3569                 let events_7 = node_b.node.get_and_clear_pending_msg_events();
3570                 assert_eq!(events_7.len(), 1);
3571                 let (announcement, bs_update) = match events_7[0] {
3572                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3573                                 (msg, update_msg)
3574                         },
3575                         _ => panic!("Unexpected event"),
3576                 };
3577
3578                 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
3579                 let events_8 = node_a.node.get_and_clear_pending_msg_events();
3580                 assert_eq!(events_8.len(), 1);
3581                 let as_update = match events_8[0] {
3582                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3583                                 assert!(*announcement == *msg);
3584                                 update_msg
3585                         },
3586                         _ => panic!("Unexpected event"),
3587                 };
3588
3589                 *node_a.network_chan_count.borrow_mut() += 1;
3590
3591                 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
3592         }
3593
3594         fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3595                 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
3596         }
3597
3598         fn create_announced_chan_between_nodes_with_value(nodes: &Vec<Node>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3599                 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
3600                 for node in nodes {
3601                         assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
3602                         node.router.handle_channel_update(&chan_announcement.1).unwrap();
3603                         node.router.handle_channel_update(&chan_announcement.2).unwrap();
3604                 }
3605                 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
3606         }
3607
3608         macro_rules! check_spends {
3609                 ($tx: expr, $spends_tx: expr) => {
3610                         {
3611                                 let mut funding_tx_map = HashMap::new();
3612                                 let spends_tx = $spends_tx;
3613                                 funding_tx_map.insert(spends_tx.txid(), spends_tx);
3614                                 $tx.verify(&funding_tx_map).unwrap();
3615                         }
3616                 }
3617         }
3618
3619         fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate) {
3620                 let (node_a, broadcaster_a, struct_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) } else { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) };
3621                 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
3622                 let (tx_a, tx_b);
3623
3624                 node_a.close_channel(channel_id).unwrap();
3625                 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
3626
3627                 let events_1 = node_b.get_and_clear_pending_msg_events();
3628                 assert!(events_1.len() >= 1);
3629                 let shutdown_b = match events_1[0] {
3630                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
3631                                 assert_eq!(node_id, &node_a.get_our_node_id());
3632                                 msg.clone()
3633                         },
3634                         _ => panic!("Unexpected event"),
3635                 };
3636
3637                 let closing_signed_b = if !close_inbound_first {
3638                         assert_eq!(events_1.len(), 1);
3639                         None
3640                 } else {
3641                         Some(match events_1[1] {
3642                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3643                                         assert_eq!(node_id, &node_a.get_our_node_id());
3644                                         msg.clone()
3645                                 },
3646                                 _ => panic!("Unexpected event"),
3647                         })
3648                 };
3649
3650                 macro_rules! get_closing_signed_broadcast {
3651                         ($node: expr, $dest_pubkey: expr) => {
3652                                 {
3653                                         let events = $node.get_and_clear_pending_msg_events();
3654                                         assert!(events.len() == 1 || events.len() == 2);
3655                                         (match events[events.len() - 1] {
3656                                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3657                                                         msg.clone()
3658                                                 },
3659                                                 _ => panic!("Unexpected event"),
3660                                         }, if events.len() == 2 {
3661                                                 match events[0] {
3662                                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3663                                                                 assert_eq!(*node_id, $dest_pubkey);
3664                                                                 Some(msg.clone())
3665                                                         },
3666                                                         _ => panic!("Unexpected event"),
3667                                                 }
3668                                         } else { None })
3669                                 }
3670                         }
3671                 }
3672
3673                 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
3674                 let (as_update, bs_update) = if close_inbound_first {
3675                         assert!(node_a.get_and_clear_pending_msg_events().is_empty());
3676                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3677                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3678                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3679                         let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3680
3681                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
3682                         let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3683                         assert!(none_b.is_none());
3684                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3685                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3686                         (as_update, bs_update)
3687                 } else {
3688                         let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
3689
3690                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
3691                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3692                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3693                         let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3694
3695                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3696                         let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3697                         assert!(none_a.is_none());
3698                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3699                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3700                         (as_update, bs_update)
3701                 };
3702                 assert_eq!(tx_a, tx_b);
3703                 check_spends!(tx_a, funding_tx);
3704
3705                 (as_update, bs_update)
3706         }
3707
3708         struct SendEvent {
3709                 node_id: PublicKey,
3710                 msgs: Vec<msgs::UpdateAddHTLC>,
3711                 commitment_msg: msgs::CommitmentSigned,
3712         }
3713         impl SendEvent {
3714                 fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
3715                         assert!(updates.update_fulfill_htlcs.is_empty());
3716                         assert!(updates.update_fail_htlcs.is_empty());
3717                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3718                         assert!(updates.update_fee.is_none());
3719                         SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
3720                 }
3721
3722                 fn from_event(event: MessageSendEvent) -> SendEvent {
3723                         match event {
3724                                 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
3725                                 _ => panic!("Unexpected event type!"),
3726                         }
3727                 }
3728         }
3729
3730         macro_rules! check_added_monitors {
3731                 ($node: expr, $count: expr) => {
3732                         {
3733                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3734                                 assert_eq!(added_monitors.len(), $count);
3735                                 added_monitors.clear();
3736                         }
3737                 }
3738         }
3739
3740         macro_rules! commitment_signed_dance {
3741                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
3742                         {
3743                                 check_added_monitors!($node_a, 0);
3744                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3745                                 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3746                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
3747                                 check_added_monitors!($node_a, 1);
3748                                 check_added_monitors!($node_b, 0);
3749                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3750                                 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3751                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3752                                 check_added_monitors!($node_b, 1);
3753                                 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
3754                                 let bs_revoke_and_ack = get_event_msg!($node_b, MessageSendEvent::SendRevokeAndACK, $node_a.node.get_our_node_id());
3755                                 check_added_monitors!($node_b, 1);
3756                                 if $fail_backwards {
3757                                         assert!($node_a.node.get_and_clear_pending_events().is_empty());
3758                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3759                                 }
3760                                 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3761                                 if $fail_backwards {
3762                                         let channel_state = $node_a.node.channel_state.lock().unwrap();
3763                                         assert_eq!(channel_state.pending_msg_events.len(), 1);
3764                                         if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
3765                                                 assert_ne!(*node_id, $node_b.node.get_our_node_id());
3766                                         } else { panic!("Unexpected event"); }
3767                                 } else {
3768                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3769                                 }
3770                                 {
3771                                         let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
3772                                         if $fail_backwards {
3773                                                 assert_eq!(added_monitors.len(), 2);
3774                                                 assert!(added_monitors[0].0 != added_monitors[1].0);
3775                                         } else {
3776                                                 assert_eq!(added_monitors.len(), 1);
3777                                         }
3778                                         added_monitors.clear();
3779                                 }
3780                         }
3781                 }
3782         }
3783
3784         macro_rules! get_payment_preimage_hash {
3785                 ($node: expr) => {
3786                         {
3787                                 let payment_preimage = [*$node.network_payment_count.borrow(); 32];
3788                                 *$node.network_payment_count.borrow_mut() += 1;
3789                                 let mut payment_hash = [0; 32];
3790                                 let mut sha = Sha256::new();
3791                                 sha.input(&payment_preimage[..]);
3792                                 sha.result(&mut payment_hash);
3793                                 (payment_preimage, payment_hash)
3794                         }
3795                 }
3796         }
3797
3798         fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3799                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3800
3801                 let mut payment_event = {
3802                         origin_node.node.send_payment(route, our_payment_hash).unwrap();
3803                         check_added_monitors!(origin_node, 1);
3804
3805                         let mut events = origin_node.node.get_and_clear_pending_msg_events();
3806                         assert_eq!(events.len(), 1);
3807                         SendEvent::from_event(events.remove(0))
3808                 };
3809                 let mut prev_node = origin_node;
3810
3811                 for (idx, &node) in expected_route.iter().enumerate() {
3812                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
3813
3814                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3815                         check_added_monitors!(node, 0);
3816                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
3817
3818                         let events_1 = node.node.get_and_clear_pending_events();
3819                         assert_eq!(events_1.len(), 1);
3820                         match events_1[0] {
3821                                 Event::PendingHTLCsForwardable { .. } => { },
3822                                 _ => panic!("Unexpected event"),
3823                         };
3824
3825                         node.node.channel_state.lock().unwrap().next_forward = Instant::now();
3826                         node.node.process_pending_htlc_forwards();
3827
3828                         if idx == expected_route.len() - 1 {
3829                                 let events_2 = node.node.get_and_clear_pending_events();
3830                                 assert_eq!(events_2.len(), 1);
3831                                 match events_2[0] {
3832                                         Event::PaymentReceived { ref payment_hash, amt } => {
3833                                                 assert_eq!(our_payment_hash, *payment_hash);
3834                                                 assert_eq!(amt, recv_value);
3835                                         },
3836                                         _ => panic!("Unexpected event"),
3837                                 }
3838                         } else {
3839                                 let mut events_2 = node.node.get_and_clear_pending_msg_events();
3840                                 assert_eq!(events_2.len(), 1);
3841                                 check_added_monitors!(node, 1);
3842                                 payment_event = SendEvent::from_event(events_2.remove(0));
3843                                 assert_eq!(payment_event.msgs.len(), 1);
3844                         }
3845
3846                         prev_node = node;
3847                 }
3848
3849                 (our_payment_preimage, our_payment_hash)
3850         }
3851
3852         fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: [u8; 32]) {
3853                 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
3854                 check_added_monitors!(expected_route.last().unwrap(), 1);
3855
3856                 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
3857                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3858                 macro_rules! get_next_msgs {
3859                         ($node: expr) => {
3860                                 {
3861                                         let events = $node.node.get_and_clear_pending_msg_events();
3862                                         assert_eq!(events.len(), 1);
3863                                         match events[0] {
3864                                                 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 } } => {
3865                                                         assert!(update_add_htlcs.is_empty());
3866                                                         assert_eq!(update_fulfill_htlcs.len(), 1);
3867                                                         assert!(update_fail_htlcs.is_empty());
3868                                                         assert!(update_fail_malformed_htlcs.is_empty());
3869                                                         assert!(update_fee.is_none());
3870                                                         expected_next_node = node_id.clone();
3871                                                         Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
3872                                                 },
3873                                                 _ => panic!("Unexpected event"),
3874                                         }
3875                                 }
3876                         }
3877                 }
3878
3879                 macro_rules! last_update_fulfill_dance {
3880                         ($node: expr, $prev_node: expr) => {
3881                                 {
3882                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3883                                         check_added_monitors!($node, 0);
3884                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
3885                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3886                                 }
3887                         }
3888                 }
3889                 macro_rules! mid_update_fulfill_dance {
3890                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
3891                                 {
3892                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3893                                         check_added_monitors!($node, 1);
3894                                         let new_next_msgs = if $new_msgs {
3895                                                 get_next_msgs!($node)
3896                                         } else {
3897                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
3898                                                 None
3899                                         };
3900                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3901                                         next_msgs = new_next_msgs;
3902                                 }
3903                         }
3904                 }
3905
3906                 let mut prev_node = expected_route.last().unwrap();
3907                 for (idx, node) in expected_route.iter().rev().enumerate() {
3908                         assert_eq!(expected_next_node, node.node.get_our_node_id());
3909                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
3910                         if next_msgs.is_some() {
3911                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
3912                         } else if update_next_msgs {
3913                                 next_msgs = get_next_msgs!(node);
3914                         } else {
3915                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
3916                         }
3917                         if !skip_last && idx == expected_route.len() - 1 {
3918                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3919                         }
3920
3921                         prev_node = node;
3922                 }
3923
3924                 if !skip_last {
3925                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
3926                         let events = origin_node.node.get_and_clear_pending_events();
3927                         assert_eq!(events.len(), 1);
3928                         match events[0] {
3929                                 Event::PaymentSent { payment_preimage } => {
3930                                         assert_eq!(payment_preimage, our_payment_preimage);
3931                                 },
3932                                 _ => panic!("Unexpected event"),
3933                         }
3934                 }
3935         }
3936
3937         fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
3938                 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
3939         }
3940
3941         const TEST_FINAL_CLTV: u32 = 32;
3942
3943         fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3944                 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
3945                 assert_eq!(route.hops.len(), expected_route.len());
3946                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
3947                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
3948                 }
3949
3950                 send_along_route(origin_node, route, expected_route, recv_value)
3951         }
3952
3953         fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
3954                 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
3955                 assert_eq!(route.hops.len(), expected_route.len());
3956                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
3957                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
3958                 }
3959
3960                 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3961
3962                 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
3963                 match err {
3964                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
3965                         _ => panic!("Unknown error variants"),
3966                 };
3967         }
3968
3969         fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
3970                 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
3971                 claim_payment(&origin, expected_route, our_payment_preimage);
3972         }
3973
3974         fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: [u8; 32]) {
3975                 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, PaymentFailReason::PreimageUnknown));
3976                 check_added_monitors!(expected_route.last().unwrap(), 1);
3977
3978                 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
3979                 macro_rules! update_fail_dance {
3980                         ($node: expr, $prev_node: expr, $last_node: expr) => {
3981                                 {
3982                                         $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3983                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
3984                                 }
3985                         }
3986                 }
3987
3988                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3989                 let mut prev_node = expected_route.last().unwrap();
3990                 for (idx, node) in expected_route.iter().rev().enumerate() {
3991                         assert_eq!(expected_next_node, node.node.get_our_node_id());
3992                         if next_msgs.is_some() {
3993                                 // We may be the "last node" for the purpose of the commitment dance if we're
3994                                 // skipping the last node (implying it is disconnected) and we're the
3995                                 // second-to-last node!
3996                                 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
3997                         }
3998
3999                         let events = node.node.get_and_clear_pending_msg_events();
4000                         if !skip_last || idx != expected_route.len() - 1 {
4001                                 assert_eq!(events.len(), 1);
4002                                 match events[0] {
4003                                         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 } } => {
4004                                                 assert!(update_add_htlcs.is_empty());
4005                                                 assert!(update_fulfill_htlcs.is_empty());
4006                                                 assert_eq!(update_fail_htlcs.len(), 1);
4007                                                 assert!(update_fail_malformed_htlcs.is_empty());
4008                                                 assert!(update_fee.is_none());
4009                                                 expected_next_node = node_id.clone();
4010                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
4011                                         },
4012                                         _ => panic!("Unexpected event"),
4013                                 }
4014                         } else {
4015                                 assert!(events.is_empty());
4016                         }
4017                         if !skip_last && idx == expected_route.len() - 1 {
4018                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
4019                         }
4020
4021                         prev_node = node;
4022                 }
4023
4024                 if !skip_last {
4025                         update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
4026
4027                         let events = origin_node.node.get_and_clear_pending_events();
4028                         assert_eq!(events.len(), 1);
4029                         match events[0] {
4030                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
4031                                         assert_eq!(payment_hash, our_payment_hash);
4032                                         assert!(rejected_by_dest);
4033                                 },
4034                                 _ => panic!("Unexpected event"),
4035                         }
4036                 }
4037         }
4038
4039         fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
4040                 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
4041         }
4042
4043         fn create_network(node_count: usize) -> Vec<Node> {
4044                 let mut nodes = Vec::new();
4045                 let mut rng = thread_rng();
4046                 let secp_ctx = Secp256k1::new();
4047                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4048
4049                 let chan_count = Rc::new(RefCell::new(0));
4050                 let payment_count = Rc::new(RefCell::new(0));
4051
4052                 for _ in 0..node_count {
4053                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
4054                         let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
4055                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
4056                         let mut seed = [0; 32];
4057                         rng.fill_bytes(&mut seed);
4058                         let keys_manager = Arc::new(keysinterface::KeysManager::new(&seed, Network::Testnet, Arc::clone(&logger)));
4059                         let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone()));
4060                         let mut config = UserConfig::new();
4061                         config.channel_options.announced_channel = true;
4062                         config.channel_limits.force_announced_channel_preference = false;
4063                         let node = ChannelManager::new(Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger), keys_manager.clone(), config).unwrap();
4064                         let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
4065                         nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, node_seed: seed,
4066                                 network_payment_count: payment_count.clone(),
4067                                 network_chan_count: chan_count.clone(),
4068                         });
4069                 }
4070
4071                 nodes
4072         }
4073
4074         #[test]
4075         fn test_async_inbound_update_fee() {
4076                 let mut nodes = create_network(2);
4077                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4078                 let channel_id = chan.2;
4079
4080                 macro_rules! get_feerate {
4081                         ($node: expr) => {{
4082                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4083                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
4084                                 chan.get_feerate()
4085                         }}
4086                 }
4087
4088                 // balancing
4089                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4090
4091                 // A                                        B
4092                 // update_fee                            ->
4093                 // send (1) commitment_signed            -.
4094                 //                                       <- update_add_htlc/commitment_signed
4095                 // send (2) RAA (awaiting remote revoke) -.
4096                 // (1) commitment_signed is delivered    ->
4097                 //                                       .- send (3) RAA (awaiting remote revoke)
4098                 // (2) RAA is delivered                  ->
4099                 //                                       .- send (4) commitment_signed
4100                 //                                       <- (3) RAA is delivered
4101                 // send (5) commitment_signed            -.
4102                 //                                       <- (4) commitment_signed is delivered
4103                 // send (6) RAA                          -.
4104                 // (5) commitment_signed is delivered    ->
4105                 //                                       <- RAA
4106                 // (6) RAA is delivered                  ->
4107
4108                 // First nodes[0] generates an update_fee
4109                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0]) + 20).unwrap();
4110                 check_added_monitors!(nodes[0], 1);
4111
4112                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4113                 assert_eq!(events_0.len(), 1);
4114                 let (update_msg, commitment_signed) = match events_0[0] { // (1)
4115                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4116                                 (update_fee.as_ref(), commitment_signed)
4117                         },
4118                         _ => panic!("Unexpected event"),
4119                 };
4120
4121                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4122
4123                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4124                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4125                 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();
4126                 check_added_monitors!(nodes[1], 1);
4127
4128                 let payment_event = {
4129                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4130                         assert_eq!(events_1.len(), 1);
4131                         SendEvent::from_event(events_1.remove(0))
4132                 };
4133                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4134                 assert_eq!(payment_event.msgs.len(), 1);
4135
4136                 // ...now when the messages get delivered everyone should be happy
4137                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4138                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4139                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4140                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4141                 check_added_monitors!(nodes[0], 1);
4142
4143                 // deliver(1), generate (3):
4144                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4145                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4146                 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
4147                 check_added_monitors!(nodes[1], 1);
4148
4149                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
4150                 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4151                 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
4152                 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
4153                 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
4154                 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
4155                 assert!(bs_update.update_fee.is_none()); // (4)
4156                 check_added_monitors!(nodes[1], 1);
4157
4158                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
4159                 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4160                 assert!(as_update.update_add_htlcs.is_empty()); // (5)
4161                 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
4162                 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
4163                 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
4164                 assert!(as_update.update_fee.is_none()); // (5)
4165                 check_added_monitors!(nodes[0], 1);
4166
4167                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
4168                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4169                 // only (6) so get_event_msg's assert(len == 1) passes
4170                 check_added_monitors!(nodes[0], 1);
4171
4172                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
4173                 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4174                 check_added_monitors!(nodes[1], 1);
4175
4176                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4177                 check_added_monitors!(nodes[0], 1);
4178
4179                 let events_2 = nodes[0].node.get_and_clear_pending_events();
4180                 assert_eq!(events_2.len(), 1);
4181                 match events_2[0] {
4182                         Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
4183                         _ => panic!("Unexpected event"),
4184                 }
4185
4186                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
4187                 check_added_monitors!(nodes[1], 1);
4188         }
4189
4190         #[test]
4191         fn test_update_fee_unordered_raa() {
4192                 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
4193                 // crash in an earlier version of the update_fee patch)
4194                 let mut nodes = create_network(2);
4195                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4196                 let channel_id = chan.2;
4197
4198                 macro_rules! get_feerate {
4199                         ($node: expr) => {{
4200                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4201                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
4202                                 chan.get_feerate()
4203                         }}
4204                 }
4205
4206                 // balancing
4207                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4208
4209                 // First nodes[0] generates an update_fee
4210                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0]) + 20).unwrap();
4211                 check_added_monitors!(nodes[0], 1);
4212
4213                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4214                 assert_eq!(events_0.len(), 1);
4215                 let update_msg = match events_0[0] { // (1)
4216                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
4217                                 update_fee.as_ref()
4218                         },
4219                         _ => panic!("Unexpected event"),
4220                 };
4221
4222                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4223
4224                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4225                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4226                 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();
4227                 check_added_monitors!(nodes[1], 1);
4228
4229                 let payment_event = {
4230                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4231                         assert_eq!(events_1.len(), 1);
4232                         SendEvent::from_event(events_1.remove(0))
4233                 };
4234                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4235                 assert_eq!(payment_event.msgs.len(), 1);
4236
4237                 // ...now when the messages get delivered everyone should be happy
4238                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4239                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4240                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4241                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4242                 check_added_monitors!(nodes[0], 1);
4243
4244                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
4245                 check_added_monitors!(nodes[1], 1);
4246
4247                 // We can't continue, sadly, because our (1) now has a bogus signature
4248         }
4249
4250         #[test]
4251         fn test_multi_flight_update_fee() {
4252                 let nodes = create_network(2);
4253                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4254                 let channel_id = chan.2;
4255
4256                 macro_rules! get_feerate {
4257                         ($node: expr) => {{
4258                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4259                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
4260                                 chan.get_feerate()
4261                         }}
4262                 }
4263
4264                 // A                                        B
4265                 // update_fee/commitment_signed          ->
4266                 //                                       .- send (1) RAA and (2) commitment_signed
4267                 // update_fee (never committed)          ->
4268                 // (3) update_fee                        ->
4269                 // We have to manually generate the above update_fee, it is allowed by the protocol but we
4270                 // don't track which updates correspond to which revoke_and_ack responses so we're in
4271                 // AwaitingRAA mode and will not generate the update_fee yet.
4272                 //                                       <- (1) RAA delivered
4273                 // (3) is generated and send (4) CS      -.
4274                 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
4275                 // know the per_commitment_point to use for it.
4276                 //                                       <- (2) commitment_signed delivered
4277                 // revoke_and_ack                        ->
4278                 //                                          B should send no response here
4279                 // (4) commitment_signed delivered       ->
4280                 //                                       <- RAA/commitment_signed delivered
4281                 // revoke_and_ack                        ->
4282
4283                 // First nodes[0] generates an update_fee
4284                 let initial_feerate = get_feerate!(nodes[0]);
4285                 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
4286                 check_added_monitors!(nodes[0], 1);
4287
4288                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4289                 assert_eq!(events_0.len(), 1);
4290                 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
4291                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4292                                 (update_fee.as_ref().unwrap(), commitment_signed)
4293                         },
4294                         _ => panic!("Unexpected event"),
4295                 };
4296
4297                 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
4298                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
4299                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
4300                 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4301                 check_added_monitors!(nodes[1], 1);
4302
4303                 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
4304                 // transaction:
4305                 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
4306                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4307                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4308
4309                 // Create the (3) update_fee message that nodes[0] will generate before it does...
4310                 let mut update_msg_2 = msgs::UpdateFee {
4311                         channel_id: update_msg_1.channel_id.clone(),
4312                         feerate_per_kw: (initial_feerate + 30) as u32,
4313                 };
4314
4315                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4316
4317                 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
4318                 // Deliver (3)
4319                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4320
4321                 // Deliver (1), generating (3) and (4)
4322                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
4323                 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4324                 check_added_monitors!(nodes[0], 1);
4325                 assert!(as_second_update.update_add_htlcs.is_empty());
4326                 assert!(as_second_update.update_fulfill_htlcs.is_empty());
4327                 assert!(as_second_update.update_fail_htlcs.is_empty());
4328                 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
4329                 // Check that the update_fee newly generated matches what we delivered:
4330                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
4331                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
4332
4333                 // Deliver (2) commitment_signed
4334                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
4335                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4336                 check_added_monitors!(nodes[0], 1);
4337                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4338
4339                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
4340                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4341                 check_added_monitors!(nodes[1], 1);
4342
4343                 // Delever (4)
4344                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
4345                 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4346                 check_added_monitors!(nodes[1], 1);
4347
4348                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4349                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4350                 check_added_monitors!(nodes[0], 1);
4351
4352                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
4353                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4354                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4355                 check_added_monitors!(nodes[0], 1);
4356
4357                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
4358                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4359                 check_added_monitors!(nodes[1], 1);
4360         }
4361
4362         #[test]
4363         fn test_update_fee_vanilla() {
4364                 let nodes = create_network(2);
4365                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4366                 let channel_id = chan.2;
4367
4368                 macro_rules! get_feerate {
4369                         ($node: expr) => {{
4370                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4371                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
4372                                 chan.get_feerate()
4373                         }}
4374                 }
4375
4376                 let feerate = get_feerate!(nodes[0]);
4377                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4378                 check_added_monitors!(nodes[0], 1);
4379
4380                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4381                 assert_eq!(events_0.len(), 1);
4382                 let (update_msg, commitment_signed) = match events_0[0] {
4383                                 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 } } => {
4384                                 (update_fee.as_ref(), commitment_signed)
4385                         },
4386                         _ => panic!("Unexpected event"),
4387                 };
4388                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4389
4390                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4391                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4392                 check_added_monitors!(nodes[1], 1);
4393
4394                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4395                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4396                 check_added_monitors!(nodes[0], 1);
4397
4398                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4399                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4400                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4401                 check_added_monitors!(nodes[0], 1);
4402
4403                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4404                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4405                 check_added_monitors!(nodes[1], 1);
4406         }
4407
4408         #[test]
4409         fn test_update_fee_with_fundee_update_add_htlc() {
4410                 let mut nodes = create_network(2);
4411                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4412                 let channel_id = chan.2;
4413
4414                 macro_rules! get_feerate {
4415                         ($node: expr) => {{
4416                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4417                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
4418                                 chan.get_feerate()
4419                         }}
4420                 }
4421
4422                 // balancing
4423                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4424
4425                 let feerate = get_feerate!(nodes[0]);
4426                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4427                 check_added_monitors!(nodes[0], 1);
4428
4429                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4430                 assert_eq!(events_0.len(), 1);
4431                 let (update_msg, commitment_signed) = match events_0[0] {
4432                                 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 } } => {
4433                                 (update_fee.as_ref(), commitment_signed)
4434                         },
4435                         _ => panic!("Unexpected event"),
4436                 };
4437                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4438                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4439                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4440                 check_added_monitors!(nodes[1], 1);
4441
4442                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
4443
4444                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
4445
4446                 // nothing happens since node[1] is in AwaitingRemoteRevoke
4447                 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
4448                 {
4449                         let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
4450                         assert_eq!(added_monitors.len(), 0);
4451                         added_monitors.clear();
4452                 }
4453                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4454                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4455                 // node[1] has nothing to do
4456
4457                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4458                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4459                 check_added_monitors!(nodes[0], 1);
4460
4461                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4462                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4463                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4464                 check_added_monitors!(nodes[0], 1);
4465                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4466                 check_added_monitors!(nodes[1], 1);
4467                 // AwaitingRemoteRevoke ends here
4468
4469                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4470                 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
4471                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
4472                 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
4473                 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
4474                 assert_eq!(commitment_update.update_fee.is_none(), true);
4475
4476                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
4477                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4478                 check_added_monitors!(nodes[0], 1);
4479                 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4480
4481                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
4482                 check_added_monitors!(nodes[1], 1);
4483                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4484
4485                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
4486                 check_added_monitors!(nodes[1], 1);
4487                 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4488                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4489
4490                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
4491                 check_added_monitors!(nodes[0], 1);
4492                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4493
4494                 let events = nodes[0].node.get_and_clear_pending_events();
4495                 assert_eq!(events.len(), 1);
4496                 match events[0] {
4497                         Event::PendingHTLCsForwardable { .. } => { },
4498                         _ => panic!("Unexpected event"),
4499                 };
4500                 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
4501                 nodes[0].node.process_pending_htlc_forwards();
4502
4503                 let events = nodes[0].node.get_and_clear_pending_events();
4504                 assert_eq!(events.len(), 1);
4505                 match events[0] {
4506                         Event::PaymentReceived { .. } => { },
4507                         _ => panic!("Unexpected event"),
4508                 };
4509
4510                 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
4511
4512                 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
4513                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
4514                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4515         }
4516
4517         #[test]
4518         fn test_update_fee() {
4519                 let nodes = create_network(2);
4520                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4521                 let channel_id = chan.2;
4522
4523                 macro_rules! get_feerate {
4524                         ($node: expr) => {{
4525                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4526                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
4527                                 chan.get_feerate()
4528                         }}
4529                 }
4530
4531                 // A                                        B
4532                 // (1) update_fee/commitment_signed      ->
4533                 //                                       <- (2) revoke_and_ack
4534                 //                                       .- send (3) commitment_signed
4535                 // (4) update_fee/commitment_signed      ->
4536                 //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
4537                 //                                       <- (3) commitment_signed delivered
4538                 // send (6) revoke_and_ack               -.
4539                 //                                       <- (5) deliver revoke_and_ack
4540                 // (6) deliver revoke_and_ack            ->
4541                 //                                       .- send (7) commitment_signed in response to (4)
4542                 //                                       <- (7) deliver commitment_signed
4543                 // revoke_and_ack                        ->
4544
4545                 // Create and deliver (1)...
4546                 let feerate = get_feerate!(nodes[0]);
4547                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4548                 check_added_monitors!(nodes[0], 1);
4549
4550                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4551                 assert_eq!(events_0.len(), 1);
4552                 let (update_msg, commitment_signed) = match events_0[0] {
4553                                 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 } } => {
4554                                 (update_fee.as_ref(), commitment_signed)
4555                         },
4556                         _ => panic!("Unexpected event"),
4557                 };
4558                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4559
4560                 // Generate (2) and (3):
4561                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4562                 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4563                 check_added_monitors!(nodes[1], 1);
4564
4565                 // Deliver (2):
4566                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4567                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4568                 check_added_monitors!(nodes[0], 1);
4569
4570                 // Create and deliver (4)...
4571                 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
4572                 check_added_monitors!(nodes[0], 1);
4573                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4574                 assert_eq!(events_0.len(), 1);
4575                 let (update_msg, commitment_signed) = match events_0[0] {
4576                                 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 } } => {
4577                                 (update_fee.as_ref(), commitment_signed)
4578                         },
4579                         _ => panic!("Unexpected event"),
4580                 };
4581
4582                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4583                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4584                 check_added_monitors!(nodes[1], 1);
4585                 // ... creating (5)
4586                 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4587                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4588
4589                 // Handle (3), creating (6):
4590                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
4591                 check_added_monitors!(nodes[0], 1);
4592                 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4593                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4594
4595                 // Deliver (5):
4596                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4597                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4598                 check_added_monitors!(nodes[0], 1);
4599
4600                 // Deliver (6), creating (7):
4601                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
4602                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4603                 assert!(commitment_update.update_add_htlcs.is_empty());
4604                 assert!(commitment_update.update_fulfill_htlcs.is_empty());
4605                 assert!(commitment_update.update_fail_htlcs.is_empty());
4606                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4607                 assert!(commitment_update.update_fee.is_none());
4608                 check_added_monitors!(nodes[1], 1);
4609
4610                 // Deliver (7)
4611                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4612                 check_added_monitors!(nodes[0], 1);
4613                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4614                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4615
4616                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4617                 check_added_monitors!(nodes[1], 1);
4618                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4619
4620                 assert_eq!(get_feerate!(nodes[0]), feerate + 30);
4621                 assert_eq!(get_feerate!(nodes[1]), feerate + 30);
4622                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4623         }
4624
4625         #[test]
4626         fn fake_network_test() {
4627                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
4628                 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
4629                 let nodes = create_network(4);
4630
4631                 // Create some initial channels
4632                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4633                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4634                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
4635
4636                 // Rebalance the network a bit by relaying one payment through all the channels...
4637                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
4638                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
4639                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
4640                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
4641
4642                 // Send some more payments
4643                 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
4644                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
4645                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
4646
4647                 // Test failure packets
4648                 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
4649                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
4650
4651                 // Add a new channel that skips 3
4652                 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
4653
4654                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
4655                 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
4656                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4657                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4658                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4659                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4660                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4661
4662                 // Do some rebalance loop payments, simultaneously
4663                 let mut hops = Vec::with_capacity(3);
4664                 hops.push(RouteHop {
4665                         pubkey: nodes[2].node.get_our_node_id(),
4666                         short_channel_id: chan_2.0.contents.short_channel_id,
4667                         fee_msat: 0,
4668                         cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
4669                 });
4670                 hops.push(RouteHop {
4671                         pubkey: nodes[3].node.get_our_node_id(),
4672                         short_channel_id: chan_3.0.contents.short_channel_id,
4673                         fee_msat: 0,
4674                         cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
4675                 });
4676                 hops.push(RouteHop {
4677                         pubkey: nodes[1].node.get_our_node_id(),
4678                         short_channel_id: chan_4.0.contents.short_channel_id,
4679                         fee_msat: 1000000,
4680                         cltv_expiry_delta: TEST_FINAL_CLTV,
4681                 });
4682                 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;
4683                 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;
4684                 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
4685
4686                 let mut hops = Vec::with_capacity(3);
4687                 hops.push(RouteHop {
4688                         pubkey: nodes[3].node.get_our_node_id(),
4689                         short_channel_id: chan_4.0.contents.short_channel_id,
4690                         fee_msat: 0,
4691                         cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
4692                 });
4693                 hops.push(RouteHop {
4694                         pubkey: nodes[2].node.get_our_node_id(),
4695                         short_channel_id: chan_3.0.contents.short_channel_id,
4696                         fee_msat: 0,
4697                         cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
4698                 });
4699                 hops.push(RouteHop {
4700                         pubkey: nodes[1].node.get_our_node_id(),
4701                         short_channel_id: chan_2.0.contents.short_channel_id,
4702                         fee_msat: 1000000,
4703                         cltv_expiry_delta: TEST_FINAL_CLTV,
4704                 });
4705                 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;
4706                 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;
4707                 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
4708
4709                 // Claim the rebalances...
4710                 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
4711                 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
4712
4713                 // Add a duplicate new channel from 2 to 4
4714                 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
4715
4716                 // Send some payments across both channels
4717                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
4718                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
4719                 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
4720
4721                 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
4722
4723                 //TODO: Test that routes work again here as we've been notified that the channel is full
4724
4725                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
4726                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
4727                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
4728
4729                 // Close down the channels...
4730                 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
4731                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
4732                 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
4733                 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
4734                 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
4735         }
4736
4737         #[test]
4738         fn duplicate_htlc_test() {
4739                 // Test that we accept duplicate payment_hash HTLCs across the network and that
4740                 // claiming/failing them are all separate and don't effect each other
4741                 let mut nodes = create_network(6);
4742
4743                 // Create some initial channels to route via 3 to 4/5 from 0/1/2
4744                 create_announced_chan_between_nodes(&nodes, 0, 3);
4745                 create_announced_chan_between_nodes(&nodes, 1, 3);
4746                 create_announced_chan_between_nodes(&nodes, 2, 3);
4747                 create_announced_chan_between_nodes(&nodes, 3, 4);
4748                 create_announced_chan_between_nodes(&nodes, 3, 5);
4749
4750                 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
4751
4752                 *nodes[0].network_payment_count.borrow_mut() -= 1;
4753                 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
4754
4755                 *nodes[0].network_payment_count.borrow_mut() -= 1;
4756                 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
4757
4758                 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
4759                 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
4760                 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
4761         }
4762
4763         #[derive(PartialEq)]
4764         enum HTLCType { NONE, TIMEOUT, SUCCESS }
4765         /// Tests that the given node has broadcast transactions for the given Channel
4766         ///
4767         /// First checks that the latest local commitment tx has been broadcast, unless an explicit
4768         /// commitment_tx is provided, which may be used to test that a remote commitment tx was
4769         /// broadcast and the revoked outputs were claimed.
4770         ///
4771         /// Next tests that there is (or is not) a transaction that spends the commitment transaction
4772         /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
4773         ///
4774         /// All broadcast transactions must be accounted for in one of the above three types of we'll
4775         /// also fail.
4776         fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
4777                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4778                 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
4779
4780                 let mut res = Vec::with_capacity(2);
4781                 node_txn.retain(|tx| {
4782                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
4783                                 check_spends!(tx, chan.3.clone());
4784                                 if commitment_tx.is_none() {
4785                                         res.push(tx.clone());
4786                                 }
4787                                 false
4788                         } else { true }
4789                 });
4790                 if let Some(explicit_tx) = commitment_tx {
4791                         res.push(explicit_tx.clone());
4792                 }
4793
4794                 assert_eq!(res.len(), 1);
4795
4796                 if has_htlc_tx != HTLCType::NONE {
4797                         node_txn.retain(|tx| {
4798                                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
4799                                         check_spends!(tx, res[0].clone());
4800                                         if has_htlc_tx == HTLCType::TIMEOUT {
4801                                                 assert!(tx.lock_time != 0);
4802                                         } else {
4803                                                 assert!(tx.lock_time == 0);
4804                                         }
4805                                         res.push(tx.clone());
4806                                         false
4807                                 } else { true }
4808                         });
4809                         assert_eq!(res.len(), 2);
4810                 }
4811
4812                 assert!(node_txn.is_empty());
4813                 res
4814         }
4815
4816         /// Tests that the given node has broadcast a claim transaction against the provided revoked
4817         /// HTLC transaction.
4818         fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
4819                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4820                 assert_eq!(node_txn.len(), 1);
4821                 node_txn.retain(|tx| {
4822                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
4823                                 check_spends!(tx, revoked_tx.clone());
4824                                 false
4825                         } else { true }
4826                 });
4827                 assert!(node_txn.is_empty());
4828         }
4829
4830         fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
4831                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4832
4833                 assert!(node_txn.len() >= 1);
4834                 assert_eq!(node_txn[0].input.len(), 1);
4835                 let mut found_prev = false;
4836
4837                 for tx in prev_txn {
4838                         if node_txn[0].input[0].previous_output.txid == tx.txid() {
4839                                 check_spends!(node_txn[0], tx.clone());
4840                                 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
4841                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
4842
4843                                 found_prev = true;
4844                                 break;
4845                         }
4846                 }
4847                 assert!(found_prev);
4848
4849                 let mut res = Vec::new();
4850                 mem::swap(&mut *node_txn, &mut res);
4851                 res
4852         }
4853
4854         fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
4855                 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
4856                 assert_eq!(events_1.len(), 1);
4857                 let as_update = match events_1[0] {
4858                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
4859                                 msg.clone()
4860                         },
4861                         _ => panic!("Unexpected event"),
4862                 };
4863
4864                 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
4865                 assert_eq!(events_2.len(), 1);
4866                 let bs_update = match events_2[0] {
4867                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
4868                                 msg.clone()
4869                         },
4870                         _ => panic!("Unexpected event"),
4871                 };
4872
4873                 for node in nodes {
4874                         node.router.handle_channel_update(&as_update).unwrap();
4875                         node.router.handle_channel_update(&bs_update).unwrap();
4876                 }
4877         }
4878
4879         macro_rules! expect_pending_htlcs_forwardable {
4880                 ($node: expr) => {{
4881                         let events = $node.node.get_and_clear_pending_events();
4882                         assert_eq!(events.len(), 1);
4883                         match events[0] {
4884                                 Event::PendingHTLCsForwardable { .. } => { },
4885                                 _ => panic!("Unexpected event"),
4886                         };
4887                         $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
4888                         $node.node.process_pending_htlc_forwards();
4889                 }}
4890         }
4891
4892         #[test]
4893         fn channel_reserve_test() {
4894                 use util::rng;
4895                 use std::sync::atomic::Ordering;
4896                 use ln::msgs::HandleError;
4897
4898                 macro_rules! get_channel_value_stat {
4899                         ($node: expr, $channel_id: expr) => {{
4900                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4901                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
4902                                 chan.get_value_stat()
4903                         }}
4904                 }
4905
4906                 let mut nodes = create_network(3);
4907                 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
4908                 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
4909
4910                 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
4911                 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
4912
4913                 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
4914                 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
4915
4916                 macro_rules! get_route_and_payment_hash {
4917                         ($recv_value: expr) => {{
4918                                 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
4919                                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4920                                 (route, payment_hash, payment_preimage)
4921                         }}
4922                 };
4923
4924                 macro_rules! expect_forward {
4925                         ($node: expr) => {{
4926                                 let mut events = $node.node.get_and_clear_pending_msg_events();
4927                                 assert_eq!(events.len(), 1);
4928                                 check_added_monitors!($node, 1);
4929                                 let payment_event = SendEvent::from_event(events.remove(0));
4930                                 payment_event
4931                         }}
4932                 }
4933
4934                 macro_rules! expect_payment_received {
4935                         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
4936                                 let events = $node.node.get_and_clear_pending_events();
4937                                 assert_eq!(events.len(), 1);
4938                                 match events[0] {
4939                                         Event::PaymentReceived { ref payment_hash, amt } => {
4940                                                 assert_eq!($expected_payment_hash, *payment_hash);
4941                                                 assert_eq!($expected_recv_value, amt);
4942                                         },
4943                                         _ => panic!("Unexpected event"),
4944                                 }
4945                         }
4946                 };
4947
4948                 let feemsat = 239; // somehow we know?
4949                 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
4950
4951                 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
4952
4953                 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
4954                 {
4955                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
4956                         assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
4957                         let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
4958                         match err {
4959                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
4960                                 _ => panic!("Unknown error variants"),
4961                         }
4962                 }
4963
4964                 let mut htlc_id = 0;
4965                 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
4966                 // nodes[0]'s wealth
4967                 loop {
4968                         let amt_msat = recv_value_0 + total_fee_msat;
4969                         if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
4970                                 break;
4971                         }
4972                         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
4973                         htlc_id += 1;
4974
4975                         let (stat01_, stat11_, stat12_, stat22_) = (
4976                                 get_channel_value_stat!(nodes[0], chan_1.2),
4977                                 get_channel_value_stat!(nodes[1], chan_1.2),
4978                                 get_channel_value_stat!(nodes[1], chan_2.2),
4979                                 get_channel_value_stat!(nodes[2], chan_2.2),
4980                         );
4981
4982                         assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
4983                         assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
4984                         assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
4985                         assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
4986                         stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
4987                 }
4988
4989                 {
4990                         let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
4991                         // attempt to get channel_reserve violation
4992                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
4993                         let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
4994                         match err {
4995                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4996                                 _ => panic!("Unknown error variants"),
4997                         }
4998                 }
4999
5000                 // adding pending output
5001                 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
5002                 let amt_msat_1 = recv_value_1 + total_fee_msat;
5003
5004                 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
5005                 let payment_event_1 = {
5006                         nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
5007                         check_added_monitors!(nodes[0], 1);
5008
5009                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5010                         assert_eq!(events.len(), 1);
5011                         SendEvent::from_event(events.remove(0))
5012                 };
5013                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
5014
5015                 // channel reserve test with htlc pending output > 0
5016                 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
5017                 {
5018                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5019                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5020                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5021                                 _ => panic!("Unknown error variants"),
5022                         }
5023                 }
5024
5025                 {
5026                         // test channel_reserve test on nodes[1] side
5027                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5028
5029                         // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
5030                         let secp_ctx = Secp256k1::new();
5031                         let session_priv = SecretKey::from_slice(&secp_ctx, &{
5032                                 let mut session_key = [0; 32];
5033                                 rng::fill_bytes(&mut session_key);
5034                                 session_key
5035                         }).expect("RNG is bad!");
5036
5037                         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5038                         let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
5039                         let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height).unwrap();
5040                         let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5041                         let msg = msgs::UpdateAddHTLC {
5042                                 channel_id: chan_1.2,
5043                                 htlc_id,
5044                                 amount_msat: htlc_msat,
5045                                 payment_hash: our_payment_hash,
5046                                 cltv_expiry: htlc_cltv,
5047                                 onion_routing_packet: onion_packet,
5048                         };
5049
5050                         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
5051                         match err {
5052                                 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
5053                         }
5054                 }
5055
5056                 // split the rest to test holding cell
5057                 let recv_value_21 = recv_value_2/2;
5058                 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
5059                 {
5060                         let stat = get_channel_value_stat!(nodes[0], chan_1.2);
5061                         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);
5062                 }
5063
5064                 // now see if they go through on both sides
5065                 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
5066                 // but this will stuck in the holding cell
5067                 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
5068                 check_added_monitors!(nodes[0], 0);
5069                 let events = nodes[0].node.get_and_clear_pending_events();
5070                 assert_eq!(events.len(), 0);
5071
5072                 // test with outbound holding cell amount > 0
5073                 {
5074                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
5075                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5076                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5077                                 _ => panic!("Unknown error variants"),
5078                         }
5079                 }
5080
5081                 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
5082                 // this will also stuck in the holding cell
5083                 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
5084                 check_added_monitors!(nodes[0], 0);
5085                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5086                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5087
5088                 // flush the pending htlc
5089                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
5090                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5091                 check_added_monitors!(nodes[1], 1);
5092
5093                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5094                 check_added_monitors!(nodes[0], 1);
5095                 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5096
5097                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
5098                 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5099                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5100                 check_added_monitors!(nodes[0], 1);
5101
5102                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5103                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5104                 check_added_monitors!(nodes[1], 1);
5105
5106                 expect_pending_htlcs_forwardable!(nodes[1]);
5107
5108                 let ref payment_event_11 = expect_forward!(nodes[1]);
5109                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
5110                 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
5111
5112                 expect_pending_htlcs_forwardable!(nodes[2]);
5113                 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
5114
5115                 // flush the htlcs in the holding cell
5116                 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
5117                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
5118                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
5119                 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
5120                 expect_pending_htlcs_forwardable!(nodes[1]);
5121
5122                 let ref payment_event_3 = expect_forward!(nodes[1]);
5123                 assert_eq!(payment_event_3.msgs.len(), 2);
5124                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
5125                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
5126
5127                 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
5128                 expect_pending_htlcs_forwardable!(nodes[2]);
5129
5130                 let events = nodes[2].node.get_and_clear_pending_events();
5131                 assert_eq!(events.len(), 2);
5132                 match events[0] {
5133                         Event::PaymentReceived { ref payment_hash, amt } => {
5134                                 assert_eq!(our_payment_hash_21, *payment_hash);
5135                                 assert_eq!(recv_value_21, amt);
5136                         },
5137                         _ => panic!("Unexpected event"),
5138                 }
5139                 match events[1] {
5140                         Event::PaymentReceived { ref payment_hash, amt } => {
5141                                 assert_eq!(our_payment_hash_22, *payment_hash);
5142                                 assert_eq!(recv_value_22, amt);
5143                         },
5144                         _ => panic!("Unexpected event"),
5145                 }
5146
5147                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
5148                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
5149                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
5150
5151                 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);
5152                 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
5153                 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
5154                 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
5155
5156                 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
5157                 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
5158         }
5159
5160         #[test]
5161         fn channel_monitor_network_test() {
5162                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5163                 // tests that ChannelMonitor is able to recover from various states.
5164                 let nodes = create_network(5);
5165
5166                 // Create some initial channels
5167                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5168                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5169                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5170                 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
5171
5172                 // Rebalance the network a bit by relaying one payment through all the channels...
5173                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5174                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5175                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5176                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5177
5178                 // Simple case with no pending HTLCs:
5179                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
5180                 {
5181                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
5182                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5183                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5184                         test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
5185                 }
5186                 get_announce_close_broadcast_events(&nodes, 0, 1);
5187                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5188                 assert_eq!(nodes[1].node.list_channels().len(), 1);
5189
5190                 // One pending HTLC is discarded by the force-close:
5191                 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
5192
5193                 // Simple case of one pending HTLC to HTLC-Timeout
5194                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
5195                 {
5196                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
5197                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5198                         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5199                         test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
5200                 }
5201                 get_announce_close_broadcast_events(&nodes, 1, 2);
5202                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5203                 assert_eq!(nodes[2].node.list_channels().len(), 1);
5204
5205                 macro_rules! claim_funds {
5206                         ($node: expr, $prev_node: expr, $preimage: expr) => {
5207                                 {
5208                                         assert!($node.node.claim_funds($preimage));
5209                                         check_added_monitors!($node, 1);
5210
5211                                         let events = $node.node.get_and_clear_pending_msg_events();
5212                                         assert_eq!(events.len(), 1);
5213                                         match events[0] {
5214                                                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
5215                                                         assert!(update_add_htlcs.is_empty());
5216                                                         assert!(update_fail_htlcs.is_empty());
5217                                                         assert_eq!(*node_id, $prev_node.node.get_our_node_id());
5218                                                 },
5219                                                 _ => panic!("Unexpected event"),
5220                                         };
5221                                 }
5222                         }
5223                 }
5224
5225                 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
5226                 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
5227                 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
5228                 {
5229                         let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
5230
5231                         // Claim the payment on nodes[3], giving it knowledge of the preimage
5232                         claim_funds!(nodes[3], nodes[2], payment_preimage_1);
5233
5234                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5235                         nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
5236
5237                         check_preimage_claim(&nodes[3], &node_txn);
5238                 }
5239                 get_announce_close_broadcast_events(&nodes, 2, 3);
5240                 assert_eq!(nodes[2].node.list_channels().len(), 0);
5241                 assert_eq!(nodes[3].node.list_channels().len(), 1);
5242
5243                 { // Cheat and reset nodes[4]'s height to 1
5244                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5245                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
5246                 }
5247
5248                 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
5249                 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
5250                 // One pending HTLC to time out:
5251                 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
5252                 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
5253                 // buffer space).
5254
5255                 {
5256                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5257                         nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5258                         for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
5259                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5260                                 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5261                         }
5262
5263                         let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
5264
5265                         // Claim the payment on nodes[4], giving it knowledge of the preimage
5266                         claim_funds!(nodes[4], nodes[3], payment_preimage_2);
5267
5268                         header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5269                         nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5270                         for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
5271                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5272                                 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5273                         }
5274
5275                         test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
5276
5277                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5278                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
5279
5280                         check_preimage_claim(&nodes[4], &node_txn);
5281                 }
5282                 get_announce_close_broadcast_events(&nodes, 3, 4);
5283                 assert_eq!(nodes[3].node.list_channels().len(), 0);
5284                 assert_eq!(nodes[4].node.list_channels().len(), 0);
5285
5286                 // Create some new channels:
5287                 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
5288
5289                 // A pending HTLC which will be revoked:
5290                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5291                 // Get the will-be-revoked local txn from nodes[0]
5292                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5293                 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
5294                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5295                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
5296                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
5297                 assert_eq!(revoked_local_txn[1].input.len(), 1);
5298                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5299                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
5300                 // Revoke the old state
5301                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
5302
5303                 {
5304                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5305                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5306                         {
5307                                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5308                                 assert_eq!(node_txn.len(), 3);
5309                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5310                                 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
5311
5312                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5313                                 node_txn.swap_remove(0);
5314                         }
5315                         test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
5316
5317                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5318                         let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
5319                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5320                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5321                         test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
5322                 }
5323                 get_announce_close_broadcast_events(&nodes, 0, 1);
5324                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5325                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5326         }
5327
5328         #[test]
5329         fn revoked_output_claim() {
5330                 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
5331                 // transaction is broadcast by its counterparty
5332                 let nodes = create_network(2);
5333                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5334                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
5335                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5336                 assert_eq!(revoked_local_txn.len(), 1);
5337                 // Only output is the full channel value back to nodes[0]:
5338                 assert_eq!(revoked_local_txn[0].output.len(), 1);
5339                 // Send a payment through, updating everyone's latest commitment txn
5340                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
5341
5342                 // Inform nodes[1] that nodes[0] broadcast a stale tx
5343                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5344                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5345                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5346                 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
5347
5348                 assert_eq!(node_txn[0], node_txn[2]);
5349
5350                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5351                 check_spends!(node_txn[1], chan_1.3.clone());
5352
5353                 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
5354                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5355                 get_announce_close_broadcast_events(&nodes, 0, 1);
5356         }
5357
5358         #[test]
5359         fn claim_htlc_outputs_shared_tx() {
5360                 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
5361                 let nodes = create_network(2);
5362
5363                 // Create some new channel:
5364                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5365
5366                 // Rebalance the network to generate htlc in the two directions
5367                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5368                 // 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
5369                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5370                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
5371
5372                 // Get the will-be-revoked local txn from node[0]
5373                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5374                 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
5375                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5376                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5377                 assert_eq!(revoked_local_txn[1].input.len(), 1);
5378                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5379                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
5380                 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
5381
5382                 //Revoke the old state
5383                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
5384
5385                 {
5386                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5387
5388                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5389
5390                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5391                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5392                         assert_eq!(node_txn.len(), 4);
5393
5394                         assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
5395                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
5396
5397                         assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
5398
5399                         let mut witness_lens = BTreeSet::new();
5400                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
5401                         witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
5402                         witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
5403                         assert_eq!(witness_lens.len(), 3);
5404                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
5405                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
5406                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
5407
5408                         // Next nodes[1] broadcasts its current local tx state:
5409                         assert_eq!(node_txn[1].input.len(), 1);
5410                         assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
5411
5412                         assert_eq!(node_txn[2].input.len(), 1);
5413                         let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
5414                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
5415                         assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
5416                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
5417                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
5418                 }
5419                 get_announce_close_broadcast_events(&nodes, 0, 1);
5420                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5421                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5422         }
5423
5424         #[test]
5425         fn claim_htlc_outputs_single_tx() {
5426                 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
5427                 let nodes = create_network(2);
5428
5429                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5430
5431                 // Rebalance the network to generate htlc in the two directions
5432                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5433                 // 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
5434                 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
5435                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5436                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
5437
5438                 // Get the will-be-revoked local txn from node[0]
5439                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5440
5441                 //Revoke the old state
5442                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
5443
5444                 {
5445                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5446
5447                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
5448
5449                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
5450                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5451                         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)
5452
5453                         assert_eq!(node_txn[0], node_txn[7]);
5454                         assert_eq!(node_txn[1], node_txn[8]);
5455                         assert_eq!(node_txn[2], node_txn[9]);
5456                         assert_eq!(node_txn[3], node_txn[10]);
5457                         assert_eq!(node_txn[4], node_txn[11]);
5458                         assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
5459                         assert_eq!(node_txn[4], node_txn[6]);
5460
5461                         assert_eq!(node_txn[0].input.len(), 1);
5462                         assert_eq!(node_txn[1].input.len(), 1);
5463                         assert_eq!(node_txn[2].input.len(), 1);
5464
5465                         let mut revoked_tx_map = HashMap::new();
5466                         revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
5467                         node_txn[0].verify(&revoked_tx_map).unwrap();
5468                         node_txn[1].verify(&revoked_tx_map).unwrap();
5469                         node_txn[2].verify(&revoked_tx_map).unwrap();
5470
5471                         let mut witness_lens = BTreeSet::new();
5472                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
5473                         witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
5474                         witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
5475                         assert_eq!(witness_lens.len(), 3);
5476                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
5477                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
5478                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
5479
5480                         assert_eq!(node_txn[3].input.len(), 1);
5481                         check_spends!(node_txn[3], chan_1.3.clone());
5482
5483                         assert_eq!(node_txn[4].input.len(), 1);
5484                         let witness_script = node_txn[4].input[0].witness.last().unwrap();
5485                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
5486                         assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
5487                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
5488                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
5489                 }
5490                 get_announce_close_broadcast_events(&nodes, 0, 1);
5491                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5492                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5493         }
5494
5495         #[test]
5496         fn test_htlc_ignore_latest_remote_commitment() {
5497                 // Test that HTLC transactions spending the latest remote commitment transaction are simply
5498                 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
5499                 let nodes = create_network(2);
5500                 create_announced_chan_between_nodes(&nodes, 0, 1);
5501
5502                 route_payment(&nodes[0], &[&nodes[1]], 10000000);
5503                 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
5504                 {
5505                         let events = nodes[0].node.get_and_clear_pending_msg_events();
5506                         assert_eq!(events.len(), 1);
5507                         match events[0] {
5508                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5509                                         assert_eq!(flags & 0b10, 0b10);
5510                                 },
5511                                 _ => panic!("Unexpected event"),
5512                         }
5513                 }
5514
5515                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5516                 assert_eq!(node_txn.len(), 2);
5517
5518                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5519                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
5520
5521                 {
5522                         let events = nodes[1].node.get_and_clear_pending_msg_events();
5523                         assert_eq!(events.len(), 1);
5524                         match events[0] {
5525                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5526                                         assert_eq!(flags & 0b10, 0b10);
5527                                 },
5528                                 _ => panic!("Unexpected event"),
5529                         }
5530                 }
5531
5532                 // Duplicate the block_connected call since this may happen due to other listeners
5533                 // registering new transactions
5534                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
5535         }
5536
5537         #[test]
5538         fn test_force_close_fail_back() {
5539                 // Check which HTLCs are failed-backwards on channel force-closure
5540                 let mut nodes = create_network(3);
5541                 create_announced_chan_between_nodes(&nodes, 0, 1);
5542                 create_announced_chan_between_nodes(&nodes, 1, 2);
5543
5544                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
5545
5546                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5547
5548                 let mut payment_event = {
5549                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5550                         check_added_monitors!(nodes[0], 1);
5551
5552                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5553                         assert_eq!(events.len(), 1);
5554                         SendEvent::from_event(events.remove(0))
5555                 };
5556
5557                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5558                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5559
5560                 let events_1 = nodes[1].node.get_and_clear_pending_events();
5561                 assert_eq!(events_1.len(), 1);
5562                 match events_1[0] {
5563                         Event::PendingHTLCsForwardable { .. } => { },
5564                         _ => panic!("Unexpected event"),
5565                 };
5566
5567                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
5568                 nodes[1].node.process_pending_htlc_forwards();
5569
5570                 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5571                 assert_eq!(events_2.len(), 1);
5572                 payment_event = SendEvent::from_event(events_2.remove(0));
5573                 assert_eq!(payment_event.msgs.len(), 1);
5574
5575                 check_added_monitors!(nodes[1], 1);
5576                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5577                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
5578                 check_added_monitors!(nodes[2], 1);
5579                 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5580
5581                 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
5582                 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
5583                 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
5584
5585                 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
5586                 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5587                 assert_eq!(events_3.len(), 1);
5588                 match events_3[0] {
5589                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5590                                 assert_eq!(flags & 0b10, 0b10);
5591                         },
5592                         _ => panic!("Unexpected event"),
5593                 }
5594
5595                 let tx = {
5596                         let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
5597                         // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
5598                         // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
5599                         // back to nodes[1] upon timeout otherwise.
5600                         assert_eq!(node_txn.len(), 1);
5601                         node_txn.remove(0)
5602                 };
5603
5604                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5605                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
5606
5607                 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5608                 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
5609                 assert_eq!(events_4.len(), 1);
5610                 match events_4[0] {
5611                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5612                                 assert_eq!(flags & 0b10, 0b10);
5613                         },
5614                         _ => panic!("Unexpected event"),
5615                 }
5616
5617                 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
5618                 {
5619                         let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
5620                         monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
5621                                 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
5622                 }
5623                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
5624                 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
5625                 assert_eq!(node_txn.len(), 1);
5626                 assert_eq!(node_txn[0].input.len(), 1);
5627                 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
5628                 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
5629                 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
5630
5631                 check_spends!(node_txn[0], tx);
5632         }
5633
5634         #[test]
5635         fn test_unconf_chan() {
5636                 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
5637                 let nodes = create_network(2);
5638                 create_announced_chan_between_nodes(&nodes, 0, 1);
5639
5640                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
5641                 assert_eq!(channel_state.by_id.len(), 1);
5642                 assert_eq!(channel_state.short_to_id.len(), 1);
5643                 mem::drop(channel_state);
5644
5645                 let mut headers = Vec::new();
5646                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5647                 headers.push(header.clone());
5648                 for _i in 2..100 {
5649                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5650                         headers.push(header.clone());
5651                 }
5652                 while !headers.is_empty() {
5653                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
5654                 }
5655                 {
5656                         let events = nodes[0].node.get_and_clear_pending_msg_events();
5657                         assert_eq!(events.len(), 1);
5658                         match events[0] {
5659                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5660                                         assert_eq!(flags & 0b10, 0b10);
5661                                 },
5662                                 _ => panic!("Unexpected event"),
5663                         }
5664                 }
5665                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
5666                 assert_eq!(channel_state.by_id.len(), 0);
5667                 assert_eq!(channel_state.short_to_id.len(), 0);
5668         }
5669
5670         macro_rules! get_chan_reestablish_msgs {
5671                 ($src_node: expr, $dst_node: expr) => {
5672                         {
5673                                 let mut res = Vec::with_capacity(1);
5674                                 for msg in $src_node.node.get_and_clear_pending_msg_events() {
5675                                         if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
5676                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
5677                                                 res.push(msg.clone());
5678                                         } else {
5679                                                 panic!("Unexpected event")
5680                                         }
5681                                 }
5682                                 res
5683                         }
5684                 }
5685         }
5686
5687         macro_rules! handle_chan_reestablish_msgs {
5688                 ($src_node: expr, $dst_node: expr) => {
5689                         {
5690                                 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
5691                                 let mut idx = 0;
5692                                 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
5693                                         idx += 1;
5694                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
5695                                         Some(msg.clone())
5696                                 } else {
5697                                         None
5698                                 };
5699
5700                                 let mut revoke_and_ack = None;
5701                                 let mut commitment_update = None;
5702                                 let order = if let Some(ev) = msg_events.get(idx) {
5703                                         idx += 1;
5704                                         match ev {
5705                                                 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
5706                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
5707                                                         revoke_and_ack = Some(msg.clone());
5708                                                         RAACommitmentOrder::RevokeAndACKFirst
5709                                                 },
5710                                                 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5711                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
5712                                                         commitment_update = Some(updates.clone());
5713                                                         RAACommitmentOrder::CommitmentFirst
5714                                                 },
5715                                                 _ => panic!("Unexpected event"),
5716                                         }
5717                                 } else {
5718                                         RAACommitmentOrder::CommitmentFirst
5719                                 };
5720
5721                                 if let Some(ev) = msg_events.get(idx) {
5722                                         match ev {
5723                                                 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
5724                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
5725                                                         assert!(revoke_and_ack.is_none());
5726                                                         revoke_and_ack = Some(msg.clone());
5727                                                 },
5728                                                 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5729                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
5730                                                         assert!(commitment_update.is_none());
5731                                                         commitment_update = Some(updates.clone());
5732                                                 },
5733                                                 _ => panic!("Unexpected event"),
5734                                         }
5735                                 }
5736
5737                                 (funding_locked, revoke_and_ack, commitment_update, order)
5738                         }
5739                 }
5740         }
5741
5742         /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
5743         /// for claims/fails they are separated out.
5744         fn reconnect_nodes(node_a: &Node, node_b: &Node, pre_all_htlcs: bool, pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
5745                 node_a.node.peer_connected(&node_b.node.get_our_node_id());
5746                 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
5747                 node_b.node.peer_connected(&node_a.node.get_our_node_id());
5748                 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
5749
5750                 let mut resp_1 = Vec::new();
5751                 for msg in reestablish_1 {
5752                         node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
5753                         resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
5754                 }
5755                 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
5756                         check_added_monitors!(node_b, 1);
5757                 } else {
5758                         check_added_monitors!(node_b, 0);
5759                 }
5760
5761                 let mut resp_2 = Vec::new();
5762                 for msg in reestablish_2 {
5763                         node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
5764                         resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
5765                 }
5766                 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
5767                         check_added_monitors!(node_a, 1);
5768                 } else {
5769                         check_added_monitors!(node_a, 0);
5770                 }
5771
5772                 // We dont yet support both needing updates, as that would require a different commitment dance:
5773                 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
5774                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
5775
5776                 for chan_msgs in resp_1.drain(..) {
5777                         if pre_all_htlcs {
5778                                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
5779                                 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
5780                                 if !announcement_event.is_empty() {
5781                                         assert_eq!(announcement_event.len(), 1);
5782                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
5783                                                 //TODO: Test announcement_sigs re-sending
5784                                         } else { panic!("Unexpected event!"); }
5785                                 }
5786                         } else {
5787                                 assert!(chan_msgs.0.is_none());
5788                         }
5789                         if pending_raa.0 {
5790                                 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
5791                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
5792                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
5793                                 check_added_monitors!(node_a, 1);
5794                         } else {
5795                                 assert!(chan_msgs.1.is_none());
5796                         }
5797                         if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
5798                                 let commitment_update = chan_msgs.2.unwrap();
5799                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
5800                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
5801                                 } else {
5802                                         assert!(commitment_update.update_add_htlcs.is_empty());
5803                                 }
5804                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
5805                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
5806                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
5807                                 for update_add in commitment_update.update_add_htlcs {
5808                                         node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
5809                                 }
5810                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
5811                                         node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
5812                                 }
5813                                 for update_fail in commitment_update.update_fail_htlcs {
5814                                         node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
5815                                 }
5816
5817                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
5818                                         commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
5819                                 } else {
5820                                         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
5821                                         check_added_monitors!(node_a, 1);
5822                                         let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
5823                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
5824                                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5825                                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
5826                                         check_added_monitors!(node_b, 1);
5827                                 }
5828                         } else {
5829                                 assert!(chan_msgs.2.is_none());
5830                         }
5831                 }
5832
5833                 for chan_msgs in resp_2.drain(..) {
5834                         if pre_all_htlcs {
5835                                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
5836                                 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
5837                                 if !announcement_event.is_empty() {
5838                                         assert_eq!(announcement_event.len(), 1);
5839                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
5840                                                 //TODO: Test announcement_sigs re-sending
5841                                         } else { panic!("Unexpected event!"); }
5842                                 }
5843                         } else {
5844                                 assert!(chan_msgs.0.is_none());
5845                         }
5846                         if pending_raa.1 {
5847                                 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
5848                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
5849                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
5850                                 check_added_monitors!(node_b, 1);
5851                         } else {
5852                                 assert!(chan_msgs.1.is_none());
5853                         }
5854                         if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
5855                                 let commitment_update = chan_msgs.2.unwrap();
5856                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
5857                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
5858                                 }
5859                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
5860                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
5861                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
5862                                 for update_add in commitment_update.update_add_htlcs {
5863                                         node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
5864                                 }
5865                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
5866                                         node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
5867                                 }
5868                                 for update_fail in commitment_update.update_fail_htlcs {
5869                                         node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
5870                                 }
5871
5872                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
5873                                         commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
5874                                 } else {
5875                                         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
5876                                         check_added_monitors!(node_b, 1);
5877                                         let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
5878                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
5879                                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5880                                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
5881                                         check_added_monitors!(node_a, 1);
5882                                 }
5883                         } else {
5884                                 assert!(chan_msgs.2.is_none());
5885                         }
5886                 }
5887         }
5888
5889         #[test]
5890         fn test_simple_peer_disconnect() {
5891                 // Test that we can reconnect when there are no lost messages
5892                 let nodes = create_network(3);
5893                 create_announced_chan_between_nodes(&nodes, 0, 1);
5894                 create_announced_chan_between_nodes(&nodes, 1, 2);
5895
5896                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5897                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5898                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5899
5900                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5901                 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5902                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
5903                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
5904
5905                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5906                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5907                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5908
5909                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5910                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5911                 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5912                 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5913
5914                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5915                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5916
5917                 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
5918                 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
5919
5920                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
5921                 {
5922                         let events = nodes[0].node.get_and_clear_pending_events();
5923                         assert_eq!(events.len(), 2);
5924                         match events[0] {
5925                                 Event::PaymentSent { payment_preimage } => {
5926                                         assert_eq!(payment_preimage, payment_preimage_3);
5927                                 },
5928                                 _ => panic!("Unexpected event"),
5929                         }
5930                         match events[1] {
5931                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
5932                                         assert_eq!(payment_hash, payment_hash_5);
5933                                         assert!(rejected_by_dest);
5934                                 },
5935                                 _ => panic!("Unexpected event"),
5936                         }
5937                 }
5938
5939                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
5940                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
5941         }
5942
5943         fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
5944                 // Test that we can reconnect when in-flight HTLC updates get dropped
5945                 let mut nodes = create_network(2);
5946                 if messages_delivered == 0 {
5947                         create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
5948                         // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
5949                 } else {
5950                         create_announced_chan_between_nodes(&nodes, 0, 1);
5951                 }
5952
5953                 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();
5954                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
5955
5956                 let payment_event = {
5957                         nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
5958                         check_added_monitors!(nodes[0], 1);
5959
5960                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5961                         assert_eq!(events.len(), 1);
5962                         SendEvent::from_event(events.remove(0))
5963                 };
5964                 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
5965
5966                 if messages_delivered < 2 {
5967                         // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
5968                 } else {
5969                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5970                         if messages_delivered >= 3 {
5971                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
5972                                 check_added_monitors!(nodes[1], 1);
5973                                 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5974
5975                                 if messages_delivered >= 4 {
5976                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5977                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5978                                         check_added_monitors!(nodes[0], 1);
5979
5980                                         if messages_delivered >= 5 {
5981                                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
5982                                                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5983                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5984                                                 check_added_monitors!(nodes[0], 1);
5985
5986                                                 if messages_delivered >= 6 {
5987                                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5988                                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5989                                                         check_added_monitors!(nodes[1], 1);
5990                                                 }
5991                                         }
5992                                 }
5993                         }
5994                 }
5995
5996                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5997                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5998                 if messages_delivered < 3 {
5999                         // Even if the funding_locked messages get exchanged, as long as nothing further was
6000                         // received on either side, both sides will need to resend them.
6001                         reconnect_nodes(&nodes[0], &nodes[1], true, (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
6002                 } else if messages_delivered == 3 {
6003                         // nodes[0] still wants its RAA + commitment_signed
6004                         reconnect_nodes(&nodes[0], &nodes[1], false, (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
6005                 } else if messages_delivered == 4 {
6006                         // nodes[0] still wants its commitment_signed
6007                         reconnect_nodes(&nodes[0], &nodes[1], false, (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
6008                 } else if messages_delivered == 5 {
6009                         // nodes[1] still wants its final RAA
6010                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
6011                 } else if messages_delivered == 6 {
6012                         // Everything was delivered...
6013                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6014                 }
6015
6016                 let events_1 = nodes[1].node.get_and_clear_pending_events();
6017                 assert_eq!(events_1.len(), 1);
6018                 match events_1[0] {
6019                         Event::PendingHTLCsForwardable { .. } => { },
6020                         _ => panic!("Unexpected event"),
6021                 };
6022
6023                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6024                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6025                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6026
6027                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6028                 nodes[1].node.process_pending_htlc_forwards();
6029
6030                 let events_2 = nodes[1].node.get_and_clear_pending_events();
6031                 assert_eq!(events_2.len(), 1);
6032                 match events_2[0] {
6033                         Event::PaymentReceived { ref payment_hash, amt } => {
6034                                 assert_eq!(payment_hash_1, *payment_hash);
6035                                 assert_eq!(amt, 1000000);
6036                         },
6037                         _ => panic!("Unexpected event"),
6038                 }
6039
6040                 nodes[1].node.claim_funds(payment_preimage_1);
6041                 check_added_monitors!(nodes[1], 1);
6042
6043                 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
6044                 assert_eq!(events_3.len(), 1);
6045                 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
6046                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6047                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6048                                 assert!(updates.update_add_htlcs.is_empty());
6049                                 assert!(updates.update_fail_htlcs.is_empty());
6050                                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
6051                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
6052                                 assert!(updates.update_fee.is_none());
6053                                 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
6054                         },
6055                         _ => panic!("Unexpected event"),
6056                 };
6057
6058                 if messages_delivered >= 1 {
6059                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
6060
6061                         let events_4 = nodes[0].node.get_and_clear_pending_events();
6062                         assert_eq!(events_4.len(), 1);
6063                         match events_4[0] {
6064                                 Event::PaymentSent { ref payment_preimage } => {
6065                                         assert_eq!(payment_preimage_1, *payment_preimage);
6066                                 },
6067                                 _ => panic!("Unexpected event"),
6068                         }
6069
6070                         if messages_delivered >= 2 {
6071                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
6072                                 check_added_monitors!(nodes[0], 1);
6073                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6074
6075                                 if messages_delivered >= 3 {
6076                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6077                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6078                                         check_added_monitors!(nodes[1], 1);
6079
6080                                         if messages_delivered >= 4 {
6081                                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
6082                                                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6083                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6084                                                 check_added_monitors!(nodes[1], 1);
6085
6086                                                 if messages_delivered >= 5 {
6087                                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6088                                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6089                                                         check_added_monitors!(nodes[0], 1);
6090                                                 }
6091                                         }
6092                                 }
6093                         }
6094                 }
6095
6096                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6097                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6098                 if messages_delivered < 2 {
6099                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
6100                         //TODO: Deduplicate PaymentSent events, then enable this if:
6101                         //if messages_delivered < 1 {
6102                                 let events_4 = nodes[0].node.get_and_clear_pending_events();
6103                                 assert_eq!(events_4.len(), 1);
6104                                 match events_4[0] {
6105                                         Event::PaymentSent { ref payment_preimage } => {
6106                                                 assert_eq!(payment_preimage_1, *payment_preimage);
6107                                         },
6108                                         _ => panic!("Unexpected event"),
6109                                 }
6110                         //}
6111                 } else if messages_delivered == 2 {
6112                         // nodes[0] still wants its RAA + commitment_signed
6113                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
6114                 } else if messages_delivered == 3 {
6115                         // nodes[0] still wants its commitment_signed
6116                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
6117                 } else if messages_delivered == 4 {
6118                         // nodes[1] still wants its final RAA
6119                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
6120                 } else if messages_delivered == 5 {
6121                         // Everything was delivered...
6122                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6123                 }
6124
6125                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6126                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6127                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6128
6129                 // Channel should still work fine...
6130                 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
6131                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6132         }
6133
6134         #[test]
6135         fn test_drop_messages_peer_disconnect_a() {
6136                 do_test_drop_messages_peer_disconnect(0);
6137                 do_test_drop_messages_peer_disconnect(1);
6138                 do_test_drop_messages_peer_disconnect(2);
6139                 do_test_drop_messages_peer_disconnect(3);
6140         }
6141
6142         #[test]
6143         fn test_drop_messages_peer_disconnect_b() {
6144                 do_test_drop_messages_peer_disconnect(4);
6145                 do_test_drop_messages_peer_disconnect(5);
6146                 do_test_drop_messages_peer_disconnect(6);
6147         }
6148
6149         #[test]
6150         fn test_funding_peer_disconnect() {
6151                 // Test that we can lock in our funding tx while disconnected
6152                 let nodes = create_network(2);
6153                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
6154
6155                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6156                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6157
6158                 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
6159                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6160                 assert_eq!(events_1.len(), 1);
6161                 match events_1[0] {
6162                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
6163                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6164                         },
6165                         _ => panic!("Unexpected event"),
6166                 }
6167
6168                 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
6169                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6170                 assert_eq!(events_2.len(), 1);
6171                 match events_2[0] {
6172                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
6173                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6174                         },
6175                         _ => panic!("Unexpected event"),
6176                 }
6177
6178                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6179                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6180                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6181                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6182
6183                 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
6184                 // rebroadcasting announcement_signatures upon reconnect.
6185
6186                 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();
6187                 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
6188                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
6189         }
6190
6191         #[test]
6192         fn test_drop_messages_peer_disconnect_dual_htlc() {
6193                 // Test that we can handle reconnecting when both sides of a channel have pending
6194                 // commitment_updates when we disconnect.
6195                 let mut nodes = create_network(2);
6196                 create_announced_chan_between_nodes(&nodes, 0, 1);
6197
6198                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6199
6200                 // Now try to send a second payment which will fail to send
6201                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6202                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6203
6204                 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
6205                 check_added_monitors!(nodes[0], 1);
6206
6207                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6208                 assert_eq!(events_1.len(), 1);
6209                 match events_1[0] {
6210                         MessageSendEvent::UpdateHTLCs { .. } => {},
6211                         _ => panic!("Unexpected event"),
6212                 }
6213
6214                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
6215                 check_added_monitors!(nodes[1], 1);
6216
6217                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6218                 assert_eq!(events_2.len(), 1);
6219                 match events_2[0] {
6220                         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 } } => {
6221                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6222                                 assert!(update_add_htlcs.is_empty());
6223                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6224                                 assert!(update_fail_htlcs.is_empty());
6225                                 assert!(update_fail_malformed_htlcs.is_empty());
6226                                 assert!(update_fee.is_none());
6227
6228                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
6229                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
6230                                 assert_eq!(events_3.len(), 1);
6231                                 match events_3[0] {
6232                                         Event::PaymentSent { ref payment_preimage } => {
6233                                                 assert_eq!(*payment_preimage, payment_preimage_1);
6234                                         },
6235                                         _ => panic!("Unexpected event"),
6236                                 }
6237
6238                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
6239                                 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6240                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6241                                 check_added_monitors!(nodes[0], 1);
6242                         },
6243                         _ => panic!("Unexpected event"),
6244                 }
6245
6246                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6247                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6248
6249                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6250                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6251                 assert_eq!(reestablish_1.len(), 1);
6252                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6253                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6254                 assert_eq!(reestablish_2.len(), 1);
6255
6256                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
6257                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6258                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
6259                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6260
6261                 assert!(as_resp.0.is_none());
6262                 assert!(bs_resp.0.is_none());
6263
6264                 assert!(bs_resp.1.is_none());
6265                 assert!(bs_resp.2.is_none());
6266
6267                 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
6268
6269                 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
6270                 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
6271                 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
6272                 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
6273                 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
6274                 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();
6275                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
6276                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6277                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6278                 check_added_monitors!(nodes[1], 1);
6279
6280                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
6281                 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6282                 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
6283                 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
6284                 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
6285                 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
6286                 assert!(bs_second_commitment_signed.update_fee.is_none());
6287                 check_added_monitors!(nodes[1], 1);
6288
6289                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6290                 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6291                 assert!(as_commitment_signed.update_add_htlcs.is_empty());
6292                 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
6293                 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
6294                 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
6295                 assert!(as_commitment_signed.update_fee.is_none());
6296                 check_added_monitors!(nodes[0], 1);
6297
6298                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
6299                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6300                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6301                 check_added_monitors!(nodes[0], 1);
6302
6303                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
6304                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6305                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6306                 check_added_monitors!(nodes[1], 1);
6307
6308                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6309                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6310                 check_added_monitors!(nodes[1], 1);
6311
6312                 let events_4 = nodes[1].node.get_and_clear_pending_events();
6313                 assert_eq!(events_4.len(), 1);
6314                 match events_4[0] {
6315                         Event::PendingHTLCsForwardable { .. } => { },
6316                         _ => panic!("Unexpected event"),
6317                 };
6318
6319                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6320                 nodes[1].node.process_pending_htlc_forwards();
6321
6322                 let events_5 = nodes[1].node.get_and_clear_pending_events();
6323                 assert_eq!(events_5.len(), 1);
6324                 match events_5[0] {
6325                         Event::PaymentReceived { ref payment_hash, amt: _ } => {
6326                                 assert_eq!(payment_hash_2, *payment_hash);
6327                         },
6328                         _ => panic!("Unexpected event"),
6329                 }
6330
6331                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
6332                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6333                 check_added_monitors!(nodes[0], 1);
6334
6335                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6336         }
6337
6338         #[test]
6339         fn test_simple_monitor_permanent_update_fail() {
6340                 // Test that we handle a simple permanent monitor update failure
6341                 let mut nodes = create_network(2);
6342                 create_announced_chan_between_nodes(&nodes, 0, 1);
6343
6344                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6345                 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6346
6347                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
6348                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
6349                 check_added_monitors!(nodes[0], 1);
6350
6351                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6352                 assert_eq!(events_1.len(), 1);
6353                 match events_1[0] {
6354                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6355                         _ => panic!("Unexpected event"),
6356                 };
6357
6358                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
6359                 // PaymentFailed event
6360
6361                 assert_eq!(nodes[0].node.list_channels().len(), 0);
6362         }
6363
6364         fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
6365                 // Test that we can recover from a simple temporary monitor update failure optionally with
6366                 // a disconnect in between
6367                 let mut nodes = create_network(2);
6368                 create_announced_chan_between_nodes(&nodes, 0, 1);
6369
6370                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6371                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6372
6373                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
6374                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
6375                 check_added_monitors!(nodes[0], 1);
6376
6377                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6378                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6379                 assert_eq!(nodes[0].node.list_channels().len(), 1);
6380
6381                 if disconnect {
6382                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6383                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6384                         reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6385                 }
6386
6387                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
6388                 nodes[0].node.test_restore_channel_monitor();
6389                 check_added_monitors!(nodes[0], 1);
6390
6391                 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
6392                 assert_eq!(events_2.len(), 1);
6393                 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
6394                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
6395                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6396                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6397
6398                 expect_pending_htlcs_forwardable!(nodes[1]);
6399
6400                 let events_3 = nodes[1].node.get_and_clear_pending_events();
6401                 assert_eq!(events_3.len(), 1);
6402                 match events_3[0] {
6403                         Event::PaymentReceived { ref payment_hash, amt } => {
6404                                 assert_eq!(payment_hash_1, *payment_hash);
6405                                 assert_eq!(amt, 1000000);
6406                         },
6407                         _ => panic!("Unexpected event"),
6408                 }
6409
6410                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
6411
6412                 // Now set it to failed again...
6413                 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6414                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
6415                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
6416                 check_added_monitors!(nodes[0], 1);
6417
6418                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6419                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6420                 assert_eq!(nodes[0].node.list_channels().len(), 1);
6421
6422                 if disconnect {
6423                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6424                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6425                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6426                 }
6427
6428                 // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
6429                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
6430                 nodes[0].node.test_restore_channel_monitor();
6431                 check_added_monitors!(nodes[0], 1);
6432
6433                 let events_5 = nodes[0].node.get_and_clear_pending_msg_events();
6434                 assert_eq!(events_5.len(), 1);
6435                 match events_5[0] {
6436                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6437                         _ => panic!("Unexpected event"),
6438                 }
6439
6440                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
6441                 // PaymentFailed event
6442
6443                 assert_eq!(nodes[0].node.list_channels().len(), 0);
6444         }
6445
6446         #[test]
6447         fn test_simple_monitor_temporary_update_fail() {
6448                 do_test_simple_monitor_temporary_update_fail(false);
6449                 do_test_simple_monitor_temporary_update_fail(true);
6450         }
6451
6452         fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
6453                 let disconnect_flags = 8 | 16;
6454
6455                 // Test that we can recover from a temporary monitor update failure with some in-flight
6456                 // HTLCs going on at the same time potentially with some disconnection thrown in.
6457                 // * First we route a payment, then get a temporary monitor update failure when trying to
6458                 //   route a second payment. We then claim the first payment.
6459                 // * If disconnect_count is set, we will disconnect at this point (which is likely as
6460                 //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
6461                 //   the ChannelMonitor on a watchtower).
6462                 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
6463                 //   immediately, otherwise we wait sconnect and deliver them via the reconnect
6464                 //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
6465                 //   disconnect_count & !disconnect_flags is 0).
6466                 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
6467                 //   through message sending, potentially disconnect/reconnecting multiple times based on
6468                 //   disconnect_count, to get the update_fulfill_htlc through.
6469                 // * We then walk through more message exchanges to get the original update_add_htlc
6470                 //   through, swapping message ordering based on disconnect_count & 8 and optionally
6471                 //   disconnect/reconnecting based on disconnect_count.
6472                 let mut nodes = create_network(2);
6473                 create_announced_chan_between_nodes(&nodes, 0, 1);
6474
6475                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6476
6477                 // Now try to send a second payment which will fail to send
6478                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6479                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6480
6481                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
6482                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
6483                 check_added_monitors!(nodes[0], 1);
6484
6485                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6486                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6487                 assert_eq!(nodes[0].node.list_channels().len(), 1);
6488
6489                 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
6490                 // but nodes[0] won't respond since it is frozen.
6491                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
6492                 check_added_monitors!(nodes[1], 1);
6493                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6494                 assert_eq!(events_2.len(), 1);
6495                 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
6496                         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 } } => {
6497                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6498                                 assert!(update_add_htlcs.is_empty());
6499                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6500                                 assert!(update_fail_htlcs.is_empty());
6501                                 assert!(update_fail_malformed_htlcs.is_empty());
6502                                 assert!(update_fee.is_none());
6503
6504                                 if (disconnect_count & 16) == 0 {
6505                                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
6506                                         let events_3 = nodes[0].node.get_and_clear_pending_events();
6507                                         assert_eq!(events_3.len(), 1);
6508                                         match events_3[0] {
6509                                                 Event::PaymentSent { ref payment_preimage } => {
6510                                                         assert_eq!(*payment_preimage, payment_preimage_1);
6511                                                 },
6512                                                 _ => panic!("Unexpected event"),
6513                                         }
6514
6515                                         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::IgnoreError) }) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed) {
6516                                                 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
6517                                         } else { panic!(); }
6518                                 }
6519
6520                                 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
6521                         },
6522                         _ => panic!("Unexpected event"),
6523                 };
6524
6525                 if disconnect_count & !disconnect_flags > 0 {
6526                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6527                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6528                 }
6529
6530                 // Now fix monitor updating...
6531                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
6532                 nodes[0].node.test_restore_channel_monitor();
6533                 check_added_monitors!(nodes[0], 1);
6534
6535                 macro_rules! disconnect_reconnect_peers { () => { {
6536                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6537                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6538
6539                         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6540                         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6541                         assert_eq!(reestablish_1.len(), 1);
6542                         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6543                         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6544                         assert_eq!(reestablish_2.len(), 1);
6545
6546                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
6547                         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6548                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
6549                         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6550
6551                         assert!(as_resp.0.is_none());
6552                         assert!(bs_resp.0.is_none());
6553
6554                         (reestablish_1, reestablish_2, as_resp, bs_resp)
6555                 } } }
6556
6557                 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
6558                         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6559                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6560
6561                         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6562                         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6563                         assert_eq!(reestablish_1.len(), 1);
6564                         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6565                         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6566                         assert_eq!(reestablish_2.len(), 1);
6567
6568                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
6569                         check_added_monitors!(nodes[0], 0);
6570                         let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6571                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
6572                         check_added_monitors!(nodes[1], 0);
6573                         let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6574
6575                         assert!(as_resp.0.is_none());
6576                         assert!(bs_resp.0.is_none());
6577
6578                         assert!(bs_resp.1.is_none());
6579                         if (disconnect_count & 16) == 0 {
6580                                 assert!(bs_resp.2.is_none());
6581
6582                                 assert!(as_resp.1.is_some());
6583                                 assert!(as_resp.2.is_some());
6584                                 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
6585                         } else {
6586                                 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
6587                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
6588                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
6589                                 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
6590                                 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
6591                                 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
6592
6593                                 assert!(as_resp.1.is_none());
6594
6595                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]).unwrap();
6596                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
6597                                 assert_eq!(events_3.len(), 1);
6598                                 match events_3[0] {
6599                                         Event::PaymentSent { ref payment_preimage } => {
6600                                                 assert_eq!(*payment_preimage, payment_preimage_1);
6601                                         },
6602                                         _ => panic!("Unexpected event"),
6603                                 }
6604
6605                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
6606                                 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6607                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6608                                 check_added_monitors!(nodes[0], 1);
6609
6610                                 as_resp.1 = Some(as_resp_raa);
6611                                 bs_resp.2 = None;
6612                         }
6613
6614                         if disconnect_count & !disconnect_flags > 1 {
6615                                 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
6616
6617                                 if (disconnect_count & 16) == 0 {
6618                                         assert!(reestablish_1 == second_reestablish_1);
6619                                         assert!(reestablish_2 == second_reestablish_2);
6620                                 }
6621                                 assert!(as_resp == second_as_resp);
6622                                 assert!(bs_resp == second_bs_resp);
6623                         }
6624
6625                         (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
6626                 } else {
6627                         let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
6628                         assert_eq!(events_4.len(), 2);
6629                         (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
6630                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6631                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6632                                         msg.clone()
6633                                 },
6634                                 _ => panic!("Unexpected event"),
6635                         })
6636                 };
6637
6638                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
6639
6640                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6641                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6642                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6643                 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
6644                 check_added_monitors!(nodes[1], 1);
6645
6646                 if disconnect_count & !disconnect_flags > 2 {
6647                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6648
6649                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
6650                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
6651
6652                         assert!(as_resp.2.is_none());
6653                         assert!(bs_resp.2.is_none());
6654                 }
6655
6656                 let as_commitment_update;
6657                 let bs_second_commitment_update;
6658
6659                 macro_rules! handle_bs_raa { () => {
6660                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6661                         as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6662                         assert!(as_commitment_update.update_add_htlcs.is_empty());
6663                         assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
6664                         assert!(as_commitment_update.update_fail_htlcs.is_empty());
6665                         assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
6666                         assert!(as_commitment_update.update_fee.is_none());
6667                         check_added_monitors!(nodes[0], 1);
6668                 } }
6669
6670                 macro_rules! handle_initial_raa { () => {
6671                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
6672                         bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6673                         assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
6674                         assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
6675                         assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
6676                         assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
6677                         assert!(bs_second_commitment_update.update_fee.is_none());
6678                         check_added_monitors!(nodes[1], 1);
6679                 } }
6680
6681                 if (disconnect_count & 8) == 0 {
6682                         handle_bs_raa!();
6683
6684                         if disconnect_count & !disconnect_flags > 3 {
6685                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6686
6687                                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
6688                                 assert!(bs_resp.1.is_none());
6689
6690                                 assert!(as_resp.2.unwrap() == as_commitment_update);
6691                                 assert!(bs_resp.2.is_none());
6692
6693                                 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
6694                         }
6695
6696                         handle_initial_raa!();
6697
6698                         if disconnect_count & !disconnect_flags > 4 {
6699                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6700
6701                                 assert!(as_resp.1.is_none());
6702                                 assert!(bs_resp.1.is_none());
6703
6704                                 assert!(as_resp.2.unwrap() == as_commitment_update);
6705                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
6706                         }
6707                 } else {
6708                         handle_initial_raa!();
6709
6710                         if disconnect_count & !disconnect_flags > 3 {
6711                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6712
6713                                 assert!(as_resp.1.is_none());
6714                                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
6715
6716                                 assert!(as_resp.2.is_none());
6717                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
6718
6719                                 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
6720                         }
6721
6722                         handle_bs_raa!();
6723
6724                         if disconnect_count & !disconnect_flags > 4 {
6725                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6726
6727                                 assert!(as_resp.1.is_none());
6728                                 assert!(bs_resp.1.is_none());
6729
6730                                 assert!(as_resp.2.unwrap() == as_commitment_update);
6731                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
6732                         }
6733                 }
6734
6735                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
6736                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6737                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6738                 check_added_monitors!(nodes[0], 1);
6739
6740                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
6741                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6742                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6743                 check_added_monitors!(nodes[1], 1);
6744
6745                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6746                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6747                 check_added_monitors!(nodes[1], 1);
6748
6749                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
6750                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6751                 check_added_monitors!(nodes[0], 1);
6752
6753                 expect_pending_htlcs_forwardable!(nodes[1]);
6754
6755                 let events_5 = nodes[1].node.get_and_clear_pending_events();
6756                 assert_eq!(events_5.len(), 1);
6757                 match events_5[0] {
6758                         Event::PaymentReceived { ref payment_hash, amt } => {
6759                                 assert_eq!(payment_hash_2, *payment_hash);
6760                                 assert_eq!(amt, 1000000);
6761                         },
6762                         _ => panic!("Unexpected event"),
6763                 }
6764
6765                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6766         }
6767
6768         #[test]
6769         fn test_monitor_temporary_update_fail_a() {
6770                 do_test_monitor_temporary_update_fail(0);
6771                 do_test_monitor_temporary_update_fail(1);
6772                 do_test_monitor_temporary_update_fail(2);
6773                 do_test_monitor_temporary_update_fail(3);
6774                 do_test_monitor_temporary_update_fail(4);
6775                 do_test_monitor_temporary_update_fail(5);
6776         }
6777
6778         #[test]
6779         fn test_monitor_temporary_update_fail_b() {
6780                 do_test_monitor_temporary_update_fail(2 | 8);
6781                 do_test_monitor_temporary_update_fail(3 | 8);
6782                 do_test_monitor_temporary_update_fail(4 | 8);
6783                 do_test_monitor_temporary_update_fail(5 | 8);
6784         }
6785
6786         #[test]
6787         fn test_monitor_temporary_update_fail_c() {
6788                 do_test_monitor_temporary_update_fail(1 | 16);
6789                 do_test_monitor_temporary_update_fail(2 | 16);
6790                 do_test_monitor_temporary_update_fail(3 | 16);
6791                 do_test_monitor_temporary_update_fail(2 | 8 | 16);
6792                 do_test_monitor_temporary_update_fail(3 | 8 | 16);
6793         }
6794
6795         #[test]
6796         fn test_invalid_channel_announcement() {
6797                 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
6798                 let secp_ctx = Secp256k1::new();
6799                 let nodes = create_network(2);
6800
6801                 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
6802
6803                 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
6804                 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
6805                 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
6806                 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
6807
6808                 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 } );
6809
6810                 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
6811                 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
6812
6813                 let as_network_key = nodes[0].node.get_our_node_id();
6814                 let bs_network_key = nodes[1].node.get_our_node_id();
6815
6816                 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
6817
6818                 let mut chan_announcement;
6819
6820                 macro_rules! dummy_unsigned_msg {
6821                         () => {
6822                                 msgs::UnsignedChannelAnnouncement {
6823                                         features: msgs::GlobalFeatures::new(),
6824                                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
6825                                         short_channel_id: as_chan.get_short_channel_id().unwrap(),
6826                                         node_id_1: if were_node_one { as_network_key } else { bs_network_key },
6827                                         node_id_2: if were_node_one { bs_network_key } else { as_network_key },
6828                                         bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
6829                                         bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
6830                                         excess_data: Vec::new(),
6831                                 };
6832                         }
6833                 }
6834
6835                 macro_rules! sign_msg {
6836                         ($unsigned_msg: expr) => {
6837                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
6838                                 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
6839                                 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
6840                                 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
6841                                 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
6842                                 chan_announcement = msgs::ChannelAnnouncement {
6843                                         node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
6844                                         node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
6845                                         bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
6846                                         bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
6847                                         contents: $unsigned_msg
6848                                 }
6849                         }
6850                 }
6851
6852                 let unsigned_msg = dummy_unsigned_msg!();
6853                 sign_msg!(unsigned_msg);
6854                 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
6855                 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 } );
6856
6857                 // Configured with Network::Testnet
6858                 let mut unsigned_msg = dummy_unsigned_msg!();
6859                 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
6860                 sign_msg!(unsigned_msg);
6861                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
6862
6863                 let mut unsigned_msg = dummy_unsigned_msg!();
6864                 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
6865                 sign_msg!(unsigned_msg);
6866                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
6867         }
6868
6869         struct VecWriter(Vec<u8>);
6870         impl Writer for VecWriter {
6871                 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
6872                         self.0.extend_from_slice(buf);
6873                         Ok(())
6874                 }
6875                 fn size_hint(&mut self, size: usize) {
6876                         self.0.reserve_exact(size);
6877                 }
6878         }
6879
6880         #[test]
6881         fn test_no_txn_manager_serialize_deserialize() {
6882                 let mut nodes = create_network(2);
6883
6884                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
6885
6886                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6887
6888                 let nodes_0_serialized = nodes[0].node.encode();
6889                 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
6890                 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
6891
6892                 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())));
6893                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
6894                 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
6895                 assert!(chan_0_monitor_read.is_empty());
6896
6897                 let mut nodes_0_read = &nodes_0_serialized[..];
6898                 let config = UserConfig::new();
6899                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6900                 let (_, nodes_0_deserialized) = {
6901                         let mut channel_monitors = HashMap::new();
6902                         channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
6903                         <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
6904                                 default_config: config,
6905                                 keys_manager,
6906                                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
6907                                 monitor: nodes[0].chan_monitor.clone(),
6908                                 chain_monitor: nodes[0].chain_monitor.clone(),
6909                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
6910                                 logger: Arc::new(test_utils::TestLogger::new()),
6911                                 channel_monitors: &channel_monitors,
6912                         }).unwrap()
6913                 };
6914                 assert!(nodes_0_read.is_empty());
6915
6916                 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
6917                 nodes[0].node = Arc::new(nodes_0_deserialized);
6918                 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
6919                 nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
6920                 assert_eq!(nodes[0].node.list_channels().len(), 1);
6921                 check_added_monitors!(nodes[0], 1);
6922
6923                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6924                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6925                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6926                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6927
6928                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
6929                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6930                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
6931                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6932
6933                 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
6934                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
6935                 for node in nodes.iter() {
6936                         assert!(node.router.handle_channel_announcement(&announcement).unwrap());
6937                         node.router.handle_channel_update(&as_update).unwrap();
6938                         node.router.handle_channel_update(&bs_update).unwrap();
6939                 }
6940
6941                 send_payment(&nodes[0], &[&nodes[1]], 1000000);
6942         }
6943
6944         #[test]
6945         fn test_simple_manager_serialize_deserialize() {
6946                 let mut nodes = create_network(2);
6947                 create_announced_chan_between_nodes(&nodes, 0, 1);
6948
6949                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6950                 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6951
6952                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6953
6954                 let nodes_0_serialized = nodes[0].node.encode();
6955                 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
6956                 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
6957
6958                 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())));
6959                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
6960                 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
6961                 assert!(chan_0_monitor_read.is_empty());
6962
6963                 let mut nodes_0_read = &nodes_0_serialized[..];
6964                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6965                 let (_, nodes_0_deserialized) = {
6966                         let mut channel_monitors = HashMap::new();
6967                         channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
6968                         <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
6969                                 default_config: UserConfig::new(),
6970                                 keys_manager,
6971                                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
6972                                 monitor: nodes[0].chan_monitor.clone(),
6973                                 chain_monitor: nodes[0].chain_monitor.clone(),
6974                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
6975                                 logger: Arc::new(test_utils::TestLogger::new()),
6976                                 channel_monitors: &channel_monitors,
6977                         }).unwrap()
6978                 };
6979                 assert!(nodes_0_read.is_empty());
6980
6981                 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
6982                 nodes[0].node = Arc::new(nodes_0_deserialized);
6983                 check_added_monitors!(nodes[0], 1);
6984
6985                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6986
6987                 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
6988                 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
6989         }
6990
6991         #[test]
6992         fn test_manager_serialize_deserialize_inconsistent_monitor() {
6993                 // Test deserializing a ChannelManager with a out-of-date ChannelMonitor
6994                 let mut nodes = create_network(4);
6995                 create_announced_chan_between_nodes(&nodes, 0, 1);
6996                 create_announced_chan_between_nodes(&nodes, 2, 0);
6997                 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
6998
6999                 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
7000
7001                 // Serialize the ChannelManager here, but the monitor we keep up-to-date
7002                 let nodes_0_serialized = nodes[0].node.encode();
7003
7004                 route_payment(&nodes[0], &[&nodes[3]], 1000000);
7005                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7006                 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7007                 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7008
7009                 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
7010                 // nodes[3])
7011                 let mut node_0_monitors_serialized = Vec::new();
7012                 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
7013                         let mut writer = VecWriter(Vec::new());
7014                         monitor.1.write_for_disk(&mut writer).unwrap();
7015                         node_0_monitors_serialized.push(writer.0);
7016                 }
7017
7018                 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())));
7019                 let mut node_0_monitors = Vec::new();
7020                 for serialized in node_0_monitors_serialized.iter() {
7021                         let mut read = &serialized[..];
7022                         let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
7023                         assert!(read.is_empty());
7024                         node_0_monitors.push(monitor);
7025                 }
7026
7027                 let mut nodes_0_read = &nodes_0_serialized[..];
7028                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
7029                 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
7030                         default_config: UserConfig::new(),
7031                         keys_manager,
7032                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
7033                         monitor: nodes[0].chan_monitor.clone(),
7034                         chain_monitor: nodes[0].chain_monitor.clone(),
7035                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
7036                         logger: Arc::new(test_utils::TestLogger::new()),
7037                         channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
7038                 }).unwrap();
7039                 assert!(nodes_0_read.is_empty());
7040
7041                 { // Channel close should result in a commitment tx and an HTLC tx
7042                         let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7043                         assert_eq!(txn.len(), 2);
7044                         assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
7045                         assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
7046                 }
7047
7048                 for monitor in node_0_monitors.drain(..) {
7049                         assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
7050                         check_added_monitors!(nodes[0], 1);
7051                 }
7052                 nodes[0].node = Arc::new(nodes_0_deserialized);
7053
7054                 // nodes[1] and nodes[2] have no lost state with nodes[0]...
7055                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7056                 reconnect_nodes(&nodes[0], &nodes[2], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7057                 //... and we can even still claim the payment!
7058                 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
7059
7060                 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
7061                 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7062                 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
7063                 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) {
7064                         assert_eq!(msg.channel_id, channel_id);
7065                 } else { panic!("Unexpected result"); }
7066         }
7067 }