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