_ 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, ChannelKeys};
  26 use ln::channelmonitor::{ManyChannelMonitor, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS};
  27 use ln::router::{Route,RouteHop};
  28 use ln::msgs;
  29 use ln::msgs::{ChannelMessageHandler, HandleError, RAACommitmentOrder};
  30 use util::{byte_utils, events, internal_traits, rng};
  31 use util::sha2::Sha256;
  32 use util::ser::{Readable, Writeable};
  33 use util::chacha20poly1305rfc::ChaCha20;
  34 use util::logger::Logger;
  35 use util::errors::APIError;
  36
  37 use crypto;
  38 use crypto::mac::{Mac,MacResult};
  39 use crypto::hmac::Hmac;
  40 use crypto::digest::Digest;
  41 use crypto::symmetriccipher::SynchronousStreamCipher;
  42
  43 use std::{ptr, mem};
  44 use std::collections::HashMap;
  45 use std::collections::hash_map;
  46 use std::io::Cursor;
  47 use std::sync::{Mutex,MutexGuard,Arc};
  48 use std::sync::atomic::{AtomicUsize, Ordering};
  49 use std::time::{Instant,Duration};
  50
  51 /// We hold various information about HTLC relay in the HTLC objects in Channel itself:
  52 ///
  53 /// Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
  54 /// forward the HTLC with information it will give back to us when it does so, or if it should Fail
  55 /// the HTLC with the relevant message for the Channel to handle giving to the remote peer.
  56 ///
  57 /// When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo
  58 /// which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData
  59 /// filled in to indicate where it came from (which we can use to either fail-backwards or fulfill
  60 /// the HTLC backwards along the relevant path).
  61 /// Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
  62 /// our payment, which we can use to decode errors or inform the user that the payment was sent.
  63 mod channel_held_info {
  64         use ln::msgs;
  65         use ln::router::Route;
  66         use secp256k1::key::SecretKey;
  67         use secp256k1::ecdh::SharedSecret;
  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: SharedSecret,
  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: SharedSecret,
  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 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
 225 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
 226 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
 227 /// probably increase this significantly.
 228 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
 229
 230 struct HTLCForwardInfo {
 231         prev_short_channel_id: u64,
 232         prev_htlc_id: u64,
 233         forward_info: PendingForwardHTLCInfo,
 234 }
 235
 236 struct ChannelHolder {
 237         by_id: HashMap<[u8; 32], Channel>,
 238         short_to_id: HashMap<u64, [u8; 32]>,
 239         next_forward: Instant,
 240         /// short channel id -> forward infos. Key of 0 means payments received
 241         /// Note that while this is held in the same mutex as the channels themselves, no consistency
 242         /// guarantees are made about there existing a channel with the short id here, nor the short
 243         /// ids in the PendingForwardHTLCInfo!
 244         forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
 245         /// Note that while this is held in the same mutex as the channels themselves, no consistency
 246         /// guarantees are made about the channels given here actually existing anymore by the time you
 247         /// go to read them!
 248         claimable_htlcs: HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
 249 }
 250 struct MutChannelHolder<'a> {
 251         by_id: &'a mut HashMap<[u8; 32], Channel>,
 252         short_to_id: &'a mut HashMap<u64, [u8; 32]>,
 253         next_forward: &'a mut Instant,
 254         forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
 255         claimable_htlcs: &'a mut HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
 256 }
 257 impl ChannelHolder {
 258         fn borrow_parts(&mut self) -> MutChannelHolder {
 259                 MutChannelHolder {
 260                         by_id: &mut self.by_id,
 261                         short_to_id: &mut self.short_to_id,
 262                         next_forward: &mut self.next_forward,
 263                         forward_htlcs: &mut self.forward_htlcs,
 264                         claimable_htlcs: &mut self.claimable_htlcs,
 265                 }
 266         }
 267 }
 268
 269 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
 270 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
 271
 272 /// Manager which keeps track of a number of channels and sends messages to the appropriate
 273 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
 274 ///
 275 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
 276 /// to individual Channels.
 277 pub struct ChannelManager {
 278         genesis_hash: Sha256dHash,
 279         fee_estimator: Arc<FeeEstimator>,
 280         monitor: Arc<ManyChannelMonitor>,
 281         chain_monitor: Arc<ChainWatchInterface>,
 282         tx_broadcaster: Arc<BroadcasterInterface>,
 283
 284         announce_channels_publicly: bool,
 285         fee_proportional_millionths: u32,
 286         latest_block_height: AtomicUsize,
 287         secp_ctx: Secp256k1<secp256k1::All>,
 288
 289         channel_state: Mutex<ChannelHolder>,
 290         our_network_key: SecretKey,
 291
 292         pending_events: Mutex<Vec<events::Event>>,
 293
 294         logger: Arc<Logger>,
 295 }
 296
 297 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
 298 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
 299 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
 300 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
 301 /// CLTV_CLAIM_BUFFER point (we static assert that its at least 3 blocks more).
 302 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
 303 const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
 304
 305 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + 2*HTLC_FAIL_TIMEOUT_BLOCKS, ie that
 306 // if the next-hop peer fails the HTLC within HTLC_FAIL_TIMEOUT_BLOCKS then we'll still have
 307 // HTLC_FAIL_TIMEOUT_BLOCKS left to fail it backwards ourselves before hitting the
 308 // CLTV_CLAIM_BUFFER point and failing the channel on-chain to time out the HTLC.
 309 #[deny(const_err)]
 310 #[allow(dead_code)]
 311 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - 2*HTLC_FAIL_TIMEOUT_BLOCKS - CLTV_CLAIM_BUFFER;
 312
 313 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
 314 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
 315 #[deny(const_err)]
 316 #[allow(dead_code)]
 317 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - HTLC_FAIL_TIMEOUT_BLOCKS - 2*CLTV_CLAIM_BUFFER;
 318
 319 macro_rules! secp_call {
 320         ( $res: expr, $err: expr ) => {
 321                 match $res {
 322                         Ok(key) => key,
 323                         Err(_) => return Err($err),
 324                 }
 325         };
 326 }
 327
 328 struct OnionKeys {
 329         #[cfg(test)]
 330         shared_secret: SharedSecret,
 331         #[cfg(test)]
 332         blinding_factor: [u8; 32],
 333         ephemeral_pubkey: PublicKey,
 334         rho: [u8; 32],
 335         mu: [u8; 32],
 336 }
 337
 338 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
 339 pub struct ChannelDetails {
 340         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
 341         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
 342         /// Note that this means this value is *not* persistent - it can change once during the
 343         /// lifetime of the channel.
 344         pub channel_id: [u8; 32],
 345         /// The position of the funding transaction in the chain. None if the funding transaction has
 346         /// not yet been confirmed and the channel fully opened.
 347         pub short_channel_id: Option<u64>,
 348         /// The node_id of our counterparty
 349         pub remote_network_id: PublicKey,
 350         /// The value, in satoshis, of this channel as appears in the funding output
 351         pub channel_value_satoshis: u64,
 352         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
 353         pub user_id: u64,
 354 }
 355
 356 impl ChannelManager {
 357         /// Constructs a new ChannelManager to hold several channels and route between them.
 358         ///
 359         /// This is the main "logic hub" for all channel-related actions, and implements
 360         /// ChannelMessageHandler.
 361         ///
 362         /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
 363         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
 364         ///
 365         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
 366         pub fn new(our_network_key: SecretKey, fee_proportional_millionths: u32, announce_channels_publicly: bool, network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>) -> Result<Arc<ChannelManager>, secp256k1::Error> {
 367                 let secp_ctx = Secp256k1::new();
 368
 369                 let res = Arc::new(ChannelManager {
 370                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
 371                         fee_estimator: feeest.clone(),
 372                         monitor: monitor.clone(),
 373                         chain_monitor,
 374                         tx_broadcaster,
 375
 376                         announce_channels_publicly,
 377                         fee_proportional_millionths,
 378                         latest_block_height: AtomicUsize::new(0), //TODO: Get an init value (generally need to replay recent chain on chain_monitor registration)
 379                         secp_ctx,
 380
 381                         channel_state: Mutex::new(ChannelHolder{
 382                                 by_id: HashMap::new(),
 383                                 short_to_id: HashMap::new(),
 384                                 next_forward: Instant::now(),
 385                                 forward_htlcs: HashMap::new(),
 386                                 claimable_htlcs: HashMap::new(),
 387                         }),
 388                         our_network_key,
 389
 390                         pending_events: Mutex::new(Vec::new()),
 391
 392                         logger,
 393                 });
 394                 let weak_res = Arc::downgrade(&res);
 395                 res.chain_monitor.register_listener(weak_res);
 396                 Ok(res)
 397         }
 398
 399         /// Creates a new outbound channel to the given remote node and with the given value.
 400         ///
 401         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
 402         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
 403         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
 404         /// may wish to avoid using 0 for user_id here.
 405         ///
 406         /// If successful, will generate a SendOpenChannel event, so you should probably poll
 407         /// PeerManager::process_events afterwards.
 408         ///
 409         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat being greater than channel_value_satoshis * 1k
 410         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
 411                 let chan_keys = if cfg!(feature = "fuzztarget") {
 412                         ChannelKeys {
 413                                 funding_key:               SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
 414                                 revocation_base_key:       SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
 415                                 payment_base_key:          SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
 416                                 delayed_payment_base_key:  SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
 417                                 htlc_base_key:             SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
 418                                 channel_close_key:         SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
 419                                 channel_monitor_claim_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
 420                                 commitment_seed: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
 421                         }
 422                 } else {
 423                         let mut key_seed = [0u8; 32];
 424                         rng::fill_bytes(&mut key_seed);
 425                         match ChannelKeys::new_from_seed(&key_seed) {
 426                                 Ok(key) => key,
 427                                 Err(_) => panic!("RNG is busted!")
 428                         }
 429                 };
 430
 431                 let channel = Channel::new_outbound(&*self.fee_estimator, chan_keys, their_network_key, channel_value_satoshis, push_msat, self.announce_channels_publicly, user_id, Arc::clone(&self.logger))?;
 432                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
 433                 let mut channel_state = self.channel_state.lock().unwrap();
 434                 match channel_state.by_id.entry(channel.channel_id()) {
 435                         hash_map::Entry::Occupied(_) => {
 436                                 if cfg!(feature = "fuzztarget") {
 437                                         return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
 438                                 } else {
 439                                         panic!("RNG is bad???");
 440                                 }
 441                         },
 442                         hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
 443                 }
 444
 445                 let mut events = self.pending_events.lock().unwrap();
 446                 events.push(events::Event::SendOpenChannel {
 447                         node_id: their_network_key,
 448                         msg: res,
 449                 });
 450                 Ok(())
 451         }
 452
 453         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
 454         /// more information.
 455         pub fn list_channels(&self) -> Vec<ChannelDetails> {
 456                 let channel_state = self.channel_state.lock().unwrap();
 457                 let mut res = Vec::with_capacity(channel_state.by_id.len());
 458                 for (channel_id, channel) in channel_state.by_id.iter() {
 459                         res.push(ChannelDetails {
 460                                 channel_id: (*channel_id).clone(),
 461                                 short_channel_id: channel.get_short_channel_id(),
 462                                 remote_network_id: channel.get_their_node_id(),
 463                                 channel_value_satoshis: channel.get_value_satoshis(),
 464                                 user_id: channel.get_user_id(),
 465                         });
 466                 }
 467                 res
 468         }
 469
 470         /// Gets the list of usable channels, in random order. Useful as an argument to
 471         /// Router::get_route to ensure non-announced channels are used.
 472         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
 473                 let channel_state = self.channel_state.lock().unwrap();
 474                 let mut res = Vec::with_capacity(channel_state.by_id.len());
 475                 for (channel_id, channel) in channel_state.by_id.iter() {
 476                         // Note we use is_live here instead of usable which leads to somewhat confused
 477                         // internal/external nomenclature, but that's ok cause that's probably what the user
 478                         // really wanted anyway.
 479                         if channel.is_live() {
 480                                 res.push(ChannelDetails {
 481                                         channel_id: (*channel_id).clone(),
 482                                         short_channel_id: channel.get_short_channel_id(),
 483                                         remote_network_id: channel.get_their_node_id(),
 484                                         channel_value_satoshis: channel.get_value_satoshis(),
 485                                         user_id: channel.get_user_id(),
 486                                 });
 487                         }
 488                 }
 489                 res
 490         }
 491
 492         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
 493         /// will be accepted on the given channel, and after additional timeout/the closing of all
 494         /// pending HTLCs, the channel will be closed on chain.
 495         ///
 496         /// May generate a SendShutdown event on success, which should be relayed.
 497         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
 498                 let (mut res, node_id, chan_option) = {
 499                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 500                         let channel_state = channel_state_lock.borrow_parts();
 501                         match channel_state.by_id.entry(channel_id.clone()) {
 502                                 hash_map::Entry::Occupied(mut chan_entry) => {
 503                                         let res = chan_entry.get_mut().get_shutdown()?;
 504                                         if chan_entry.get().is_shutdown() {
 505                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
 506                                                         channel_state.short_to_id.remove(&short_id);
 507                                                 }
 508                                                 (res, chan_entry.get().get_their_node_id(), Some(chan_entry.remove_entry().1))
 509                                         } else { (res, chan_entry.get().get_their_node_id(), None) }
 510                                 },
 511                                 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
 512                         }
 513                 };
 514                 for htlc_source in res.1.drain(..) {
 515                         // unknown_next_peer...I dunno who that is anymore....
 516                         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() });
 517                 }
 518                 let chan_update = if let Some(chan) = chan_option {
 519                         if let Ok(update) = self.get_channel_update(&chan) {
 520                                 Some(update)
 521                         } else { None }
 522                 } else { None };
 523
 524                 let mut events = self.pending_events.lock().unwrap();
 525                 if let Some(update) = chan_update {
 526                         events.push(events::Event::BroadcastChannelUpdate {
 527                                 msg: update
 528                         });
 529                 }
 530                 events.push(events::Event::SendShutdown {
 531                         node_id,
 532                         msg: res.0
 533                 });
 534
 535                 Ok(())
 536         }
 537
 538         #[inline]
 539         fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>)) {
 540                 let (local_txn, mut failed_htlcs) = shutdown_res;
 541                 for htlc_source in failed_htlcs.drain(..) {
 542                         // unknown_next_peer...I dunno who that is anymore....
 543                         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() });
 544                 }
 545                 for tx in local_txn {
 546                         self.tx_broadcaster.broadcast_transaction(&tx);
 547                 }
 548                 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
 549                 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
 550                 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
 551                 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
 552                 //timeouts are hit and our claims confirm).
 553                 //TODO: In any case, we need to make sure we remove any pending htlc tracking (via
 554                 //fail_backwards or claim_funds) eventually for all HTLCs that were in the channel
 555         }
 556
 557         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
 558         /// the chain and rejecting new HTLCs on the given channel.
 559         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
 560                 let mut chan = {
 561                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 562                         let channel_state = channel_state_lock.borrow_parts();
 563                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
 564                                 if let Some(short_id) = chan.get_short_channel_id() {
 565                                         channel_state.short_to_id.remove(&short_id);
 566                                 }
 567                                 chan
 568                         } else {
 569                                 return;
 570                         }
 571                 };
 572                 self.finish_force_close_channel(chan.force_shutdown());
 573                 let mut events = self.pending_events.lock().unwrap();
 574                 if let Ok(update) = self.get_channel_update(&chan) {
 575                         events.push(events::Event::BroadcastChannelUpdate {
 576                                 msg: update
 577                         });
 578                 }
 579         }
 580
 581         /// Force close all channels, immediately broadcasting the latest local commitment transaction
 582         /// for each to the chain and rejecting new HTLCs on each.
 583         pub fn force_close_all_channels(&self) {
 584                 for chan in self.list_channels() {
 585                         self.force_close_channel(&chan.channel_id);
 586                 }
 587         }
 588
 589         #[inline]
 590         fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
 591                 ({
 592                         let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
 593                         hmac.input(&shared_secret[..]);
 594                         let mut res = [0; 32];
 595                         hmac.raw_result(&mut res);
 596                         res
 597                 },
 598                 {
 599                         let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
 600                         hmac.input(&shared_secret[..]);
 601                         let mut res = [0; 32];
 602                         hmac.raw_result(&mut res);
 603                         res
 604                 })
 605         }
 606
 607         #[inline]
 608         fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
 609                 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
 610                 hmac.input(&shared_secret[..]);
 611                 let mut res = [0; 32];
 612                 hmac.raw_result(&mut res);
 613                 res
 614         }
 615
 616         #[inline]
 617         fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
 618                 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
 619                 hmac.input(&shared_secret[..]);
 620                 let mut res = [0; 32];
 621                 hmac.raw_result(&mut res);
 622                 res
 623         }
 624
 625         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 626         #[inline]
 627         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> {
 628                 let mut blinded_priv = session_priv.clone();
 629                 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 630
 631                 for hop in route.hops.iter() {
 632                         let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
 633
 634                         let mut sha = Sha256::new();
 635                         sha.input(&blinded_pub.serialize()[..]);
 636                         sha.input(&shared_secret[..]);
 637                         let mut blinding_factor = [0u8; 32];
 638                         sha.result(&mut blinding_factor);
 639
 640                         let ephemeral_pubkey = blinded_pub;
 641
 642                         blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
 643                         blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 644
 645                         callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
 646                 }
 647
 648                 Ok(())
 649         }
 650
 651         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 652         fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
 653                 let mut res = Vec::with_capacity(route.hops.len());
 654
 655                 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
 656                         let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
 657
 658                         res.push(OnionKeys {
 659                                 #[cfg(test)]
 660                                 shared_secret,
 661                                 #[cfg(test)]
 662                                 blinding_factor: _blinding_factor,
 663                                 ephemeral_pubkey,
 664                                 rho,
 665                                 mu,
 666                         });
 667                 })?;
 668
 669                 Ok(res)
 670         }
 671
 672         /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
 673         fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
 674                 let mut cur_value_msat = 0u64;
 675                 let mut cur_cltv = starting_htlc_offset;
 676                 let mut last_short_channel_id = 0;
 677                 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
 678                 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
 679                 unsafe { res.set_len(route.hops.len()); }
 680
 681                 for (idx, hop) in route.hops.iter().enumerate().rev() {
 682                         // First hop gets special values so that it can check, on receipt, that everything is
 683                         // exactly as it should be (and the next hop isn't trying to probe to find out if we're
 684                         // the intended recipient).
 685                         let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
 686                         let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
 687                         res[idx] = msgs::OnionHopData {
 688                                 realm: 0,
 689                                 data: msgs::OnionRealm0HopData {
 690                                         short_channel_id: last_short_channel_id,
 691                                         amt_to_forward: value_msat,
 692                                         outgoing_cltv_value: cltv,
 693                                 },
 694                                 hmac: [0; 32],
 695                         };
 696                         cur_value_msat += hop.fee_msat;
 697                         if cur_value_msat >= 21000000 * 100000000 * 1000 {
 698                                 return Err(APIError::RouteError{err: "Channel fees overflowed?!"});
 699                         }
 700                         cur_cltv += hop.cltv_expiry_delta as u32;
 701                         if cur_cltv >= 500000000 {
 702                                 return Err(APIError::RouteError{err: "Channel CLTV overflowed?!"});
 703                         }
 704                         last_short_channel_id = hop.short_channel_id;
 705                 }
 706                 Ok((res, cur_value_msat, cur_cltv))
 707         }
 708
 709         #[inline]
 710         fn shift_arr_right(arr: &mut [u8; 20*65]) {
 711                 unsafe {
 712                         ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
 713                 }
 714                 for i in 0..65 {
 715                         arr[i] = 0;
 716                 }
 717         }
 718
 719         #[inline]
 720         fn xor_bufs(dst: &mut[u8], src: &[u8]) {
 721                 assert_eq!(dst.len(), src.len());
 722
 723                 for i in 0..dst.len() {
 724                         dst[i] ^= src[i];
 725                 }
 726         }
 727
 728         const ZERO:[u8; 21*65] = [0; 21*65];
 729         fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> msgs::OnionPacket {
 730                 let mut buf = Vec::with_capacity(21*65);
 731                 buf.resize(21*65, 0);
 732
 733                 let filler = {
 734                         let iters = payloads.len() - 1;
 735                         let end_len = iters * 65;
 736                         let mut res = Vec::with_capacity(end_len);
 737                         res.resize(end_len, 0);
 738
 739                         for (i, keys) in onion_keys.iter().enumerate() {
 740                                 if i == payloads.len() - 1 { continue; }
 741                                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 742                                 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
 743                                 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
 744                         }
 745                         res
 746                 };
 747
 748                 let mut packet_data = [0; 20*65];
 749                 let mut hmac_res = [0; 32];
 750
 751                 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
 752                         ChannelManager::shift_arr_right(&mut packet_data);
 753                         payload.hmac = hmac_res;
 754                         packet_data[0..65].copy_from_slice(&payload.encode()[..]);
 755
 756                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 757                         chacha.process(&packet_data, &mut buf[0..20*65]);
 758                         packet_data[..].copy_from_slice(&buf[0..20*65]);
 759
 760                         if i == 0 {
 761                                 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
 762                         }
 763
 764                         let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
 765                         hmac.input(&packet_data);
 766                         hmac.input(&associated_data[..]);
 767                         hmac.raw_result(&mut hmac_res);
 768                 }
 769
 770                 msgs::OnionPacket{
 771                         version: 0,
 772                         public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
 773                         hop_data: packet_data,
 774                         hmac: hmac_res,
 775                 }
 776         }
 777
 778         /// Encrypts a failure packet. raw_packet can either be a
 779         /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
 780         fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
 781                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
 782
 783                 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
 784                 packet_crypted.resize(raw_packet.len(), 0);
 785                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
 786                 chacha.process(&raw_packet, &mut packet_crypted[..]);
 787                 msgs::OnionErrorPacket {
 788                         data: packet_crypted,
 789                 }
 790         }
 791
 792         fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
 793                 assert!(failure_data.len() <= 256 - 2);
 794
 795                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
 796
 797                 let failuremsg = {
 798                         let mut res = Vec::with_capacity(2 + failure_data.len());
 799                         res.push(((failure_type >> 8) & 0xff) as u8);
 800                         res.push(((failure_type >> 0) & 0xff) as u8);
 801                         res.extend_from_slice(&failure_data[..]);
 802                         res
 803                 };
 804                 let pad = {
 805                         let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
 806                         res.resize(256 - 2 - failure_data.len(), 0);
 807                         res
 808                 };
 809                 let mut packet = msgs::DecodedOnionErrorPacket {
 810                         hmac: [0; 32],
 811                         failuremsg: failuremsg,
 812                         pad: pad,
 813                 };
 814
 815                 let mut hmac = Hmac::new(Sha256::new(), &um);
 816                 hmac.input(&packet.encode()[32..]);
 817                 hmac.raw_result(&mut packet.hmac);
 818
 819                 packet
 820         }
 821
 822         #[inline]
 823         fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
 824                 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
 825                 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
 826         }
 827
 828         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
 829                 macro_rules! get_onion_hash {
 830                         () => {
 831                                 {
 832                                         let mut sha = Sha256::new();
 833                                         sha.input(&msg.onion_routing_packet.hop_data);
 834                                         let mut onion_hash = [0; 32];
 835                                         sha.result(&mut onion_hash);
 836                                         onion_hash
 837                                 }
 838                         }
 839                 }
 840
 841                 if let Err(_) = msg.onion_routing_packet.public_key {
 842                         log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
 843                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
 844                                 channel_id: msg.channel_id,
 845                                 htlc_id: msg.htlc_id,
 846                                 sha256_of_onion: get_onion_hash!(),
 847                                 failure_code: 0x8000 | 0x4000 | 6,
 848                         })), self.channel_state.lock().unwrap());
 849                 }
 850
 851                 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key);
 852                 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
 853
 854                 let mut channel_state = None;
 855                 macro_rules! return_err {
 856                         ($msg: expr, $err_code: expr, $data: expr) => {
 857                                 {
 858                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
 859                                         if channel_state.is_none() {
 860                                                 channel_state = Some(self.channel_state.lock().unwrap());
 861                                         }
 862                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 863                                                 channel_id: msg.channel_id,
 864                                                 htlc_id: msg.htlc_id,
 865                                                 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
 866                                         })), channel_state.unwrap());
 867                                 }
 868                         }
 869                 }
 870
 871                 if msg.onion_routing_packet.version != 0 {
 872                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
 873                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
 874                         //the hash doesn't really serve any purpuse - in the case of hashing all data, the
 875                         //receiving node would have to brute force to figure out which version was put in the
 876                         //packet by the node that send us the message, in the case of hashing the hop_data, the
 877                         //node knows the HMAC matched, so they already know what is there...
 878                         return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
 879                 }
 880
 881                 let mut hmac = Hmac::new(Sha256::new(), &mu);
 882                 hmac.input(&msg.onion_routing_packet.hop_data);
 883                 hmac.input(&msg.payment_hash);
 884                 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
 885                         return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
 886                 }
 887
 888                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
 889                 let next_hop_data = {
 890                         let mut decoded = [0; 65];
 891                         chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
 892                         match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
 893                                 Err(err) => {
 894                                         let error_code = match err {
 895                                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
 896                                                 _ => 0x2000 | 2, // Should never happen
 897                                         };
 898                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
 899                                 },
 900                                 Ok(msg) => msg
 901                         }
 902                 };
 903
 904                 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
 905                                 // OUR PAYMENT!
 906                                 // final_expiry_too_soon
 907                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS) as u64 {
 908                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
 909                                 }
 910                                 // final_incorrect_htlc_amount
 911                                 if next_hop_data.data.amt_to_forward > msg.amount_msat {
 912                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
 913                                 }
 914                                 // final_incorrect_cltv_expiry
 915                                 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
 916                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
 917                                 }
 918
 919                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
 920                                 // message, however that would leak that we are the recipient of this payment, so
 921                                 // instead we stay symmetric with the forwarding case, only responding (after a
 922                                 // delay) once they've send us a commitment_signed!
 923
 924                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
 925                                         onion_packet: None,
 926                                         payment_hash: msg.payment_hash.clone(),
 927                                         short_channel_id: 0,
 928                                         incoming_shared_secret: shared_secret.clone(),
 929                                         amt_to_forward: next_hop_data.data.amt_to_forward,
 930                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
 931                                 })
 932                         } else {
 933                                 let mut new_packet_data = [0; 20*65];
 934                                 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
 935                                 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
 936
 937                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
 938
 939                                 let blinding_factor = {
 940                                         let mut sha = Sha256::new();
 941                                         sha.input(&new_pubkey.serialize()[..]);
 942                                         sha.input(&shared_secret[..]);
 943                                         let mut res = [0u8; 32];
 944                                         sha.result(&mut res);
 945                                         match SecretKey::from_slice(&self.secp_ctx, &res) {
 946                                                 Err(_) => {
 947                                                         return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
 948                                                 },
 949                                                 Ok(key) => key
 950                                         }
 951                                 };
 952
 953                                 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
 954                                         return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
 955                                 }
 956
 957                                 let outgoing_packet = msgs::OnionPacket {
 958                                         version: 0,
 959                                         public_key: Ok(new_pubkey),
 960                                         hop_data: new_packet_data,
 961                                         hmac: next_hop_data.hmac.clone(),
 962                                 };
 963
 964                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
 965                                         onion_packet: Some(outgoing_packet),
 966                                         payment_hash: msg.payment_hash.clone(),
 967                                         short_channel_id: next_hop_data.data.short_channel_id,
 968                                         incoming_shared_secret: shared_secret.clone(),
 969                                         amt_to_forward: next_hop_data.data.amt_to_forward,
 970                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
 971                                 })
 972                         };
 973
 974                 channel_state = Some(self.channel_state.lock().unwrap());
 975                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
 976                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
 977                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
 978                                 let forwarding_id = match id_option {
 979                                         None => { // unknown_next_peer
 980                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
 981                                         },
 982                                         Some(id) => id.clone(),
 983                                 };
 984                                 if let Some((err, code, chan_update)) = loop {
 985                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
 986
 987                                         if !chan.is_live() { // channel_disabled
 988                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
 989                                         }
 990                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
 991                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
 992                                         }
 993                                         let fee = amt_to_forward.checked_mul(self.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) });
 994                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
 995                                                 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())));
 996                                         }
 997                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
 998                                                 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())));
 999                                         }
1000                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1001                                         // We want to have at least HTLC_FAIL_TIMEOUT_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1002                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS as u32 { // expiry_too_soon
1003                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1004                                         }
1005                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1006                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1007                                         }
1008                                         break None;
1009                                 }
1010                                 {
1011                                         let mut res = Vec::with_capacity(8 + 128);
1012                                         if code == 0x1000 | 11 || code == 0x1000 | 12 {
1013                                                 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1014                                         }
1015                                         else if code == 0x1000 | 13 {
1016                                                 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1017                                         }
1018                                         if let Some(chan_update) = chan_update {
1019                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1020                                         }
1021                                         return_err!(err, code, &res[..]);
1022                                 }
1023                         }
1024                 }
1025
1026                 (pending_forward_info, channel_state.unwrap())
1027         }
1028
1029         /// only fails if the channel does not yet have an assigned short_id
1030         fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
1031                 let short_channel_id = match chan.get_short_channel_id() {
1032                         None => return Err(HandleError{err: "Channel not yet established", action: None}),
1033                         Some(id) => id,
1034                 };
1035
1036                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1037
1038                 let unsigned = msgs::UnsignedChannelUpdate {
1039                         chain_hash: self.genesis_hash,
1040                         short_channel_id: short_channel_id,
1041                         timestamp: chan.get_channel_update_count(),
1042                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1043                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1044                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1045                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1046                         fee_proportional_millionths: self.fee_proportional_millionths,
1047                         excess_data: Vec::new(),
1048                 };
1049
1050                 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
1051                 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key);
1052
1053                 Ok(msgs::ChannelUpdate {
1054                         signature: sig,
1055                         contents: unsigned
1056                 })
1057         }
1058
1059         /// Sends a payment along a given route.
1060         ///
1061         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1062         /// fields for more info.
1063         ///
1064         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1065         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1066         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1067         /// specified in the last hop in the route! Thus, you should probably do your own
1068         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1069         /// payment") and prevent double-sends yourself.
1070         ///
1071         /// May generate a SendHTLCs event on success, which should be relayed.
1072         ///
1073         /// Raises APIError::RoutError when invalid route or forward parameter
1074         /// (cltv_delta, fee, node public key) is specified
1075         pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), APIError> {
1076                 if route.hops.len() < 1 || route.hops.len() > 20 {
1077                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1078                 }
1079                 let our_node_id = self.get_our_node_id();
1080                 for (idx, hop) in route.hops.iter().enumerate() {
1081                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1082                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1083                         }
1084                 }
1085
1086                 let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
1087                         let mut session_key = [0; 32];
1088                         rng::fill_bytes(&mut session_key);
1089                         session_key
1090                 }).expect("RNG is bad!");
1091
1092                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1093
1094                 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1095                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1096                 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
1097                 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1098
1099                 let (first_hop_node_id, update_add, commitment_signed) = {
1100                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1101                         let channel_state = channel_state_lock.borrow_parts();
1102
1103                         let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1104                                 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1105                                 Some(id) => id.clone(),
1106                         };
1107
1108                         let res = {
1109                                 let chan = channel_state.by_id.get_mut(&id).unwrap();
1110                                 if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
1111                                         return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1112                                 }
1113                                 if !chan.is_live() {
1114                                         return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected!"});
1115                                 }
1116                                 match chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1117                                         route: route.clone(),
1118                                         session_priv: session_priv.clone(),
1119                                         first_hop_htlc_msat: htlc_msat,
1120                                 }, onion_packet).map_err(|he| APIError::ChannelUnavailable{err: he.err})? {
1121                                         Some((update_add, commitment_signed, chan_monitor)) => {
1122                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1123                                                         unimplemented!();
1124                                                 }
1125                                                 Some((update_add, commitment_signed))
1126                                         },
1127                                         None => None,
1128                                 }
1129                         };
1130
1131                         let first_hop_node_id = route.hops.first().unwrap().pubkey;
1132
1133                         match res {
1134                                 Some((update_add, commitment_signed)) => {
1135                                         (first_hop_node_id, update_add, commitment_signed)
1136                                 },
1137                                 None => return Ok(()),
1138                         }
1139                 };
1140
1141                 let mut events = self.pending_events.lock().unwrap();
1142                 events.push(events::Event::UpdateHTLCs {
1143                         node_id: first_hop_node_id,
1144                         updates: msgs::CommitmentUpdate {
1145                                 update_add_htlcs: vec![update_add],
1146                                 update_fulfill_htlcs: Vec::new(),
1147                                 update_fail_htlcs: Vec::new(),
1148                                 update_fail_malformed_htlcs: Vec::new(),
1149                                 update_fee: None,
1150                                 commitment_signed,
1151                         },
1152                 });
1153                 Ok(())
1154         }
1155
1156         /// Call this upon creation of a funding transaction for the given channel.
1157         ///
1158         /// Panics if a funding transaction has already been provided for this channel.
1159         ///
1160         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1161         /// be trivially prevented by using unique funding transaction keys per-channel).
1162         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1163                 macro_rules! add_pending_event {
1164                         ($event: expr) => {
1165                                 {
1166                                         let mut pending_events = self.pending_events.lock().unwrap();
1167                                         pending_events.push($event);
1168                                 }
1169                         }
1170                 }
1171
1172                 let (chan, msg, chan_monitor) = {
1173                         let mut channel_state = self.channel_state.lock().unwrap();
1174                         match channel_state.by_id.remove(temporary_channel_id) {
1175                                 Some(mut chan) => {
1176                                         match chan.get_outbound_funding_created(funding_txo) {
1177                                                 Ok(funding_msg) => {
1178                                                         (chan, funding_msg.0, funding_msg.1)
1179                                                 },
1180                                                 Err(e) => {
1181                                                         log_error!(self, "Got bad signatures: {}!", e.err);
1182                                                         mem::drop(channel_state);
1183                                                         add_pending_event!(events::Event::HandleError {
1184                                                                 node_id: chan.get_their_node_id(),
1185                                                                 action: e.action,
1186                                                         });
1187                                                         return;
1188                                                 },
1189                                         }
1190                                 },
1191                                 None => return
1192                         }
1193                 };
1194                 // Because we have exclusive ownership of the channel here we can release the channel_state
1195                 // lock before add_update_monitor
1196                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1197                         unimplemented!();
1198                 }
1199                 add_pending_event!(events::Event::SendFundingCreated {
1200                         node_id: chan.get_their_node_id(),
1201                         msg: msg,
1202                 });
1203
1204                 let mut channel_state = self.channel_state.lock().unwrap();
1205                 match channel_state.by_id.entry(chan.channel_id()) {
1206                         hash_map::Entry::Occupied(_) => {
1207                                 panic!("Generated duplicate funding txid?");
1208                         },
1209                         hash_map::Entry::Vacant(e) => {
1210                                 e.insert(chan);
1211                         }
1212                 }
1213         }
1214
1215         fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1216                 if !chan.should_announce() { return None }
1217
1218                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1219                         Ok(res) => res,
1220                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1221                 };
1222                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1223                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1224
1225                 Some(msgs::AnnouncementSignatures {
1226                         channel_id: chan.channel_id(),
1227                         short_channel_id: chan.get_short_channel_id().unwrap(),
1228                         node_signature: our_node_sig,
1229                         bitcoin_signature: our_bitcoin_sig,
1230                 })
1231         }
1232
1233         /// Processes HTLCs which are pending waiting on random forward delay.
1234         ///
1235         /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1236         /// Will likely generate further events.
1237         pub fn process_pending_htlc_forwards(&self) {
1238                 let mut new_events = Vec::new();
1239                 let mut failed_forwards = Vec::new();
1240                 {
1241                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1242                         let channel_state = channel_state_lock.borrow_parts();
1243
1244                         if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1245                                 return;
1246                         }
1247
1248                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1249                                 if short_chan_id != 0 {
1250                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1251                                                 Some(chan_id) => chan_id.clone(),
1252                                                 None => {
1253                                                         failed_forwards.reserve(pending_forwards.len());
1254                                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1255                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1256                                                                         short_channel_id: prev_short_channel_id,
1257                                                                         htlc_id: prev_htlc_id,
1258                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1259                                                                 });
1260                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1261                                                         }
1262                                                         continue;
1263                                                 }
1264                                         };
1265                                         let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1266
1267                                         let mut add_htlc_msgs = Vec::new();
1268                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1269                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1270                                                         short_channel_id: prev_short_channel_id,
1271                                                         htlc_id: prev_htlc_id,
1272                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1273                                                 });
1274                                                 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()) {
1275                                                         Err(_e) => {
1276                                                                 let chan_update = self.get_channel_update(forward_chan).unwrap();
1277                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1278                                                                 continue;
1279                                                         },
1280                                                         Ok(update_add) => {
1281                                                                 match update_add {
1282                                                                         Some(msg) => { add_htlc_msgs.push(msg); },
1283                                                                         None => {
1284                                                                                 // Nothing to do here...we're waiting on a remote
1285                                                                                 // revoke_and_ack before we can add anymore HTLCs. The Channel
1286                                                                                 // will automatically handle building the update_add_htlc and
1287                                                                                 // commitment_signed messages when we can.
1288                                                                                 // TODO: Do some kind of timer to set the channel as !is_live()
1289                                                                                 // as we don't really want others relying on us relaying through
1290                                                                                 // this channel currently :/.
1291                                                                         }
1292                                                                 }
1293                                                         }
1294                                                 }
1295                                         }
1296
1297                                         if !add_htlc_msgs.is_empty() {
1298                                                 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1299                                                         Ok(res) => res,
1300                                                         Err(e) => {
1301                                                                 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(ref _err_msg)}) = &e.action {
1302                                                                 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: ref _err_msg}) = &e.action {
1303                                                                 } else {
1304                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1305                                                                 }
1306                                                                 //TODO: Handle...this is bad!
1307                                                                 continue;
1308                                                         },
1309                                                 };
1310                                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1311                                                         unimplemented!();// but def dont push the event...
1312                                                 }
1313                                                 new_events.push(events::Event::UpdateHTLCs {
1314                                                         node_id: forward_chan.get_their_node_id(),
1315                                                         updates: msgs::CommitmentUpdate {
1316                                                                 update_add_htlcs: add_htlc_msgs,
1317                                                                 update_fulfill_htlcs: Vec::new(),
1318                                                                 update_fail_htlcs: Vec::new(),
1319                                                                 update_fail_malformed_htlcs: Vec::new(),
1320                                                                 update_fee: None,
1321                                                                 commitment_signed: commitment_msg,
1322                                                         },
1323                                                 });
1324                                         }
1325                                 } else {
1326                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1327                                                 let prev_hop_data = HTLCPreviousHopData {
1328                                                         short_channel_id: prev_short_channel_id,
1329                                                         htlc_id: prev_htlc_id,
1330                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1331                                                 };
1332                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1333                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(prev_hop_data),
1334                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![prev_hop_data]); },
1335                                                 };
1336                                                 new_events.push(events::Event::PaymentReceived {
1337                                                         payment_hash: forward_info.payment_hash,
1338                                                         amt: forward_info.amt_to_forward,
1339                                                 });
1340                                         }
1341                                 }
1342                         }
1343                 }
1344
1345                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1346                         match update {
1347                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1348                                 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() }),
1349                         };
1350                 }
1351
1352                 if new_events.is_empty() { return }
1353                 let mut events = self.pending_events.lock().unwrap();
1354                 events.append(&mut new_events);
1355         }
1356
1357         /// Indicates that the preimage for payment_hash is unknown after a PaymentReceived event.
1358         pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32]) -> bool {
1359                 // TODO: Add ability to return 0x4000|16 (incorrect_payment_amount) if the amount we
1360                 // received is < expected or > 2*expected
1361                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1362                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1363                 if let Some(mut sources) = removed_source {
1364                         for htlc_with_hash in sources.drain(..) {
1365                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1366                                 self.fail_htlc_backwards_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: Vec::new() });
1367                         }
1368                         true
1369                 } else { false }
1370         }
1371
1372         /// Fails an HTLC backwards to the sender of it to us.
1373         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1374         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1375         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1376         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1377         /// still-available channels.
1378         fn fail_htlc_backwards_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &[u8; 32], onion_error: HTLCFailReason) {
1379                 match source {
1380                         HTLCSource::OutboundRoute { .. } => {
1381                                 mem::drop(channel_state);
1382                                 if let &HTLCFailReason::ErrorPacket { ref err } = &onion_error {
1383                                         let (channel_update, payment_retryable) = self.process_onion_failure(&source, err.data.clone());
1384                                         let mut pending_events = self.pending_events.lock().unwrap();
1385                                         if let Some(channel_update) = channel_update {
1386                                                 pending_events.push(events::Event::PaymentFailureNetworkUpdate {
1387                                                         update: channel_update,
1388                                                 });
1389                                         }
1390                                         pending_events.push(events::Event::PaymentFailed {
1391                                                 payment_hash: payment_hash.clone(),
1392                                                 rejected_by_dest: !payment_retryable,
1393                                         });
1394                                 } else {
1395                                         panic!("should have onion error packet here");
1396                                 }
1397                         },
1398                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1399                                 let err_packet = match onion_error {
1400                                         HTLCFailReason::Reason { failure_code, data } => {
1401                                                 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1402                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1403                                         },
1404                                         HTLCFailReason::ErrorPacket { err } => {
1405                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1406                                         }
1407                                 };
1408
1409                                 let (node_id, fail_msgs) = {
1410                                         let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1411                                                 Some(chan_id) => chan_id.clone(),
1412                                                 None => return
1413                                         };
1414
1415                                         let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1416                                         match chan.get_update_fail_htlc_and_commit(htlc_id, err_packet) {
1417                                                 Ok(Some((msg, commitment_msg, chan_monitor))) => {
1418                                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1419                                                                 unimplemented!();
1420                                                         }
1421                                                         (chan.get_their_node_id(), Some((msg, commitment_msg)))
1422                                                 },
1423                                                 Ok(None) => (chan.get_their_node_id(), None),
1424                                                 Err(_e) => {
1425                                                         //TODO: Do something with e?
1426                                                         return;
1427                                                 },
1428                                         }
1429                                 };
1430
1431                                 match fail_msgs {
1432                                         Some((msg, commitment_msg)) => {
1433                                                 mem::drop(channel_state);
1434
1435                                                 let mut pending_events = self.pending_events.lock().unwrap();
1436                                                 pending_events.push(events::Event::UpdateHTLCs {
1437                                                         node_id,
1438                                                         updates: msgs::CommitmentUpdate {
1439                                                                 update_add_htlcs: Vec::new(),
1440                                                                 update_fulfill_htlcs: Vec::new(),
1441                                                                 update_fail_htlcs: vec![msg],
1442                                                                 update_fail_malformed_htlcs: Vec::new(),
1443                                                                 update_fee: None,
1444                                                                 commitment_signed: commitment_msg,
1445                                                         },
1446                                                 });
1447                                         },
1448                                         None => {},
1449                                 }
1450                         },
1451                 }
1452         }
1453
1454         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1455         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1456         /// should probably kick the net layer to go send messages if this returns true!
1457         ///
1458         /// May panic if called except in response to a PaymentReceived event.
1459         pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1460                 let mut sha = Sha256::new();
1461                 sha.input(&payment_preimage);
1462                 let mut payment_hash = [0; 32];
1463                 sha.result(&mut payment_hash);
1464
1465                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1466                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1467                 if let Some(mut sources) = removed_source {
1468                         for htlc_with_hash in sources.drain(..) {
1469                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1470                                 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1471                         }
1472                         true
1473                 } else { false }
1474         }
1475         fn claim_funds_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: [u8; 32]) {
1476                 match source {
1477                         HTLCSource::OutboundRoute { .. } => {
1478                                 mem::drop(channel_state);
1479                                 let mut pending_events = self.pending_events.lock().unwrap();
1480                                 pending_events.push(events::Event::PaymentSent {
1481                                         payment_preimage
1482                                 });
1483                         },
1484                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1485                                 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1486                                 let (node_id, fulfill_msgs) = {
1487                                         let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1488                                                 Some(chan_id) => chan_id.clone(),
1489                                                 None => {
1490                                                         // TODO: There is probably a channel manager somewhere that needs to
1491                                                         // learn the preimage as the channel already hit the chain and that's
1492                                                         // why its missing.
1493                                                         return
1494                                                 }
1495                                         };
1496
1497                                         let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1498                                         match chan.get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1499                                                 Ok((msgs, Some(chan_monitor))) => {
1500                                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1501                                                                 unimplemented!();// but def dont push the event...
1502                                                         }
1503                                                         (chan.get_their_node_id(), msgs)
1504                                                 },
1505                                                 Ok((msgs, None)) => (chan.get_their_node_id(), msgs),
1506                                                 Err(_e) => {
1507                                                         // TODO: There is probably a channel manager somewhere that needs to
1508                                                         // learn the preimage as the channel may be about to hit the chain.
1509                                                         //TODO: Do something with e?
1510                                                         return
1511                                                 },
1512                                         }
1513                                 };
1514
1515                                 mem::drop(channel_state);
1516                                 if let Some((msg, commitment_msg)) = fulfill_msgs {
1517                                         let mut pending_events = self.pending_events.lock().unwrap();
1518                                         pending_events.push(events::Event::UpdateHTLCs {
1519                                                 node_id: node_id,
1520                                                 updates: msgs::CommitmentUpdate {
1521                                                         update_add_htlcs: Vec::new(),
1522                                                         update_fulfill_htlcs: vec![msg],
1523                                                         update_fail_htlcs: Vec::new(),
1524                                                         update_fail_malformed_htlcs: Vec::new(),
1525                                                         update_fee: None,
1526                                                         commitment_signed: commitment_msg,
1527                                                 }
1528                                         });
1529                                 }
1530                         },
1531                 }
1532         }
1533
1534         /// Gets the node_id held by this ChannelManager
1535         pub fn get_our_node_id(&self) -> PublicKey {
1536                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1537         }
1538
1539         /// Used to restore channels to normal operation after a
1540         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1541         /// operation.
1542         pub fn test_restore_channel_monitor(&self) {
1543                 unimplemented!();
1544         }
1545
1546         fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, MsgHandleErrInternal> {
1547                 if msg.chain_hash != self.genesis_hash {
1548                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1549                 }
1550                 let mut channel_state = self.channel_state.lock().unwrap();
1551                 if channel_state.by_id.contains_key(&msg.temporary_channel_id) {
1552                         return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone()));
1553                 }
1554
1555                 let chan_keys = if cfg!(feature = "fuzztarget") {
1556                         ChannelKeys {
1557                                 funding_key:               SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0]).unwrap(),
1558                                 revocation_base_key:       SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 0]).unwrap(),
1559                                 payment_base_key:          SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0]).unwrap(),
1560                                 delayed_payment_base_key:  SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0]).unwrap(),
1561                                 htlc_base_key:             SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0]).unwrap(),
1562                                 channel_close_key:         SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 0]).unwrap(),
1563                                 channel_monitor_claim_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 0]).unwrap(),
1564                                 commitment_seed: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
1565                         }
1566                 } else {
1567                         let mut key_seed = [0u8; 32];
1568                         rng::fill_bytes(&mut key_seed);
1569                         match ChannelKeys::new_from_seed(&key_seed) {
1570                                 Ok(key) => key,
1571                                 Err(_) => panic!("RNG is busted!")
1572                         }
1573                 };
1574
1575                 let channel = Channel::new_from_req(&*self.fee_estimator, chan_keys, their_node_id.clone(), msg, 0, false, self.announce_channels_publicly, Arc::clone(&self.logger))
1576                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1577                 let accept_msg = channel.get_accept_channel();
1578                 channel_state.by_id.insert(channel.channel_id(), channel);
1579                 Ok(accept_msg)
1580         }
1581
1582         fn internal_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1583                 let (value, output_script, user_id) = {
1584                         let mut channel_state = self.channel_state.lock().unwrap();
1585                         match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1586                                 Some(chan) => {
1587                                         if chan.get_their_node_id() != *their_node_id {
1588                                                 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1589                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1590                                         }
1591                                         chan.accept_channel(&msg)
1592                                                 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.temporary_channel_id))?;
1593                                         (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1594                                 },
1595                                 //TODO: same as above
1596                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1597                         }
1598                 };
1599                 let mut pending_events = self.pending_events.lock().unwrap();
1600                 pending_events.push(events::Event::FundingGenerationReady {
1601                         temporary_channel_id: msg.temporary_channel_id,
1602                         channel_value_satoshis: value,
1603                         output_script: output_script,
1604                         user_channel_id: user_id,
1605                 });
1606                 Ok(())
1607         }
1608
1609         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, MsgHandleErrInternal> {
1610                 let (chan, funding_msg, monitor_update) = {
1611                         let mut channel_state = self.channel_state.lock().unwrap();
1612                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1613                                 hash_map::Entry::Occupied(mut chan) => {
1614                                         if chan.get().get_their_node_id() != *their_node_id {
1615                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1616                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1617                                         }
1618                                         match chan.get_mut().funding_created(msg) {
1619                                                 Ok((funding_msg, monitor_update)) => {
1620                                                         (chan.remove(), funding_msg, monitor_update)
1621                                                 },
1622                                                 Err(e) => {
1623                                                         return Err(e).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1624                                                 }
1625                                         }
1626                                 },
1627                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1628                         }
1629                 };
1630                 // Because we have exclusive ownership of the channel here we can release the channel_state
1631                 // lock before add_update_monitor
1632                 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1633                         unimplemented!();
1634                 }
1635                 let mut channel_state = self.channel_state.lock().unwrap();
1636                 match channel_state.by_id.entry(funding_msg.channel_id) {
1637                         hash_map::Entry::Occupied(_) => {
1638                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1639                         },
1640                         hash_map::Entry::Vacant(e) => {
1641                                 e.insert(chan);
1642                         }
1643                 }
1644                 Ok(funding_msg)
1645         }
1646
1647         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1648                 let (funding_txo, user_id) = {
1649                         let mut channel_state = self.channel_state.lock().unwrap();
1650                         match channel_state.by_id.get_mut(&msg.channel_id) {
1651                                 Some(chan) => {
1652                                         if chan.get_their_node_id() != *their_node_id {
1653                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1654                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1655                                         }
1656                                         let chan_monitor = chan.funding_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1657                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1658                                                 unimplemented!();
1659                                         }
1660                                         (chan.get_funding_txo().unwrap(), chan.get_user_id())
1661                                 },
1662                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1663                         }
1664                 };
1665                 let mut pending_events = self.pending_events.lock().unwrap();
1666                 pending_events.push(events::Event::FundingBroadcastSafe {
1667                         funding_txo: funding_txo,
1668                         user_channel_id: user_id,
1669                 });
1670                 Ok(())
1671         }
1672
1673         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, MsgHandleErrInternal> {
1674                 let mut channel_state = self.channel_state.lock().unwrap();
1675                 match channel_state.by_id.get_mut(&msg.channel_id) {
1676                         Some(chan) => {
1677                                 if chan.get_their_node_id() != *their_node_id {
1678                                         //TODO: here and below MsgHandleErrInternal, #153 case
1679                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1680                                 }
1681                                 chan.funding_locked(&msg)
1682                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1683                                 return Ok(self.get_announcement_sigs(chan));
1684                         },
1685                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1686                 };
1687         }
1688
1689         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), MsgHandleErrInternal> {
1690                 let (mut res, chan_option) = {
1691                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1692                         let channel_state = channel_state_lock.borrow_parts();
1693
1694                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1695                                 hash_map::Entry::Occupied(mut chan_entry) => {
1696                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1697                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1698                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1699                                         }
1700                                         let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1701                                         if chan_entry.get().is_shutdown() {
1702                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1703                                                         channel_state.short_to_id.remove(&short_id);
1704                                                 }
1705                                                 (res, Some(chan_entry.remove_entry().1))
1706                                         } else { (res, None) }
1707                                 },
1708                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1709                         }
1710                 };
1711                 for htlc_source in res.2.drain(..) {
1712                         // unknown_next_peer...I dunno who that is anymore....
1713                         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() });
1714                 }
1715                 if let Some(chan) = chan_option {
1716                         if let Ok(update) = self.get_channel_update(&chan) {
1717                                 let mut events = self.pending_events.lock().unwrap();
1718                                 events.push(events::Event::BroadcastChannelUpdate {
1719                                         msg: update
1720                                 });
1721                         }
1722                 }
1723                 Ok((res.0, res.1))
1724         }
1725
1726         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, MsgHandleErrInternal> {
1727                 let (res, chan_option) = {
1728                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1729                         let channel_state = channel_state_lock.borrow_parts();
1730                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1731                                 hash_map::Entry::Occupied(mut chan_entry) => {
1732                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1733                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1734                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1735                                         }
1736                                         let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1737                                         if res.1.is_some() {
1738                                                 // We're done with this channel, we've got a signed closing transaction and
1739                                                 // will send the closing_signed back to the remote peer upon return. This
1740                                                 // also implies there are no pending HTLCs left on the channel, so we can
1741                                                 // fully delete it from tracking (the channel monitor is still around to
1742                                                 // watch for old state broadcasts)!
1743                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1744                                                         channel_state.short_to_id.remove(&short_id);
1745                                                 }
1746                                                 (res, Some(chan_entry.remove_entry().1))
1747                                         } else { (res, None) }
1748                                 },
1749                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1750                         }
1751                 };
1752                 if let Some(broadcast_tx) = res.1 {
1753                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1754                 }
1755                 if let Some(chan) = chan_option {
1756                         if let Ok(update) = self.get_channel_update(&chan) {
1757                                 let mut events = self.pending_events.lock().unwrap();
1758                                 events.push(events::Event::BroadcastChannelUpdate {
1759                                         msg: update
1760                                 });
1761                         }
1762                 }
1763                 Ok(res.0)
1764         }
1765
1766         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
1767                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1768                 //determine the state of the payment based on our response/if we forward anything/the time
1769                 //we take to respond. We should take care to avoid allowing such an attack.
1770                 //
1771                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1772                 //us repeatedly garbled in different ways, and compare our error messages, which are
1773                 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1774                 //but we should prevent it anyway.
1775
1776                 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1777                 let channel_state = channel_state_lock.borrow_parts();
1778
1779                 match channel_state.by_id.get_mut(&msg.channel_id) {
1780                         Some(chan) => {
1781                                 if chan.get_their_node_id() != *their_node_id {
1782                                         //TODO: here MsgHandleErrInternal, #153 case
1783                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1784                                 }
1785                                 if !chan.is_usable() {
1786                                         return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Channel not yet available for receiving HTLCs", action: Some(msgs::ErrorAction::IgnoreError)}));
1787                                 }
1788                                 chan.update_add_htlc(&msg, pending_forward_info).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1789                         },
1790                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1791                 }
1792         }
1793
1794         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
1795                 let mut channel_state = self.channel_state.lock().unwrap();
1796                 let htlc_source = match channel_state.by_id.get_mut(&msg.channel_id) {
1797                         Some(chan) => {
1798                                 if chan.get_their_node_id() != *their_node_id {
1799                                         //TODO: here and below MsgHandleErrInternal, #153 case
1800                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1801                                 }
1802                                 chan.update_fulfill_htlc(&msg)
1803                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?.clone()
1804                         },
1805                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1806                 };
1807                 self.claim_funds_internal(channel_state, htlc_source, msg.payment_preimage.clone());
1808                 Ok(())
1809         }
1810
1811         // Process failure we got back from upstream on a payment we sent. Returns update and a boolean
1812         // indicating that the payment itself failed
1813         fn process_onion_failure(&self, htlc_source: &HTLCSource, mut packet_decrypted: Vec<u8>) -> (Option<msgs::HTLCFailChannelUpdate>, bool) {
1814                 if let &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } = htlc_source {
1815                         macro_rules! onion_failure_log {
1816                                 ( $error_code_textual: expr, $error_code: expr, $reported_name: expr, $reported_value: expr ) => {
1817                                         log_trace!(self, "{}({:#x}) {}({})", $error_code_textual, $error_code, $reported_name, $reported_value);
1818                                 };
1819                                 ( $error_code_textual: expr, $error_code: expr ) => {
1820                                         log_trace!(self, "{}({})", $error_code_textual, $error_code);
1821                                 };
1822                         }
1823
1824                         const BADONION: u16 = 0x8000;
1825                         const PERM: u16 = 0x4000;
1826                         const UPDATE: u16 = 0x1000;
1827
1828                         let mut res = None;
1829                         let mut htlc_msat = *first_hop_htlc_msat;
1830
1831                         // Handle packed channel/node updates for passing back for the route handler
1832                         Self::construct_onion_keys_callback(&self.secp_ctx, route, session_priv, |shared_secret, _, _, route_hop| {
1833                                 if res.is_some() { return; }
1834
1835                                 let incoming_htlc_msat = htlc_msat;
1836                                 let amt_to_forward = htlc_msat - route_hop.fee_msat;
1837                                 htlc_msat = amt_to_forward;
1838
1839                                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
1840
1841                                 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1842                                 decryption_tmp.resize(packet_decrypted.len(), 0);
1843                                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1844                                 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1845                                 packet_decrypted = decryption_tmp;
1846
1847                                 let is_from_final_node = route.hops.last().unwrap().pubkey == route_hop.pubkey;
1848
1849                                 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
1850                                         let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
1851                                         let mut hmac = Hmac::new(Sha256::new(), &um);
1852                                         hmac.input(&err_packet.encode()[32..]);
1853                                         let mut calc_tag = [0u8; 32];
1854                                         hmac.raw_result(&mut calc_tag);
1855
1856                                         if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
1857                                                 if err_packet.failuremsg.len() < 2 {
1858                                                         // Useless packet that we can't use but it passed HMAC, so it
1859                                                         // definitely came from the peer in question
1860                                                         res = Some((None, !is_from_final_node));
1861                                                 } else {
1862                                                         let error_code = byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]);
1863
1864                                                         match error_code & 0xff {
1865                                                                 1|2|3 => {
1866                                                                         // either from an intermediate or final node
1867                                                                         //   invalid_realm(PERM|1),
1868                                                                         //   temporary_node_failure(NODE|2)
1869                                                                         //   permanent_node_failure(PERM|NODE|2)
1870                                                                         //   required_node_feature_mssing(PERM|NODE|3)
1871                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
1872                                                                                 node_id: route_hop.pubkey,
1873                                                                                 is_permanent: error_code & PERM == PERM,
1874                                                                         }), !(error_code & PERM == PERM && is_from_final_node)));
1875                                                                         // node returning invalid_realm is removed from network_map,
1876                                                                         // although NODE flag is not set, TODO: or remove channel only?
1877                                                                         // retry payment when removed node is not a final node
1878                                                                         return;
1879                                                                 },
1880                                                                 _ => {}
1881                                                         }
1882
1883                                                         if is_from_final_node {
1884                                                                 let payment_retryable = match error_code {
1885                                                                         c if c == PERM|15 => false, // unknown_payment_hash
1886                                                                         c if c == PERM|16 => false, // incorrect_payment_amount
1887                                                                         17 => true, // final_expiry_too_soon
1888                                                                         18 if err_packet.failuremsg.len() == 6 => { // final_incorrect_cltv_expiry
1889                                                                                 let _reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
1890                                                                                 true
1891                                                                         },
1892                                                                         19 if err_packet.failuremsg.len() == 10 => { // final_incorrect_htlc_amount
1893                                                                                 let _reported_incoming_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
1894                                                                                 true
1895                                                                         },
1896                                                                         _ => {
1897                                                                                 // A final node has sent us either an invalid code or an error_code that
1898                                                                                 // MUST be sent from the processing node, or the formmat of failuremsg
1899                                                                                 // does not coform to the spec.
1900                                                                                 // Remove it from the network map and don't may retry payment
1901                                                                                 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
1902                                                                                         node_id: route_hop.pubkey,
1903                                                                                         is_permanent: true,
1904                                                                                 }), false));
1905                                                                                 return;
1906                                                                         }
1907                                                                 };
1908                                                                 res = Some((None, payment_retryable));
1909                                                                 return;
1910                                                         }
1911
1912                                                         // now, error_code should be only from the intermediate nodes
1913                                                         match error_code {
1914                                                                 _c if error_code & PERM == PERM => {
1915                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
1916                                                                                 short_channel_id: route_hop.short_channel_id,
1917                                                                                 is_permanent: true,
1918                                                                         }), false));
1919                                                                 },
1920                                                                 _c if error_code & UPDATE == UPDATE => {
1921                                                                         let offset = match error_code {
1922                                                                                 c if c == UPDATE|7  => 0, // temporary_channel_failure
1923                                                                                 c if c == UPDATE|11 => 8, // amount_below_minimum
1924                                                                                 c if c == UPDATE|12 => 8, // fee_insufficient
1925                                                                                 c if c == UPDATE|13 => 4, // incorrect_cltv_expiry
1926                                                                                 c if c == UPDATE|14 => 0, // expiry_too_soon
1927                                                                                 c if c == UPDATE|20 => 2, // channel_disabled
1928                                                                                 _ =>  {
1929                                                                                         // node sending unknown code
1930                                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
1931                                                                                                 node_id: route_hop.pubkey,
1932                                                                                                 is_permanent: true,
1933                                                                                         }), false));
1934                                                                                         return;
1935                                                                                 }
1936                                                                         };
1937
1938                                                                         if err_packet.failuremsg.len() >= offset + 2 {
1939                                                                                 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[offset+2..offset+4]) as usize;
1940                                                                                 if err_packet.failuremsg.len() >= offset + 4 + update_len {
1941                                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&err_packet.failuremsg[offset + 4..offset + 4 + update_len])) {
1942                                                                                                 // if channel_update should NOT have caused the failure:
1943                                                                                                 // MAY treat the channel_update as invalid.
1944                                                                                                 let is_chan_update_invalid = match error_code {
1945                                                                                                         c if c == UPDATE|7 => { // temporary_channel_failure
1946                                                                                                                 false
1947                                                                                                         },
1948                                                                                                         c if c == UPDATE|11 => { // amount_below_minimum
1949                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
1950                                                                                                                 onion_failure_log!("amount_below_minimum", UPDATE|11, "htlc_msat", reported_htlc_msat);
1951                                                                                                                 incoming_htlc_msat > chan_update.contents.htlc_minimum_msat
1952                                                                                                         },
1953                                                                                                         c if c == UPDATE|12 => { // fee_insufficient
1954                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
1955                                                                                                                 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) });
1956                                                                                                                 onion_failure_log!("fee_insufficient", UPDATE|12, "htlc_msat", reported_htlc_msat);
1957                                                                                                                 new_fee.is_none() || incoming_htlc_msat >= new_fee.unwrap() && incoming_htlc_msat >= amt_to_forward + new_fee.unwrap()
1958                                                                                                         }
1959                                                                                                         c if c == UPDATE|13 => { // incorrect_cltv_expiry
1960                                                                                                                 let reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
1961                                                                                                                 onion_failure_log!("incorrect_cltv_expiry", UPDATE|13, "cltv_expiry", reported_cltv_expiry);
1962                                                                                                                 route_hop.cltv_expiry_delta as u16 >= chan_update.contents.cltv_expiry_delta
1963                                                                                                         },
1964                                                                                                         c if c == UPDATE|20 => { // channel_disabled
1965                                                                                                                 let reported_flags = byte_utils::slice_to_be16(&err_packet.failuremsg[2..2+2]);
1966                                                                                                                 onion_failure_log!("channel_disabled", UPDATE|20, "flags", reported_flags);
1967                                                                                                                 chan_update.contents.flags & 0x01 == 0x01
1968                                                                                                         },
1969                                                                                                         c if c == UPDATE|21 => true, // expiry_too_far
1970                                                                                                         _ => { unreachable!(); },
1971                                                                                                 };
1972
1973                                                                                                 let msg = if is_chan_update_invalid { None } else {
1974                                                                                                         Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
1975                                                                                                                 msg: chan_update,
1976                                                                                                         })
1977                                                                                                 };
1978                                                                                                 res = Some((msg, true));
1979                                                                                                 return;
1980                                                                                         }
1981                                                                                 }
1982                                                                         }
1983                                                                 },
1984                                                                 _c if error_code & BADONION == BADONION => {
1985                                                                         //TODO
1986                                                                 },
1987                                                                 14 => { // expiry_too_soon
1988                                                                         res = Some((None, true));
1989                                                                         return;
1990                                                                 }
1991                                                                 _ => {
1992                                                                         // node sending unknown code
1993                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
1994                                                                                 node_id: route_hop.pubkey,
1995                                                                                 is_permanent: true,
1996                                                                         }), false));
1997                                                                         return;
1998                                                                 }
1999                                                         }
2000                                                 }
2001                                         }
2002                                 }
2003                         }).expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
2004                         res.unwrap_or((None, true))
2005                 } else { ((None, true)) }
2006         }
2007
2008         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2009                 let mut channel_state = self.channel_state.lock().unwrap();
2010                 match channel_state.by_id.get_mut(&msg.channel_id) {
2011                         Some(chan) => {
2012                                 if chan.get_their_node_id() != *their_node_id {
2013                                         //TODO: here and below MsgHandleErrInternal, #153 case
2014                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2015                                 }
2016                                 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
2017                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2018                         },
2019                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2020                 }?;
2021                 Ok(())
2022         }
2023
2024         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2025                 let mut channel_state = self.channel_state.lock().unwrap();
2026                 match channel_state.by_id.get_mut(&msg.channel_id) {
2027                         Some(chan) => {
2028                                 if chan.get_their_node_id() != *their_node_id {
2029                                         //TODO: here and below MsgHandleErrInternal, #153 case
2030                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2031                                 }
2032                                 if (msg.failure_code & 0x8000) != 0 {
2033                                         return Err(MsgHandleErrInternal::send_err_msg_close_chan("Got update_fail_malformed_htlc with BADONION set", msg.channel_id));
2034                                 }
2035                                 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
2036                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2037                                 Ok(())
2038                         },
2039                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2040                 }
2041         }
2042
2043         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), MsgHandleErrInternal> {
2044                 let (revoke_and_ack, commitment_signed) = {
2045                         let mut channel_state = self.channel_state.lock().unwrap();
2046                         match channel_state.by_id.get_mut(&msg.channel_id) {
2047                                 Some(chan) => {
2048                                         if chan.get_their_node_id() != *their_node_id {
2049                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2050                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2051                                         }
2052                                         let (revoke_and_ack, commitment_signed, chan_monitor) = chan.commitment_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
2053                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2054                                                 unimplemented!();
2055                                         }
2056                                         (revoke_and_ack, commitment_signed)
2057                                 },
2058                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2059                         }
2060                 };
2061                 Ok((revoke_and_ack, commitment_signed))
2062         }
2063
2064         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, MsgHandleErrInternal> {
2065                 let ((res, mut pending_forwards, mut pending_failures), short_channel_id) = {
2066                         let mut channel_state = self.channel_state.lock().unwrap();
2067                         match channel_state.by_id.get_mut(&msg.channel_id) {
2068                                 Some(chan) => {
2069                                         if chan.get_their_node_id() != *their_node_id {
2070                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2071                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2072                                         }
2073                                         let (res, pending_forwards, pending_failures, chan_monitor) = chan.revoke_and_ack(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
2074                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2075                                                 unimplemented!();
2076                                         }
2077                                         ((res, pending_forwards, pending_failures), chan.get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2078                                 },
2079                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2080                         }
2081                 };
2082                 for failure in pending_failures.drain(..) {
2083                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2084                 }
2085
2086                 let mut forward_event = None;
2087                 if !pending_forwards.is_empty() {
2088                         let mut channel_state = self.channel_state.lock().unwrap();
2089                         if channel_state.forward_htlcs.is_empty() {
2090                                 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));
2091                                 channel_state.next_forward = forward_event.unwrap();
2092                         }
2093                         for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2094                                 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2095                                         hash_map::Entry::Occupied(mut entry) => {
2096                                                 entry.get_mut().push(HTLCForwardInfo { prev_short_channel_id: short_channel_id, prev_htlc_id, forward_info });
2097                                         },
2098                                         hash_map::Entry::Vacant(entry) => {
2099                                                 entry.insert(vec!(HTLCForwardInfo { prev_short_channel_id: short_channel_id, prev_htlc_id, forward_info }));
2100                                         }
2101                                 }
2102                         }
2103                 }
2104                 match forward_event {
2105                         Some(time) => {
2106                                 let mut pending_events = self.pending_events.lock().unwrap();
2107                                 pending_events.push(events::Event::PendingHTLCsForwardable {
2108                                         time_forwardable: time
2109                                 });
2110                         }
2111                         None => {},
2112                 }
2113
2114                 Ok(res)
2115         }
2116
2117         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2118                 let mut channel_state = self.channel_state.lock().unwrap();
2119                 match channel_state.by_id.get_mut(&msg.channel_id) {
2120                         Some(chan) => {
2121                                 if chan.get_their_node_id() != *their_node_id {
2122                                         //TODO: here and below MsgHandleErrInternal, #153 case
2123                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2124                                 }
2125                                 chan.update_fee(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2126                         },
2127                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2128                 }
2129         }
2130
2131         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2132                 let (chan_announcement, chan_update) = {
2133                         let mut channel_state = self.channel_state.lock().unwrap();
2134                         match channel_state.by_id.get_mut(&msg.channel_id) {
2135                                 Some(chan) => {
2136                                         if chan.get_their_node_id() != *their_node_id {
2137                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2138                                         }
2139                                         if !chan.is_usable() {
2140                                                 return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
2141                                         }
2142
2143                                         let our_node_id = self.get_our_node_id();
2144                                         let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())
2145                                                 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2146
2147                                         let were_node_one = announcement.node_id_1 == our_node_id;
2148                                         let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2149                                         let bad_sig_action = MsgHandleErrInternal::send_err_msg_close_chan("Bad announcement_signatures node_signature", msg.channel_id);
2150                                         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);
2151                                         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);
2152
2153                                         let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2154
2155                                         (msgs::ChannelAnnouncement {
2156                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2157                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2158                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2159                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2160                                                 contents: announcement,
2161                                         }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state
2162                                 },
2163                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2164                         }
2165                 };
2166                 let mut pending_events = self.pending_events.lock().unwrap();
2167                 pending_events.push(events::Event::BroadcastChannelAnnouncement { msg: chan_announcement, update_msg: chan_update });
2168                 Ok(())
2169         }
2170
2171         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder), MsgHandleErrInternal> {
2172                 let res = {
2173                         let mut channel_state = self.channel_state.lock().unwrap();
2174                         match channel_state.by_id.get_mut(&msg.channel_id) {
2175                                 Some(chan) => {
2176                                         if chan.get_their_node_id() != *their_node_id {
2177                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2178                                         }
2179                                         let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, order) = chan.channel_reestablish(msg)
2180                                                 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2181                                         if let Some(monitor) = channel_monitor {
2182                                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2183                                                         unimplemented!();
2184                                                 }
2185                                         }
2186                                         Ok((funding_locked, revoke_and_ack, commitment_update, order))
2187                                 },
2188                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2189                         }
2190                 };
2191
2192                 res
2193         }
2194
2195         /// Begin Update fee process. Allowed only on an outbound channel.
2196         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2197         /// PeerManager::process_events afterwards.
2198         /// Note: This API is likely to change!
2199         #[doc(hidden)]
2200         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2201                 let mut channel_state = self.channel_state.lock().unwrap();
2202                 match channel_state.by_id.get_mut(&channel_id) {
2203                         None => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2204                         Some(chan) => {
2205                                 if !chan.is_outbound() {
2206                                         return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2207                                 }
2208                                 if !chan.is_live() {
2209                                         return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2210                                 }
2211                                 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})? {
2212                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2213                                                 unimplemented!();
2214                                         }
2215                                         let mut pending_events = self.pending_events.lock().unwrap();
2216                                         pending_events.push(events::Event::UpdateHTLCs {
2217                                                 node_id: chan.get_their_node_id(),
2218                                                 updates: msgs::CommitmentUpdate {
2219                                                         update_add_htlcs: Vec::new(),
2220                                                         update_fulfill_htlcs: Vec::new(),
2221                                                         update_fail_htlcs: Vec::new(),
2222                                                         update_fail_malformed_htlcs: Vec::new(),
2223                                                         update_fee: Some(update_fee),
2224                                                         commitment_signed,
2225                                                 },
2226                                         });
2227                                 }
2228                         },
2229                 }
2230                 Ok(())
2231         }
2232 }
2233
2234 impl events::EventsProvider for ChannelManager {
2235         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2236                 let mut pending_events = self.pending_events.lock().unwrap();
2237                 let mut ret = Vec::new();
2238                 mem::swap(&mut ret, &mut *pending_events);
2239                 ret
2240         }
2241 }
2242
2243 impl ChainListener for ChannelManager {
2244         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2245                 let mut new_events = Vec::new();
2246                 let mut failed_channels = Vec::new();
2247                 {
2248                         let mut channel_lock = self.channel_state.lock().unwrap();
2249                         let channel_state = channel_lock.borrow_parts();
2250                         let short_to_id = channel_state.short_to_id;
2251                         channel_state.by_id.retain(|_, channel| {
2252                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2253                                 if let Ok(Some(funding_locked)) = chan_res {
2254                                         let announcement_sigs = self.get_announcement_sigs(channel);
2255                                         new_events.push(events::Event::SendFundingLocked {
2256                                                 node_id: channel.get_their_node_id(),
2257                                                 msg: funding_locked,
2258                                                 announcement_sigs: announcement_sigs
2259                                         });
2260                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2261                                 } else if let Err(e) = chan_res {
2262                                         new_events.push(events::Event::HandleError {
2263                                                 node_id: channel.get_their_node_id(),
2264                                                 action: e.action,
2265                                         });
2266                                         if channel.is_shutdown() {
2267                                                 return false;
2268                                         }
2269                                 }
2270                                 if let Some(funding_txo) = channel.get_funding_txo() {
2271                                         for tx in txn_matched {
2272                                                 for inp in tx.input.iter() {
2273                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2274                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2275                                                                         short_to_id.remove(&short_id);
2276                                                                 }
2277                                                                 // It looks like our counterparty went on-chain. We go ahead and
2278                                                                 // broadcast our latest local state as well here, just in case its
2279                                                                 // some kind of SPV attack, though we expect these to be dropped.
2280                                                                 failed_channels.push(channel.force_shutdown());
2281                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2282                                                                         new_events.push(events::Event::BroadcastChannelUpdate {
2283                                                                                 msg: update
2284                                                                         });
2285                                                                 }
2286                                                                 return false;
2287                                                         }
2288                                                 }
2289                                         }
2290                                 }
2291                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2292                                         if let Some(short_id) = channel.get_short_channel_id() {
2293                                                 short_to_id.remove(&short_id);
2294                                         }
2295                                         failed_channels.push(channel.force_shutdown());
2296                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2297                                         // the latest local tx for us, so we should skip that here (it doesn't really
2298                                         // hurt anything, but does make tests a bit simpler).
2299                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2300                                         if let Ok(update) = self.get_channel_update(&channel) {
2301                                                 new_events.push(events::Event::BroadcastChannelUpdate {
2302                                                         msg: update
2303                                                 });
2304                                         }
2305                                         return false;
2306                                 }
2307                                 true
2308                         });
2309                 }
2310                 for failure in failed_channels.drain(..) {
2311                         self.finish_force_close_channel(failure);
2312                 }
2313                 let mut pending_events = self.pending_events.lock().unwrap();
2314                 for funding_locked in new_events.drain(..) {
2315                         pending_events.push(funding_locked);
2316                 }
2317                 self.latest_block_height.store(height as usize, Ordering::Release);
2318         }
2319
2320         /// We force-close the channel without letting our counterparty participate in the shutdown
2321         fn block_disconnected(&self, header: &BlockHeader) {
2322                 let mut new_events = Vec::new();
2323                 let mut failed_channels = Vec::new();
2324                 {
2325                         let mut channel_lock = self.channel_state.lock().unwrap();
2326                         let channel_state = channel_lock.borrow_parts();
2327                         let short_to_id = channel_state.short_to_id;
2328                         channel_state.by_id.retain(|_,  v| {
2329                                 if v.block_disconnected(header) {
2330                                         if let Some(short_id) = v.get_short_channel_id() {
2331                                                 short_to_id.remove(&short_id);
2332                                         }
2333                                         failed_channels.push(v.force_shutdown());
2334                                         if let Ok(update) = self.get_channel_update(&v) {
2335                                                 new_events.push(events::Event::BroadcastChannelUpdate {
2336                                                         msg: update
2337                                                 });
2338                                         }
2339                                         false
2340                                 } else {
2341                                         true
2342                                 }
2343                         });
2344                 }
2345                 for failure in failed_channels.drain(..) {
2346                         self.finish_force_close_channel(failure);
2347                 }
2348                 if !new_events.is_empty() {
2349                         let mut pending_events = self.pending_events.lock().unwrap();
2350                         for funding_locked in new_events.drain(..) {
2351                                 pending_events.push(funding_locked);
2352                         }
2353                 }
2354                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2355         }
2356 }
2357
2358 macro_rules! handle_error {
2359         ($self: ident, $internal: expr, $their_node_id: expr) => {
2360                 match $internal {
2361                         Ok(msg) => Ok(msg),
2362                         Err(MsgHandleErrInternal { err, needs_channel_force_close }) => {
2363                                 if needs_channel_force_close {
2364                                         match &err.action {
2365                                                 &Some(msgs::ErrorAction::DisconnectPeer { msg: Some(ref msg) }) => {
2366                                                         if msg.channel_id == [0; 32] {
2367                                                                 $self.peer_disconnected(&$their_node_id, true);
2368                                                         } else {
2369                                                                 $self.force_close_channel(&msg.channel_id);
2370                                                         }
2371                                                 },
2372                                                 &Some(msgs::ErrorAction::DisconnectPeer { msg: None }) => {},
2373                                                 &Some(msgs::ErrorAction::IgnoreError) => {},
2374                                                 &Some(msgs::ErrorAction::SendErrorMessage { ref msg }) => {
2375                                                         if msg.channel_id == [0; 32] {
2376                                                                 $self.peer_disconnected(&$their_node_id, true);
2377                                                         } else {
2378                                                                 $self.force_close_channel(&msg.channel_id);
2379                                                         }
2380                                                 },
2381                                                 &None => {},
2382                                         }
2383                                 }
2384                                 Err(err)
2385                         },
2386                 }
2387         }
2388 }
2389
2390 impl ChannelMessageHandler for ChannelManager {
2391         //TODO: Handle errors and close channel (or so)
2392         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, HandleError> {
2393                 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
2394         }
2395
2396         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2397                 handle_error!(self, self.internal_accept_channel(their_node_id, msg), their_node_id)
2398         }
2399
2400         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, HandleError> {
2401                 handle_error!(self, self.internal_funding_created(their_node_id, msg), their_node_id)
2402         }
2403
2404         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2405                 handle_error!(self, self.internal_funding_signed(their_node_id, msg), their_node_id)
2406         }
2407
2408         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
2409                 handle_error!(self, self.internal_funding_locked(their_node_id, msg), their_node_id)
2410         }
2411
2412         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), HandleError> {
2413                 handle_error!(self, self.internal_shutdown(their_node_id, msg), their_node_id)
2414         }
2415
2416         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, HandleError> {
2417                 handle_error!(self, self.internal_closing_signed(their_node_id, msg), their_node_id)
2418         }
2419
2420         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2421                 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), their_node_id)
2422         }
2423
2424         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2425                 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), their_node_id)
2426         }
2427
2428         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
2429                 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), their_node_id)
2430         }
2431
2432         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2433                 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), their_node_id)
2434         }
2435
2436         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), HandleError> {
2437                 handle_error!(self, self.internal_commitment_signed(their_node_id, msg), their_node_id)
2438         }
2439
2440         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, HandleError> {
2441                 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), their_node_id)
2442         }
2443
2444         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2445                 handle_error!(self, self.internal_update_fee(their_node_id, msg), their_node_id)
2446         }
2447
2448         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2449                 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2450         }
2451
2452         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder), HandleError> {
2453                 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), their_node_id)
2454         }
2455
2456         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2457                 let mut new_events = Vec::new();
2458                 let mut failed_channels = Vec::new();
2459                 let mut failed_payments = Vec::new();
2460                 {
2461                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2462                         let channel_state = channel_state_lock.borrow_parts();
2463                         let short_to_id = channel_state.short_to_id;
2464                         if no_connection_possible {
2465                                 channel_state.by_id.retain(|_, chan| {
2466                                         if chan.get_their_node_id() == *their_node_id {
2467                                                 if let Some(short_id) = chan.get_short_channel_id() {
2468                                                         short_to_id.remove(&short_id);
2469                                                 }
2470                                                 failed_channels.push(chan.force_shutdown());
2471                                                 if let Ok(update) = self.get_channel_update(&chan) {
2472                                                         new_events.push(events::Event::BroadcastChannelUpdate {
2473                                                                 msg: update
2474                                                         });
2475                                                 }
2476                                                 false
2477                                         } else {
2478                                                 true
2479                                         }
2480                                 });
2481                         } else {
2482                                 channel_state.by_id.retain(|_, chan| {
2483                                         if chan.get_their_node_id() == *their_node_id {
2484                                                 //TODO: mark channel disabled (and maybe announce such after a timeout).
2485                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2486                                                 if !failed_adds.is_empty() {
2487                                                         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
2488                                                         failed_payments.push((chan_update, failed_adds));
2489                                                 }
2490                                                 if chan.is_shutdown() {
2491                                                         if let Some(short_id) = chan.get_short_channel_id() {
2492                                                                 short_to_id.remove(&short_id);
2493                                                         }
2494                                                         return false;
2495                                                 }
2496                                         }
2497                                         true
2498                                 })
2499                         }
2500                 }
2501                 for failure in failed_channels.drain(..) {
2502                         self.finish_force_close_channel(failure);
2503                 }
2504                 if !new_events.is_empty() {
2505                         let mut pending_events = self.pending_events.lock().unwrap();
2506                         for event in new_events.drain(..) {
2507                                 pending_events.push(event);
2508                         }
2509                 }
2510                 for (chan_update, mut htlc_sources) in failed_payments {
2511                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2512                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2513                         }
2514                 }
2515         }
2516
2517         fn peer_connected(&self, their_node_id: &PublicKey) -> Vec<msgs::ChannelReestablish> {
2518                 let mut res = Vec::new();
2519                 let mut channel_state = self.channel_state.lock().unwrap();
2520                 channel_state.by_id.retain(|_, chan| {
2521                         if chan.get_their_node_id() == *their_node_id {
2522                                 if !chan.have_received_message() {
2523                                         // If we created this (outbound) channel while we were disconnected from the
2524                                         // peer we probably failed to send the open_channel message, which is now
2525                                         // lost. We can't have had anything pending related to this channel, so we just
2526                                         // drop it.
2527                                         false
2528                                 } else {
2529                                         res.push(chan.get_channel_reestablish());
2530                                         true
2531                                 }
2532                         } else { true }
2533                 });
2534                 //TODO: Also re-broadcast announcement_signatures
2535                 res
2536         }
2537
2538         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2539                 if msg.channel_id == [0; 32] {
2540                         for chan in self.list_channels() {
2541                                 if chan.remote_network_id == *their_node_id {
2542                                         self.force_close_channel(&chan.channel_id);
2543                                 }
2544                         }
2545                 } else {
2546                         self.force_close_channel(&msg.channel_id);
2547                 }
2548         }
2549 }
2550
2551 #[cfg(test)]
2552 mod tests {
2553         use chain::chaininterface;
2554         use chain::transaction::OutPoint;
2555         use chain::chaininterface::ChainListener;
2556         use ln::channelmanager::{ChannelManager,OnionKeys};
2557         use ln::channelmonitor::{CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS};
2558         use ln::router::{Route, RouteHop, Router};
2559         use ln::msgs;
2560         use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
2561         use util::test_utils;
2562         use util::events::{Event, EventsProvider};
2563         use util::errors::APIError;
2564         use util::logger::Logger;
2565         use util::ser::Writeable;
2566
2567         use bitcoin::util::hash::Sha256dHash;
2568         use bitcoin::blockdata::block::{Block, BlockHeader};
2569         use bitcoin::blockdata::transaction::{Transaction, TxOut};
2570         use bitcoin::blockdata::constants::genesis_block;
2571         use bitcoin::network::constants::Network;
2572         use bitcoin::network::serialize::serialize;
2573         use bitcoin::network::serialize::BitcoinHash;
2574
2575         use hex;
2576
2577         use secp256k1::{Secp256k1, Message};
2578         use secp256k1::key::{PublicKey,SecretKey};
2579
2580         use crypto::sha2::Sha256;
2581         use crypto::digest::Digest;
2582
2583         use rand::{thread_rng,Rng};
2584
2585         use std::cell::RefCell;
2586         use std::collections::{BTreeSet, HashMap};
2587         use std::default::Default;
2588         use std::rc::Rc;
2589         use std::sync::{Arc, Mutex};
2590         use std::sync::atomic::Ordering;
2591         use std::time::Instant;
2592         use std::mem;
2593
2594         fn build_test_onion_keys() -> Vec<OnionKeys> {
2595                 // Keys from BOLT 4, used in both test vector tests
2596                 let secp_ctx = Secp256k1::new();
2597
2598                 let route = Route {
2599                         hops: vec!(
2600                                         RouteHop {
2601                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
2602                                                 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
2603                                         },
2604                                         RouteHop {
2605                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
2606                                                 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
2607                                         },
2608                                         RouteHop {
2609                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
2610                                                 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
2611                                         },
2612                                         RouteHop {
2613                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
2614                                                 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
2615                                         },
2616                                         RouteHop {
2617                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
2618                                                 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
2619                                         },
2620                         ),
2621                 };
2622
2623                 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
2624
2625                 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2626                 assert_eq!(onion_keys.len(), route.hops.len());
2627                 onion_keys
2628         }
2629
2630         #[test]
2631         fn onion_vectors() {
2632                 // Packet creation test vectors from BOLT 4
2633                 let onion_keys = build_test_onion_keys();
2634
2635                 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
2636                 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
2637                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
2638                 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
2639                 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
2640
2641                 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
2642                 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
2643                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
2644                 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
2645                 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
2646
2647                 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
2648                 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
2649                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
2650                 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
2651                 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
2652
2653                 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
2654                 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
2655                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
2656                 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
2657                 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
2658
2659                 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
2660                 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
2661                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
2662                 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
2663                 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
2664
2665                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
2666                 let payloads = vec!(
2667                         msgs::OnionHopData {
2668                                 realm: 0,
2669                                 data: msgs::OnionRealm0HopData {
2670                                         short_channel_id: 0,
2671                                         amt_to_forward: 0,
2672                                         outgoing_cltv_value: 0,
2673                                 },
2674                                 hmac: [0; 32],
2675                         },
2676                         msgs::OnionHopData {
2677                                 realm: 0,
2678                                 data: msgs::OnionRealm0HopData {
2679                                         short_channel_id: 0x0101010101010101,
2680                                         amt_to_forward: 0x0100000001,
2681                                         outgoing_cltv_value: 0,
2682                                 },
2683                                 hmac: [0; 32],
2684                         },
2685                         msgs::OnionHopData {
2686                                 realm: 0,
2687                                 data: msgs::OnionRealm0HopData {
2688                                         short_channel_id: 0x0202020202020202,
2689                                         amt_to_forward: 0x0200000002,
2690                                         outgoing_cltv_value: 0,
2691                                 },
2692                                 hmac: [0; 32],
2693                         },
2694                         msgs::OnionHopData {
2695                                 realm: 0,
2696                                 data: msgs::OnionRealm0HopData {
2697                                         short_channel_id: 0x0303030303030303,
2698                                         amt_to_forward: 0x0300000003,
2699                                         outgoing_cltv_value: 0,
2700                                 },
2701                                 hmac: [0; 32],
2702                         },
2703                         msgs::OnionHopData {
2704                                 realm: 0,
2705                                 data: msgs::OnionRealm0HopData {
2706                                         short_channel_id: 0x0404040404040404,
2707                                         amt_to_forward: 0x0400000004,
2708                                         outgoing_cltv_value: 0,
2709                                 },
2710                                 hmac: [0; 32],
2711                         },
2712                 );
2713
2714                 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]);
2715                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
2716                 // anyway...
2717                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
2718         }
2719
2720         #[test]
2721         fn test_failure_packet_onion() {
2722                 // Returning Errors test vectors from BOLT 4
2723
2724                 let onion_keys = build_test_onion_keys();
2725                 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
2726                 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
2727
2728                 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
2729                 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
2730
2731                 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
2732                 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
2733
2734                 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
2735                 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
2736
2737                 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
2738                 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
2739
2740                 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
2741                 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
2742         }
2743
2744         fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
2745                 assert!(chain.does_match_tx(tx));
2746                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2747                 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
2748                 for i in 2..100 {
2749                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2750                         chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
2751                 }
2752         }
2753
2754         struct Node {
2755                 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
2756                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
2757                 chan_monitor: Arc<test_utils::TestChannelMonitor>,
2758                 node: Arc<ChannelManager>,
2759                 router: Router,
2760                 network_payment_count: Rc<RefCell<u8>>,
2761                 network_chan_count: Rc<RefCell<u32>>,
2762         }
2763         impl Drop for Node {
2764                 fn drop(&mut self) {
2765                         if !::std::thread::panicking() {
2766                                 // Check that we processed all pending events
2767                                 assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
2768                                 assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
2769                         }
2770                 }
2771         }
2772
2773         fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2774                 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
2775         }
2776
2777         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) {
2778                 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
2779                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
2780                 (announcement, as_update, bs_update, channel_id, tx)
2781         }
2782
2783         fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
2784                 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
2785
2786                 let events_1 = node_a.node.get_and_clear_pending_events();
2787                 assert_eq!(events_1.len(), 1);
2788                 let accept_chan = match events_1[0] {
2789                         Event::SendOpenChannel { ref node_id, ref msg } => {
2790                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
2791                                 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), msg).unwrap()
2792                         },
2793                         _ => panic!("Unexpected event"),
2794                 };
2795
2796                 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap();
2797
2798                 let chan_id = *node_a.network_chan_count.borrow();
2799                 let tx;
2800                 let funding_output;
2801
2802                 let events_2 = node_a.node.get_and_clear_pending_events();
2803                 assert_eq!(events_2.len(), 1);
2804                 match events_2[0] {
2805                         Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
2806                                 assert_eq!(*channel_value_satoshis, channel_value);
2807                                 assert_eq!(user_channel_id, 42);
2808
2809                                 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
2810                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
2811                                 }]};
2812                                 funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
2813
2814                                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
2815                                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2816                                 assert_eq!(added_monitors.len(), 1);
2817                                 assert_eq!(added_monitors[0].0, funding_output);
2818                                 added_monitors.clear();
2819                         },
2820                         _ => panic!("Unexpected event"),
2821                 }
2822
2823                 let events_3 = node_a.node.get_and_clear_pending_events();
2824                 assert_eq!(events_3.len(), 1);
2825                 let funding_signed = match events_3[0] {
2826                         Event::SendFundingCreated { ref node_id, ref msg } => {
2827                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
2828                                 let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap();
2829                                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
2830                                 assert_eq!(added_monitors.len(), 1);
2831                                 assert_eq!(added_monitors[0].0, funding_output);
2832                                 added_monitors.clear();
2833                                 res
2834                         },
2835                         _ => panic!("Unexpected event"),
2836                 };
2837
2838                 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &funding_signed).unwrap();
2839                 {
2840                         let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2841                         assert_eq!(added_monitors.len(), 1);
2842                         assert_eq!(added_monitors[0].0, funding_output);
2843                         added_monitors.clear();
2844                 }
2845
2846                 let events_4 = node_a.node.get_and_clear_pending_events();
2847                 assert_eq!(events_4.len(), 1);
2848                 match events_4[0] {
2849                         Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
2850                                 assert_eq!(user_channel_id, 42);
2851                                 assert_eq!(*funding_txo, funding_output);
2852                         },
2853                         _ => panic!("Unexpected event"),
2854                 };
2855
2856                 tx
2857         }
2858
2859         fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
2860                 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
2861                 let events_5 = node_b.node.get_and_clear_pending_events();
2862                 assert_eq!(events_5.len(), 1);
2863                 match events_5[0] {
2864                         Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2865                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
2866                                 assert!(announcement_sigs.is_none());
2867                                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), msg).unwrap()
2868                         },
2869                         _ => panic!("Unexpected event"),
2870                 };
2871
2872                 let channel_id;
2873
2874                 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
2875                 let events_6 = node_a.node.get_and_clear_pending_events();
2876                 assert_eq!(events_6.len(), 1);
2877                 (match events_6[0] {
2878                         Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2879                                 channel_id = msg.channel_id.clone();
2880                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
2881                                 (msg.clone(), announcement_sigs.clone().unwrap())
2882                         },
2883                         _ => panic!("Unexpected event"),
2884                 }, channel_id)
2885         }
2886
2887         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) {
2888                 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
2889                 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
2890                 (msgs, chan_id, tx)
2891         }
2892
2893         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) {
2894                 let bs_announcement_sigs = {
2895                         let bs_announcement_sigs = node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap().unwrap();
2896                         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
2897                         bs_announcement_sigs
2898                 };
2899
2900                 let events_7 = node_b.node.get_and_clear_pending_events();
2901                 assert_eq!(events_7.len(), 1);
2902                 let (announcement, bs_update) = match events_7[0] {
2903                         Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2904                                 (msg, update_msg)
2905                         },
2906                         _ => panic!("Unexpected event"),
2907                 };
2908
2909                 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
2910                 let events_8 = node_a.node.get_and_clear_pending_events();
2911                 assert_eq!(events_8.len(), 1);
2912                 let as_update = match events_8[0] {
2913                         Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2914                                 assert!(*announcement == *msg);
2915                                 update_msg
2916                         },
2917                         _ => panic!("Unexpected event"),
2918                 };
2919
2920                 *node_a.network_chan_count.borrow_mut() += 1;
2921
2922                 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
2923         }
2924
2925         fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2926                 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
2927         }
2928
2929         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) {
2930                 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
2931                 for node in nodes {
2932                         assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
2933                         node.router.handle_channel_update(&chan_announcement.1).unwrap();
2934                         node.router.handle_channel_update(&chan_announcement.2).unwrap();
2935                 }
2936                 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
2937         }
2938
2939         macro_rules! check_spends {
2940                 ($tx: expr, $spends_tx: expr) => {
2941                         {
2942                                 let mut funding_tx_map = HashMap::new();
2943                                 let spends_tx = $spends_tx;
2944                                 funding_tx_map.insert(spends_tx.txid(), spends_tx);
2945                                 $tx.verify(&funding_tx_map).unwrap();
2946                         }
2947                 }
2948         }
2949
2950         fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate) {
2951                 let (node_a, broadcaster_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster) } else { (&outbound_node.node, &outbound_node.tx_broadcaster) };
2952                 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
2953                 let (tx_a, tx_b);
2954
2955                 node_a.close_channel(channel_id).unwrap();
2956                 let events_1 = node_a.get_and_clear_pending_events();
2957                 assert_eq!(events_1.len(), 1);
2958                 let shutdown_a = match events_1[0] {
2959                         Event::SendShutdown { ref node_id, ref msg } => {
2960                                 assert_eq!(node_id, &node_b.get_our_node_id());
2961                                 msg.clone()
2962                         },
2963                         _ => panic!("Unexpected event"),
2964                 };
2965
2966                 let (shutdown_b, mut closing_signed_b) = node_b.handle_shutdown(&node_a.get_our_node_id(), &shutdown_a).unwrap();
2967                 if !close_inbound_first {
2968                         assert!(closing_signed_b.is_none());
2969                 }
2970                 let (empty_a, mut closing_signed_a) = node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b.unwrap()).unwrap();
2971                 assert!(empty_a.is_none());
2972                 if close_inbound_first {
2973                         assert!(closing_signed_a.is_none());
2974                         closing_signed_a = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2975                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2976                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2977
2978                         let empty_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2979                         assert!(empty_b.is_none());
2980                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2981                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2982                 } else {
2983                         closing_signed_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2984                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2985                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2986
2987                         let empty_a2 = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2988                         assert!(empty_a2.is_none());
2989                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2990                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2991                 }
2992                 assert_eq!(tx_a, tx_b);
2993                 check_spends!(tx_a, funding_tx);
2994
2995                 let events_2 = node_a.get_and_clear_pending_events();
2996                 assert_eq!(events_2.len(), 1);
2997                 let as_update = match events_2[0] {
2998                         Event::BroadcastChannelUpdate { ref msg } => {
2999                                 msg.clone()
3000                         },
3001                         _ => panic!("Unexpected event"),
3002                 };
3003
3004                 let events_3 = node_b.get_and_clear_pending_events();
3005                 assert_eq!(events_3.len(), 1);
3006                 let bs_update = match events_3[0] {
3007                         Event::BroadcastChannelUpdate { ref msg } => {
3008                                 msg.clone()
3009                         },
3010                         _ => panic!("Unexpected event"),
3011                 };
3012
3013                 (as_update, bs_update)
3014         }
3015
3016         struct SendEvent {
3017                 node_id: PublicKey,
3018                 msgs: Vec<msgs::UpdateAddHTLC>,
3019                 commitment_msg: msgs::CommitmentSigned,
3020         }
3021         impl SendEvent {
3022                 fn from_event(event: Event) -> SendEvent {
3023                         match event {
3024                                 Event::UpdateHTLCs { node_id, updates: msgs::CommitmentUpdate { update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
3025                                         assert!(update_fulfill_htlcs.is_empty());
3026                                         assert!(update_fail_htlcs.is_empty());
3027                                         assert!(update_fail_malformed_htlcs.is_empty());
3028                                         assert!(update_fee.is_none());
3029                                         SendEvent { node_id: node_id, msgs: update_add_htlcs, commitment_msg: commitment_signed }
3030                                 },
3031                                 _ => panic!("Unexpected event type!"),
3032                         }
3033                 }
3034         }
3035
3036         macro_rules! check_added_monitors {
3037                 ($node: expr, $count: expr) => {
3038                         {
3039                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3040                                 assert_eq!(added_monitors.len(), $count);
3041                                 added_monitors.clear();
3042                         }
3043                 }
3044         }
3045
3046         macro_rules! commitment_signed_dance {
3047                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
3048                         {
3049                                 check_added_monitors!($node_a, 0);
3050                                 let (as_revoke_and_ack, as_commitment_signed) = $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3051                                 check_added_monitors!($node_a, 1);
3052                                 check_added_monitors!($node_b, 0);
3053                                 assert!($node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
3054                                 check_added_monitors!($node_b, 1);
3055                                 let (bs_revoke_and_ack, bs_none) = $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed.unwrap()).unwrap();
3056                                 assert!(bs_none.is_none());
3057                                 check_added_monitors!($node_b, 1);
3058                                 if $fail_backwards {
3059                                         assert!($node_a.node.get_and_clear_pending_events().is_empty());
3060                                 }
3061                                 assert!($node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
3062                                 {
3063                                         let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
3064                                         if $fail_backwards {
3065                                                 assert_eq!(added_monitors.len(), 2);
3066                                                 assert!(added_monitors[0].0 != added_monitors[1].0);
3067                                         } else {
3068                                                 assert_eq!(added_monitors.len(), 1);
3069                                         }
3070                                         added_monitors.clear();
3071                                 }
3072                         }
3073                 }
3074         }
3075
3076         macro_rules! get_payment_preimage_hash {
3077                 ($node: expr) => {
3078                         {
3079                                 let payment_preimage = [*$node.network_payment_count.borrow(); 32];
3080                                 *$node.network_payment_count.borrow_mut() += 1;
3081                                 let mut payment_hash = [0; 32];
3082                                 let mut sha = Sha256::new();
3083                                 sha.input(&payment_preimage[..]);
3084                                 sha.result(&mut payment_hash);
3085                                 (payment_preimage, payment_hash)
3086                         }
3087                 }
3088         }
3089
3090         fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3091                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3092
3093                 let mut payment_event = {
3094                         origin_node.node.send_payment(route, our_payment_hash).unwrap();
3095                         check_added_monitors!(origin_node, 1);
3096
3097                         let mut events = origin_node.node.get_and_clear_pending_events();
3098                         assert_eq!(events.len(), 1);
3099                         SendEvent::from_event(events.remove(0))
3100                 };
3101                 let mut prev_node = origin_node;
3102
3103                 for (idx, &node) in expected_route.iter().enumerate() {
3104                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
3105
3106                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3107                         check_added_monitors!(node, 0);
3108                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
3109
3110                         let events_1 = node.node.get_and_clear_pending_events();
3111                         assert_eq!(events_1.len(), 1);
3112                         match events_1[0] {
3113                                 Event::PendingHTLCsForwardable { .. } => { },
3114                                 _ => panic!("Unexpected event"),
3115                         };
3116
3117                         node.node.channel_state.lock().unwrap().next_forward = Instant::now();
3118                         node.node.process_pending_htlc_forwards();
3119
3120                         let mut events_2 = node.node.get_and_clear_pending_events();
3121                         assert_eq!(events_2.len(), 1);
3122                         if idx == expected_route.len() - 1 {
3123                                 match events_2[0] {
3124                                         Event::PaymentReceived { ref payment_hash, amt } => {
3125                                                 assert_eq!(our_payment_hash, *payment_hash);
3126                                                 assert_eq!(amt, recv_value);
3127                                         },
3128                                         _ => panic!("Unexpected event"),
3129                                 }
3130                         } else {
3131                                 check_added_monitors!(node, 1);
3132                                 payment_event = SendEvent::from_event(events_2.remove(0));
3133                                 assert_eq!(payment_event.msgs.len(), 1);
3134                         }
3135
3136                         prev_node = node;
3137                 }
3138
3139                 (our_payment_preimage, our_payment_hash)
3140         }
3141
3142         fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: [u8; 32]) {
3143                 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
3144                 check_added_monitors!(expected_route.last().unwrap(), 1);
3145
3146                 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
3147                 macro_rules! update_fulfill_dance {
3148                         ($node: expr, $prev_node: expr, $last_node: expr) => {
3149                                 {
3150                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3151                                         if $last_node {
3152                                                 check_added_monitors!($node, 0);
3153                                         } else {
3154                                                 check_added_monitors!($node, 1);
3155                                         }
3156                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3157                                 }
3158                         }
3159                 }
3160
3161                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3162                 let mut prev_node = expected_route.last().unwrap();
3163                 for (idx, node) in expected_route.iter().rev().enumerate() {
3164                         assert_eq!(expected_next_node, node.node.get_our_node_id());
3165                         if next_msgs.is_some() {
3166                                 update_fulfill_dance!(node, prev_node, false);
3167                         }
3168
3169                         let events = node.node.get_and_clear_pending_events();
3170                         if !skip_last || idx != expected_route.len() - 1 {
3171                                 assert_eq!(events.len(), 1);
3172                                 match events[0] {
3173                                         Event::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 } } => {
3174                                                 assert!(update_add_htlcs.is_empty());
3175                                                 assert_eq!(update_fulfill_htlcs.len(), 1);
3176                                                 assert!(update_fail_htlcs.is_empty());
3177                                                 assert!(update_fail_malformed_htlcs.is_empty());
3178                                                 assert!(update_fee.is_none());
3179                                                 expected_next_node = node_id.clone();
3180                                                 next_msgs = Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()));
3181                                         },
3182                                         _ => panic!("Unexpected event"),
3183                                 }
3184                         } else {
3185                                 assert!(events.is_empty());
3186                         }
3187                         if !skip_last && idx == expected_route.len() - 1 {
3188                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3189                         }
3190
3191                         prev_node = node;
3192                 }
3193
3194                 if !skip_last {
3195                         update_fulfill_dance!(origin_node, expected_route.first().unwrap(), true);
3196                         let events = origin_node.node.get_and_clear_pending_events();
3197                         assert_eq!(events.len(), 1);
3198                         match events[0] {
3199                                 Event::PaymentSent { payment_preimage } => {
3200                                         assert_eq!(payment_preimage, our_payment_preimage);
3201                                 },
3202                                 _ => panic!("Unexpected event"),
3203                         }
3204                 }
3205         }
3206
3207         fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
3208                 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
3209         }
3210
3211         const TEST_FINAL_CLTV: u32 = 32;
3212
3213         fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3214                 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();
3215                 assert_eq!(route.hops.len(), expected_route.len());
3216                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
3217                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
3218                 }
3219
3220                 send_along_route(origin_node, route, expected_route, recv_value)
3221         }
3222
3223         fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
3224                 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();
3225                 assert_eq!(route.hops.len(), expected_route.len());
3226                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
3227                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
3228                 }
3229
3230                 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3231
3232                 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
3233                 match err {
3234                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
3235                         _ => panic!("Unknown error variants"),
3236                 };
3237         }
3238
3239         fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
3240                 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
3241                 claim_payment(&origin, expected_route, our_payment_preimage);
3242         }
3243
3244         fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: [u8; 32]) {
3245                 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
3246                 check_added_monitors!(expected_route.last().unwrap(), 1);
3247
3248                 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
3249                 macro_rules! update_fail_dance {
3250                         ($node: expr, $prev_node: expr, $last_node: expr) => {
3251                                 {
3252                                         $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3253                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
3254                                 }
3255                         }
3256                 }
3257
3258                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3259                 let mut prev_node = expected_route.last().unwrap();
3260                 for (idx, node) in expected_route.iter().rev().enumerate() {
3261                         assert_eq!(expected_next_node, node.node.get_our_node_id());
3262                         if next_msgs.is_some() {
3263                                 // We may be the "last node" for the purpose of the commitment dance if we're
3264                                 // skipping the last node (implying it is disconnected) and we're the
3265                                 // second-to-last node!
3266                                 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
3267                         }
3268
3269                         let events = node.node.get_and_clear_pending_events();
3270                         if !skip_last || idx != expected_route.len() - 1 {
3271                                 assert_eq!(events.len(), 1);
3272                                 match events[0] {
3273                                         Event::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 } } => {
3274                                                 assert!(update_add_htlcs.is_empty());
3275                                                 assert!(update_fulfill_htlcs.is_empty());
3276                                                 assert_eq!(update_fail_htlcs.len(), 1);
3277                                                 assert!(update_fail_malformed_htlcs.is_empty());
3278                                                 assert!(update_fee.is_none());
3279                                                 expected_next_node = node_id.clone();
3280                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
3281                                         },
3282                                         _ => panic!("Unexpected event"),
3283                                 }
3284                         } else {
3285                                 assert!(events.is_empty());
3286                         }
3287                         if !skip_last && idx == expected_route.len() - 1 {
3288                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3289                         }
3290
3291                         prev_node = node;
3292                 }
3293
3294                 if !skip_last {
3295                         update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
3296
3297                         let events = origin_node.node.get_and_clear_pending_events();
3298                         assert_eq!(events.len(), 1);
3299                         match events[0] {
3300                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
3301                                         assert_eq!(payment_hash, our_payment_hash);
3302                                         assert!(rejected_by_dest);
3303                                 },
3304                                 _ => panic!("Unexpected event"),
3305                         }
3306                 }
3307         }
3308
3309         fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
3310                 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
3311         }
3312
3313         fn create_network(node_count: usize) -> Vec<Node> {
3314                 let mut nodes = Vec::new();
3315                 let mut rng = thread_rng();
3316                 let secp_ctx = Secp256k1::new();
3317                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3318
3319                 let chan_count = Rc::new(RefCell::new(0));
3320                 let payment_count = Rc::new(RefCell::new(0));
3321
3322                 for _ in 0..node_count {
3323                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
3324                         let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
3325                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
3326                         let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
3327                         let node_id = {
3328                                 let mut key_slice = [0; 32];
3329                                 rng.fill_bytes(&mut key_slice);
3330                                 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
3331                         };
3332                         let node = ChannelManager::new(node_id.clone(), 0, true, Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger)).unwrap();
3333                         let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &node_id), chain_monitor.clone(), Arc::clone(&logger));
3334                         nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router,
3335                                 network_payment_count: payment_count.clone(),
3336                                 network_chan_count: chan_count.clone(),
3337                         });
3338                 }
3339
3340                 nodes
3341         }
3342
3343         #[test]
3344         fn test_async_inbound_update_fee() {
3345                 let mut nodes = create_network(2);
3346                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3347                 let channel_id = chan.2;
3348
3349                 macro_rules! get_feerate {
3350                         ($node: expr) => {{
3351                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3352                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3353                                 chan.get_feerate()
3354                         }}
3355                 }
3356
3357                 // balancing
3358                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3359
3360                 // A                                        B
3361                 // update_fee                            ->
3362                 // send (1) commitment_signed            -.
3363                 //                                       <- update_add_htlc/commitment_signed
3364                 // send (2) RAA (awaiting remote revoke) -.
3365                 // (1) commitment_signed is delivered    ->
3366                 //                                       .- send (3) RAA (awaiting remote revoke)
3367                 // (2) RAA is delivered                  ->
3368                 //                                       .- send (4) commitment_signed
3369                 //                                       <- (3) RAA is delivered
3370                 // send (5) commitment_signed            -.
3371                 //                                       <- (4) commitment_signed is delivered
3372                 // send (6) RAA                          -.
3373                 // (5) commitment_signed is delivered    ->
3374                 //                                       <- RAA
3375                 // (6) RAA is delivered                  ->
3376
3377                 // First nodes[0] generates an update_fee
3378                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0]) + 20).unwrap();
3379                 check_added_monitors!(nodes[0], 1);
3380
3381                 let events_0 = nodes[0].node.get_and_clear_pending_events();
3382                 assert_eq!(events_0.len(), 1);
3383                 let (update_msg, commitment_signed) = match events_0[0] { // (1)
3384                         Event::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
3385                                 (update_fee.as_ref(), commitment_signed)
3386                         },
3387                         _ => panic!("Unexpected event"),
3388                 };
3389
3390                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3391
3392                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
3393                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3394                 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();
3395                 check_added_monitors!(nodes[1], 1);
3396
3397                 let payment_event = {
3398                         let mut events_1 = nodes[1].node.get_and_clear_pending_events();
3399                         assert_eq!(events_1.len(), 1);
3400                         SendEvent::from_event(events_1.remove(0))
3401                 };
3402                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
3403                 assert_eq!(payment_event.msgs.len(), 1);
3404
3405                 // ...now when the messages get delivered everyone should be happy
3406                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3407                 let (as_revoke_msg, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
3408                 assert!(as_commitment_signed.is_none()); // nodes[0] is awaiting nodes[1] revoke_and_ack
3409                 check_added_monitors!(nodes[0], 1);
3410
3411                 // deliver(1), generate (3):
3412                 let (bs_revoke_msg, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3413                 assert!(bs_commitment_signed.is_none()); // nodes[1] is awaiting nodes[0] revoke_and_ack
3414                 check_added_monitors!(nodes[1], 1);
3415
3416                 let bs_update = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
3417                 assert!(bs_update.as_ref().unwrap().update_add_htlcs.is_empty()); // (4)
3418                 assert!(bs_update.as_ref().unwrap().update_fulfill_htlcs.is_empty()); // (4)
3419                 assert!(bs_update.as_ref().unwrap().update_fail_htlcs.is_empty()); // (4)
3420                 assert!(bs_update.as_ref().unwrap().update_fail_malformed_htlcs.is_empty()); // (4)
3421                 assert!(bs_update.as_ref().unwrap().update_fee.is_none()); // (4)
3422                 check_added_monitors!(nodes[1], 1);
3423
3424                 let as_update = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap(); // deliver (3)
3425                 assert!(as_update.as_ref().unwrap().update_add_htlcs.is_empty()); // (5)
3426                 assert!(as_update.as_ref().unwrap().update_fulfill_htlcs.is_empty()); // (5)
3427                 assert!(as_update.as_ref().unwrap().update_fail_htlcs.is_empty()); // (5)
3428                 assert!(as_update.as_ref().unwrap().update_fail_malformed_htlcs.is_empty()); // (5)
3429                 assert!(as_update.as_ref().unwrap().update_fee.is_none()); // (5)
3430                 check_added_monitors!(nodes[0], 1);
3431
3432                 let (as_second_revoke, as_second_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.unwrap().commitment_signed).unwrap(); // deliver (4)
3433                 assert!(as_second_commitment_signed.is_none()); // only (6)
3434                 check_added_monitors!(nodes[0], 1);
3435
3436                 let (bs_second_revoke, bs_second_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.unwrap().commitment_signed).unwrap(); // deliver (5)
3437                 assert!(bs_second_commitment_signed.is_none());
3438                 check_added_monitors!(nodes[1], 1);
3439
3440                 assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap().is_none());
3441                 check_added_monitors!(nodes[0], 1);
3442
3443                 let events_2 = nodes[0].node.get_and_clear_pending_events();
3444                 assert_eq!(events_2.len(), 1);
3445                 match events_2[0] {
3446                         Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
3447                         _ => panic!("Unexpected event"),
3448                 }
3449
3450                 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap().is_none()); // deliver (6)
3451                 check_added_monitors!(nodes[1], 1);
3452         }
3453
3454         #[test]
3455         fn test_update_fee_unordered_raa() {
3456                 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
3457                 // crash in an earlier version of the update_fee patch)
3458                 let mut nodes = create_network(2);
3459                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3460                 let channel_id = chan.2;
3461
3462                 macro_rules! get_feerate {
3463                         ($node: expr) => {{
3464                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3465                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3466                                 chan.get_feerate()
3467                         }}
3468                 }
3469
3470                 // balancing
3471                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3472
3473                 // First nodes[0] generates an update_fee
3474                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0]) + 20).unwrap();
3475                 check_added_monitors!(nodes[0], 1);
3476
3477                 let events_0 = nodes[0].node.get_and_clear_pending_events();
3478                 assert_eq!(events_0.len(), 1);
3479                 let update_msg = match events_0[0] { // (1)
3480                         Event::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
3481                                 update_fee.as_ref()
3482                         },
3483                         _ => panic!("Unexpected event"),
3484                 };
3485
3486                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3487
3488                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
3489                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3490                 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();
3491                 check_added_monitors!(nodes[1], 1);
3492
3493                 let payment_event = {
3494                         let mut events_1 = nodes[1].node.get_and_clear_pending_events();
3495                         assert_eq!(events_1.len(), 1);
3496                         SendEvent::from_event(events_1.remove(0))
3497                 };
3498                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
3499                 assert_eq!(payment_event.msgs.len(), 1);
3500
3501                 // ...now when the messages get delivered everyone should be happy
3502                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3503                 let (as_revoke_msg, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
3504                 assert!(as_commitment_signed.is_none()); // nodes[0] is awaiting nodes[1] revoke_and_ack
3505                 check_added_monitors!(nodes[0], 1);
3506
3507                 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap().is_none()); // deliver (2)
3508                 check_added_monitors!(nodes[1], 1);
3509
3510                 // We can't continue, sadly, because our (1) now has a bogus signature
3511         }
3512
3513         #[test]
3514         fn test_multi_flight_update_fee() {
3515                 let nodes = create_network(2);
3516                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3517                 let channel_id = chan.2;
3518
3519                 macro_rules! get_feerate {
3520                         ($node: expr) => {{
3521                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3522                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3523                                 chan.get_feerate()
3524                         }}
3525                 }
3526
3527                 // A                                        B
3528                 // update_fee/commitment_signed          ->
3529                 //                                       .- send (1) RAA and (2) commitment_signed
3530                 // update_fee (never committed)          ->
3531                 // (3) update_fee                        ->
3532                 // We have to manually generate the above update_fee, it is allowed by the protocol but we
3533                 // don't track which updates correspond to which revoke_and_ack responses so we're in
3534                 // AwaitingRAA mode and will not generate the update_fee yet.
3535                 //                                       <- (1) RAA delivered
3536                 // (3) is generated and send (4) CS      -.
3537                 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
3538                 // know the per_commitment_point to use for it.
3539                 //                                       <- (2) commitment_signed delivered
3540                 // revoke_and_ack                        ->
3541                 //                                          B should send no response here
3542                 // (4) commitment_signed delivered       ->
3543                 //                                       <- RAA/commitment_signed delivered
3544                 // revoke_and_ack                        ->
3545
3546                 // First nodes[0] generates an update_fee
3547                 let initial_feerate = get_feerate!(nodes[0]);
3548                 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
3549                 check_added_monitors!(nodes[0], 1);
3550
3551                 let events_0 = nodes[0].node.get_and_clear_pending_events();
3552                 assert_eq!(events_0.len(), 1);
3553                 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
3554                         Event::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
3555                                 (update_fee.as_ref().unwrap(), commitment_signed)
3556                         },
3557                         _ => panic!("Unexpected event"),
3558                 };
3559
3560                 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
3561                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
3562                 let (bs_revoke_msg, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
3563                 check_added_monitors!(nodes[1], 1);
3564
3565                 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
3566                 // transaction:
3567                 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
3568                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3569
3570                 // Create the (3) update_fee message that nodes[0] will generate before it does...
3571                 let mut update_msg_2 = msgs::UpdateFee {
3572                         channel_id: update_msg_1.channel_id.clone(),
3573                         feerate_per_kw: (initial_feerate + 30) as u32,
3574                 };
3575
3576                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
3577
3578                 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
3579                 // Deliver (3)
3580                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
3581
3582                 // Deliver (1), generating (3) and (4)
3583                 let as_second_update = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
3584                 check_added_monitors!(nodes[0], 1);
3585                 assert!(as_second_update.as_ref().unwrap().update_add_htlcs.is_empty());
3586                 assert!(as_second_update.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3587                 assert!(as_second_update.as_ref().unwrap().update_fail_htlcs.is_empty());
3588                 assert!(as_second_update.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3589                 // Check that the update_fee newly generated matches what we delivered:
3590                 assert_eq!(as_second_update.as_ref().unwrap().update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
3591                 assert_eq!(as_second_update.as_ref().unwrap().update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
3592
3593                 // Deliver (2) commitment_signed
3594                 let (as_revoke_msg, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), bs_commitment_signed.as_ref().unwrap()).unwrap();
3595                 check_added_monitors!(nodes[0], 1);
3596                 assert!(as_commitment_signed.is_none());
3597
3598                 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap().is_none());
3599                 check_added_monitors!(nodes[1], 1);
3600
3601                 // Delever (4)
3602                 let (bs_second_revoke, bs_second_commitment) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.unwrap().commitment_signed).unwrap();
3603                 check_added_monitors!(nodes[1], 1);
3604
3605                 assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap().is_none());
3606                 check_added_monitors!(nodes[0], 1);
3607
3608                 let (as_second_revoke, as_second_commitment) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment.unwrap()).unwrap();
3609                 assert!(as_second_commitment.is_none());
3610                 check_added_monitors!(nodes[0], 1);
3611
3612                 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap().is_none());
3613                 check_added_monitors!(nodes[1], 1);
3614         }
3615
3616         #[test]
3617         fn test_update_fee_vanilla() {
3618                 let nodes = create_network(2);
3619                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3620                 let channel_id = chan.2;
3621
3622                 macro_rules! get_feerate {
3623                         ($node: expr) => {{
3624                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3625                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3626                                 chan.get_feerate()
3627                         }}
3628                 }
3629
3630                 let feerate = get_feerate!(nodes[0]);
3631                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
3632
3633                 let events_0 = nodes[0].node.get_and_clear_pending_events();
3634                 assert_eq!(events_0.len(), 1);
3635                 let (update_msg, commitment_signed) = match events_0[0] {
3636                                 Event::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 } } => {
3637                                 (update_fee.as_ref(), commitment_signed)
3638                         },
3639                         _ => panic!("Unexpected event"),
3640                 };
3641                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3642
3643                 let (revoke_msg, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3644                 let commitment_signed = commitment_signed.unwrap();
3645                 check_added_monitors!(nodes[0], 1);
3646                 check_added_monitors!(nodes[1], 1);
3647
3648                 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3649                 assert!(resp_option.is_none());
3650                 check_added_monitors!(nodes[0], 1);
3651
3652                 let (revoke_msg, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3653                 assert!(commitment_signed.is_none());
3654                 check_added_monitors!(nodes[0], 1);
3655
3656                 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
3657                 assert!(resp_option.is_none());
3658                 check_added_monitors!(nodes[1], 1);
3659         }
3660
3661         #[test]
3662         fn test_update_fee_with_fundee_update_add_htlc() {
3663                 let mut nodes = create_network(2);
3664                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3665                 let channel_id = chan.2;
3666
3667                 macro_rules! get_feerate {
3668                         ($node: expr) => {{
3669                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3670                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3671                                 chan.get_feerate()
3672                         }}
3673                 }
3674
3675                 // balancing
3676                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3677
3678                 let feerate = get_feerate!(nodes[0]);
3679                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
3680
3681                 let events_0 = nodes[0].node.get_and_clear_pending_events();
3682                 assert_eq!(events_0.len(), 1);
3683                 let (update_msg, commitment_signed) = match events_0[0] {
3684                                 Event::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 } } => {
3685                                 (update_fee.as_ref(), commitment_signed)
3686                         },
3687                         _ => panic!("Unexpected event"),
3688                 };
3689                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3690                 check_added_monitors!(nodes[0], 1);
3691                 let (revoke_msg, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3692                 let commitment_signed = commitment_signed.unwrap();
3693                 check_added_monitors!(nodes[1], 1);
3694
3695                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
3696
3697                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
3698
3699                 // nothing happens since node[1] is in AwaitingRemoteRevoke
3700                 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
3701                 {
3702                         let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
3703                         assert_eq!(added_monitors.len(), 0);
3704                         added_monitors.clear();
3705                 }
3706                 let events = nodes[0].node.get_and_clear_pending_events();
3707                 assert_eq!(events.len(), 0);
3708                 // node[1] has nothing to do
3709
3710                 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3711                 assert!(resp_option.is_none());
3712                 check_added_monitors!(nodes[0], 1);
3713
3714                 let (revoke_msg, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3715                 assert!(commitment_signed.is_none());
3716                 check_added_monitors!(nodes[0], 1);
3717                 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
3718                 // AwaitingRemoteRevoke ends here
3719
3720                 let commitment_update = resp_option.unwrap();
3721                 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
3722                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
3723                 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
3724                 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
3725                 assert_eq!(commitment_update.update_fee.is_none(), true);
3726
3727                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
3728                 let (revoke, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3729                 check_added_monitors!(nodes[0], 1);
3730                 check_added_monitors!(nodes[1], 1);
3731                 let commitment_signed = commitment_signed.unwrap();
3732                 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
3733                 check_added_monitors!(nodes[1], 1);
3734                 assert!(resp_option.is_none());
3735
3736                 let (revoke, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
3737                 check_added_monitors!(nodes[1], 1);
3738                 assert!(commitment_signed.is_none());
3739                 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
3740                 check_added_monitors!(nodes[0], 1);
3741                 assert!(resp_option.is_none());
3742
3743                 let events = nodes[0].node.get_and_clear_pending_events();
3744                 assert_eq!(events.len(), 1);
3745                 match events[0] {
3746                         Event::PendingHTLCsForwardable { .. } => { },
3747                         _ => panic!("Unexpected event"),
3748                 };
3749                 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
3750                 nodes[0].node.process_pending_htlc_forwards();
3751
3752                 let events = nodes[0].node.get_and_clear_pending_events();
3753                 assert_eq!(events.len(), 1);
3754                 match events[0] {
3755                         Event::PaymentReceived { .. } => { },
3756                         _ => panic!("Unexpected event"),
3757                 };
3758
3759                 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
3760
3761                 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
3762                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
3763                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
3764         }
3765
3766         #[test]
3767         fn test_update_fee() {
3768                 let nodes = create_network(2);
3769                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3770                 let channel_id = chan.2;
3771
3772                 macro_rules! get_feerate {
3773                         ($node: expr) => {{
3774                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3775                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3776                                 chan.get_feerate()
3777                         }}
3778                 }
3779
3780                 // A                                        B
3781                 // (1) update_fee/commitment_signed      ->
3782                 //                                       <- (2) revoke_and_ack
3783                 //                                       .- send (3) commitment_signed
3784                 // (4) update_fee/commitment_signed      ->
3785                 //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
3786                 //                                       <- (3) commitment_signed delivered
3787                 // send (6) revoke_and_ack               -.
3788                 //                                       <- (5) deliver revoke_and_ack
3789                 // (6) deliver revoke_and_ack            ->
3790                 //                                       .- send (7) commitment_signed in response to (4)
3791                 //                                       <- (7) deliver commitment_signed
3792                 // revoke_and_ack                        ->
3793
3794                 // Create and deliver (1)...
3795                 let feerate = get_feerate!(nodes[0]);
3796                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
3797
3798                 let events_0 = nodes[0].node.get_and_clear_pending_events();
3799                 assert_eq!(events_0.len(), 1);
3800                 let (update_msg, commitment_signed) = match events_0[0] {
3801                                 Event::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 } } => {
3802                                 (update_fee.as_ref(), commitment_signed)
3803                         },
3804                         _ => panic!("Unexpected event"),
3805                 };
3806                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3807
3808                 // Generate (2) and (3):
3809                 let (revoke_msg, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3810                 let commitment_signed_0 = commitment_signed.unwrap();
3811                 check_added_monitors!(nodes[0], 1);
3812                 check_added_monitors!(nodes[1], 1);
3813
3814                 // Deliver (2):
3815                 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3816                 assert!(resp_option.is_none());
3817                 check_added_monitors!(nodes[0], 1);
3818
3819                 // Create and deliver (4)...
3820                 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
3821                 let events_0 = nodes[0].node.get_and_clear_pending_events();
3822                 assert_eq!(events_0.len(), 1);
3823                 let (update_msg, commitment_signed) = match events_0[0] {
3824                                 Event::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 } } => {
3825                                 (update_fee.as_ref(), commitment_signed)
3826                         },
3827                         _ => panic!("Unexpected event"),
3828                 };
3829                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3830
3831                 let (revoke_msg, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3832                 // ... creating (5)
3833                 assert!(commitment_signed.is_none());
3834                 check_added_monitors!(nodes[0], 1);
3835                 check_added_monitors!(nodes[1], 1);
3836
3837                 // Handle (3), creating (6):
3838                 let (revoke_msg_0, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
3839                 assert!(commitment_signed.is_none());
3840                 check_added_monitors!(nodes[0], 1);
3841
3842                 // Deliver (5):
3843                 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3844                 assert!(resp_option.is_none());
3845                 check_added_monitors!(nodes[0], 1);
3846
3847                 // Deliver (6), creating (7):
3848                 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
3849                 let commitment_signed = resp_option.unwrap().commitment_signed;
3850                 check_added_monitors!(nodes[1], 1);
3851
3852                 // Deliver (7)
3853                 let (revoke_msg, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3854                 assert!(commitment_signed.is_none());
3855                 check_added_monitors!(nodes[0], 1);
3856                 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
3857                 assert!(resp_option.is_none());
3858                 check_added_monitors!(nodes[1], 1);
3859
3860                 assert_eq!(get_feerate!(nodes[0]), feerate + 30);
3861                 assert_eq!(get_feerate!(nodes[1]), feerate + 30);
3862                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
3863         }
3864
3865         #[test]
3866         fn fake_network_test() {
3867                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
3868                 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
3869                 let nodes = create_network(4);
3870
3871                 // Create some initial channels
3872                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3873                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3874                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
3875
3876                 // Rebalance the network a bit by relaying one payment through all the channels...
3877                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
3878                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
3879                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
3880                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
3881
3882                 // Send some more payments
3883                 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
3884                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
3885                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
3886
3887                 // Test failure packets
3888                 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
3889                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
3890
3891                 // Add a new channel that skips 3
3892                 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
3893
3894                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
3895                 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
3896                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3897                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3898                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3899                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3900                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3901
3902                 // Do some rebalance loop payments, simultaneously
3903                 let mut hops = Vec::with_capacity(3);
3904                 hops.push(RouteHop {
3905                         pubkey: nodes[2].node.get_our_node_id(),
3906                         short_channel_id: chan_2.0.contents.short_channel_id,
3907                         fee_msat: 0,
3908                         cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
3909                 });
3910                 hops.push(RouteHop {
3911                         pubkey: nodes[3].node.get_our_node_id(),
3912                         short_channel_id: chan_3.0.contents.short_channel_id,
3913                         fee_msat: 0,
3914                         cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
3915                 });
3916                 hops.push(RouteHop {
3917                         pubkey: nodes[1].node.get_our_node_id(),
3918                         short_channel_id: chan_4.0.contents.short_channel_id,
3919                         fee_msat: 1000000,
3920                         cltv_expiry_delta: TEST_FINAL_CLTV,
3921                 });
3922                 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;
3923                 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;
3924                 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
3925
3926                 let mut hops = Vec::with_capacity(3);
3927                 hops.push(RouteHop {
3928                         pubkey: nodes[3].node.get_our_node_id(),
3929                         short_channel_id: chan_4.0.contents.short_channel_id,
3930                         fee_msat: 0,
3931                         cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
3932                 });
3933                 hops.push(RouteHop {
3934                         pubkey: nodes[2].node.get_our_node_id(),
3935                         short_channel_id: chan_3.0.contents.short_channel_id,
3936                         fee_msat: 0,
3937                         cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
3938                 });
3939                 hops.push(RouteHop {
3940                         pubkey: nodes[1].node.get_our_node_id(),
3941                         short_channel_id: chan_2.0.contents.short_channel_id,
3942                         fee_msat: 1000000,
3943                         cltv_expiry_delta: TEST_FINAL_CLTV,
3944                 });
3945                 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;
3946                 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;
3947                 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
3948
3949                 // Claim the rebalances...
3950                 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
3951                 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
3952
3953                 // Add a duplicate new channel from 2 to 4
3954                 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
3955
3956                 // Send some payments across both channels
3957                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3958                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3959                 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3960
3961                 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
3962
3963                 //TODO: Test that routes work again here as we've been notified that the channel is full
3964
3965                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
3966                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
3967                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
3968
3969                 // Close down the channels...
3970                 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
3971                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
3972                 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
3973                 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
3974                 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
3975         }
3976
3977         #[test]
3978         fn duplicate_htlc_test() {
3979                 // Test that we accept duplicate payment_hash HTLCs across the network and that
3980                 // claiming/failing them are all separate and don't effect each other
3981                 let mut nodes = create_network(6);
3982
3983                 // Create some initial channels to route via 3 to 4/5 from 0/1/2
3984                 create_announced_chan_between_nodes(&nodes, 0, 3);
3985                 create_announced_chan_between_nodes(&nodes, 1, 3);
3986                 create_announced_chan_between_nodes(&nodes, 2, 3);
3987                 create_announced_chan_between_nodes(&nodes, 3, 4);
3988                 create_announced_chan_between_nodes(&nodes, 3, 5);
3989
3990                 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
3991
3992                 *nodes[0].network_payment_count.borrow_mut() -= 1;
3993                 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
3994
3995                 *nodes[0].network_payment_count.borrow_mut() -= 1;
3996                 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
3997
3998                 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
3999                 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
4000                 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
4001         }
4002
4003         #[derive(PartialEq)]
4004         enum HTLCType { NONE, TIMEOUT, SUCCESS }
4005         /// Tests that the given node has broadcast transactions for the given Channel
4006         ///
4007         /// First checks that the latest local commitment tx has been broadcast, unless an explicit
4008         /// commitment_tx is provided, which may be used to test that a remote commitment tx was
4009         /// broadcast and the revoked outputs were claimed.
4010         ///
4011         /// Next tests that there is (or is not) a transaction that spends the commitment transaction
4012         /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
4013         ///
4014         /// All broadcast transactions must be accounted for in one of the above three types of we'll
4015         /// also fail.
4016         fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
4017                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4018                 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
4019
4020                 let mut res = Vec::with_capacity(2);
4021                 node_txn.retain(|tx| {
4022                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
4023                                 check_spends!(tx, chan.3.clone());
4024                                 if commitment_tx.is_none() {
4025                                         res.push(tx.clone());
4026                                 }
4027                                 false
4028                         } else { true }
4029                 });
4030                 if let Some(explicit_tx) = commitment_tx {
4031                         res.push(explicit_tx.clone());
4032                 }
4033
4034                 assert_eq!(res.len(), 1);
4035
4036                 if has_htlc_tx != HTLCType::NONE {
4037                         node_txn.retain(|tx| {
4038                                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
4039                                         check_spends!(tx, res[0].clone());
4040                                         if has_htlc_tx == HTLCType::TIMEOUT {
4041                                                 assert!(tx.lock_time != 0);
4042                                         } else {
4043                                                 assert!(tx.lock_time == 0);
4044                                         }
4045                                         res.push(tx.clone());
4046                                         false
4047                                 } else { true }
4048                         });
4049                         assert_eq!(res.len(), 2);
4050                 }
4051
4052                 assert!(node_txn.is_empty());
4053                 res
4054         }
4055
4056         /// Tests that the given node has broadcast a claim transaction against the provided revoked
4057         /// HTLC transaction.
4058         fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
4059                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4060                 assert_eq!(node_txn.len(), 1);
4061                 node_txn.retain(|tx| {
4062                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
4063                                 check_spends!(tx, revoked_tx.clone());
4064                                 false
4065                         } else { true }
4066                 });
4067                 assert!(node_txn.is_empty());
4068         }
4069
4070         fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
4071                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4072
4073                 assert!(node_txn.len() >= 1);
4074                 assert_eq!(node_txn[0].input.len(), 1);
4075                 let mut found_prev = false;
4076
4077                 for tx in prev_txn {
4078                         if node_txn[0].input[0].previous_output.txid == tx.txid() {
4079                                 check_spends!(node_txn[0], tx.clone());
4080                                 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
4081                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
4082
4083                                 found_prev = true;
4084                                 break;
4085                         }
4086                 }
4087                 assert!(found_prev);
4088
4089                 let mut res = Vec::new();
4090                 mem::swap(&mut *node_txn, &mut res);
4091                 res
4092         }
4093
4094         fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
4095                 let events_1 = nodes[a].node.get_and_clear_pending_events();
4096                 assert_eq!(events_1.len(), 1);
4097                 let as_update = match events_1[0] {
4098                         Event::BroadcastChannelUpdate { ref msg } => {
4099                                 msg.clone()
4100                         },
4101                         _ => panic!("Unexpected event"),
4102                 };
4103
4104                 let events_2 = nodes[b].node.get_and_clear_pending_events();
4105                 assert_eq!(events_2.len(), 1);
4106                 let bs_update = match events_2[0] {
4107                         Event::BroadcastChannelUpdate { ref msg } => {
4108                                 msg.clone()
4109                         },
4110                         _ => panic!("Unexpected event"),
4111                 };
4112
4113                 for node in nodes {
4114                         node.router.handle_channel_update(&as_update).unwrap();
4115                         node.router.handle_channel_update(&bs_update).unwrap();
4116                 }
4117         }
4118
4119         #[test]
4120         fn channel_reserve_test() {
4121                 use util::rng;
4122                 use std::sync::atomic::Ordering;
4123                 use ln::msgs::HandleError;
4124
4125                 macro_rules! get_channel_value_stat {
4126                         ($node: expr, $channel_id: expr) => {{
4127                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4128                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
4129                                 chan.get_value_stat()
4130                         }}
4131                 }
4132
4133                 let mut nodes = create_network(3);
4134                 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
4135                 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
4136
4137                 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
4138                 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
4139
4140                 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
4141                 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
4142
4143                 macro_rules! get_route_and_payment_hash {
4144                         ($recv_value: expr) => {{
4145                                 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
4146                                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4147                                 (route, payment_hash, payment_preimage)
4148                         }}
4149                 };
4150
4151                 macro_rules! expect_pending_htlcs_forwardable {
4152                         ($node: expr) => {{
4153                                 let events = $node.node.get_and_clear_pending_events();
4154                                 assert_eq!(events.len(), 1);
4155                                 match events[0] {
4156                                         Event::PendingHTLCsForwardable { .. } => { },
4157                                         _ => panic!("Unexpected event"),
4158                                 };
4159                                 $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
4160                                 $node.node.process_pending_htlc_forwards();
4161                         }}
4162                 };
4163
4164                 macro_rules! expect_forward {
4165                         ($node: expr) => {{
4166                                 let mut events = $node.node.get_and_clear_pending_events();
4167                                 assert_eq!(events.len(), 1);
4168                                 check_added_monitors!($node, 1);
4169                                 let payment_event = SendEvent::from_event(events.remove(0));
4170                                 payment_event
4171                         }}
4172                 }
4173
4174                 macro_rules! expect_payment_received {
4175                         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
4176                                 let events = $node.node.get_and_clear_pending_events();
4177                                 assert_eq!(events.len(), 1);
4178                                 match events[0] {
4179                                         Event::PaymentReceived { ref payment_hash, amt } => {
4180                                                 assert_eq!($expected_payment_hash, *payment_hash);
4181                                                 assert_eq!($expected_recv_value, amt);
4182                                         },
4183                                         _ => panic!("Unexpected event"),
4184                                 }
4185                         }
4186                 };
4187
4188                 let feemsat = 239; // somehow we know?
4189                 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
4190
4191                 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
4192
4193                 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
4194                 {
4195                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
4196                         assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
4197                         let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
4198                         match err {
4199                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
4200                                 _ => panic!("Unknown error variants"),
4201                         }
4202                 }
4203
4204                 let mut htlc_id = 0;
4205                 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
4206                 // nodes[0]'s wealth
4207                 loop {
4208                         let amt_msat = recv_value_0 + total_fee_msat;
4209                         if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
4210                                 break;
4211                         }
4212                         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
4213                         htlc_id += 1;
4214
4215                         let (stat01_, stat11_, stat12_, stat22_) = (
4216                                 get_channel_value_stat!(nodes[0], chan_1.2),
4217                                 get_channel_value_stat!(nodes[1], chan_1.2),
4218                                 get_channel_value_stat!(nodes[1], chan_2.2),
4219                                 get_channel_value_stat!(nodes[2], chan_2.2),
4220                         );
4221
4222                         assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
4223                         assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
4224                         assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
4225                         assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
4226                         stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
4227                 }
4228
4229                 {
4230                         let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
4231                         // attempt to get channel_reserve violation
4232                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
4233                         let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
4234                         match err {
4235                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4236                                 _ => panic!("Unknown error variants"),
4237                         }
4238                 }
4239
4240                 // adding pending output
4241                 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
4242                 let amt_msat_1 = recv_value_1 + total_fee_msat;
4243
4244                 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
4245                 let payment_event_1 = {
4246                         nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
4247                         check_added_monitors!(nodes[0], 1);
4248
4249                         let mut events = nodes[0].node.get_and_clear_pending_events();
4250                         assert_eq!(events.len(), 1);
4251                         SendEvent::from_event(events.remove(0))
4252                 };
4253                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
4254
4255                 // channel reserve test with htlc pending output > 0
4256                 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
4257                 {
4258                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
4259                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
4260                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4261                                 _ => panic!("Unknown error variants"),
4262                         }
4263                 }
4264
4265                 {
4266                         // test channel_reserve test on nodes[1] side
4267                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
4268
4269                         // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
4270                         let secp_ctx = Secp256k1::new();
4271                         let session_priv = SecretKey::from_slice(&secp_ctx, &{
4272                                 let mut session_key = [0; 32];
4273                                 rng::fill_bytes(&mut session_key);
4274                                 session_key
4275                         }).expect("RNG is bad!");
4276
4277                         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4278                         let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
4279                         let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height).unwrap();
4280                         let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
4281                         let msg = msgs::UpdateAddHTLC {
4282                                 channel_id: chan_1.2,
4283                                 htlc_id,
4284                                 amount_msat: htlc_msat,
4285                                 payment_hash: our_payment_hash,
4286                                 cltv_expiry: htlc_cltv,
4287                                 onion_routing_packet: onion_packet,
4288                         };
4289
4290                         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
4291                         match err {
4292                                 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
4293                         }
4294                 }
4295
4296                 // split the rest to test holding cell
4297                 let recv_value_21 = recv_value_2/2;
4298                 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
4299                 {
4300                         let stat = get_channel_value_stat!(nodes[0], chan_1.2);
4301                         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);
4302                 }
4303
4304                 // now see if they go through on both sides
4305                 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
4306                 // but this will stuck in the holding cell
4307                 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
4308                 check_added_monitors!(nodes[0], 0);
4309                 let events = nodes[0].node.get_and_clear_pending_events();
4310                 assert_eq!(events.len(), 0);
4311
4312                 // test with outbound holding cell amount > 0
4313                 {
4314                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
4315                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
4316                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4317                                 _ => panic!("Unknown error variants"),
4318                         }
4319                 }
4320
4321                 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
4322                 // this will also stuck in the holding cell
4323                 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
4324                 check_added_monitors!(nodes[0], 0);
4325                 let events = nodes[0].node.get_and_clear_pending_events();
4326                 assert_eq!(events.len(), 0);
4327
4328                 // flush the pending htlc
4329                 let (as_revoke_and_ack, as_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
4330                 check_added_monitors!(nodes[1], 1);
4331
4332                 let commitment_update_2 = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap().unwrap();
4333                 check_added_monitors!(nodes[0], 1);
4334                 let (bs_revoke_and_ack, bs_none) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed.unwrap()).unwrap();
4335                 assert!(bs_none.is_none());
4336                 check_added_monitors!(nodes[0], 1);
4337                 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
4338                 check_added_monitors!(nodes[1], 1);
4339
4340                 expect_pending_htlcs_forwardable!(nodes[1]);
4341
4342                 let ref payment_event_11 = expect_forward!(nodes[1]);
4343                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
4344                 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
4345
4346                 expect_pending_htlcs_forwardable!(nodes[2]);
4347                 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
4348
4349                 // flush the htlcs in the holding cell
4350                 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
4351                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
4352                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
4353                 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
4354                 expect_pending_htlcs_forwardable!(nodes[1]);
4355
4356                 let ref payment_event_3 = expect_forward!(nodes[1]);
4357                 assert_eq!(payment_event_3.msgs.len(), 2);
4358                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
4359                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
4360
4361                 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
4362                 expect_pending_htlcs_forwardable!(nodes[2]);
4363
4364                 let events = nodes[2].node.get_and_clear_pending_events();
4365                 assert_eq!(events.len(), 2);
4366                 match events[0] {
4367                         Event::PaymentReceived { ref payment_hash, amt } => {
4368                                 assert_eq!(our_payment_hash_21, *payment_hash);
4369                                 assert_eq!(recv_value_21, amt);
4370                         },
4371                         _ => panic!("Unexpected event"),
4372                 }
4373                 match events[1] {
4374                         Event::PaymentReceived { ref payment_hash, amt } => {
4375                                 assert_eq!(our_payment_hash_22, *payment_hash);
4376                                 assert_eq!(recv_value_22, amt);
4377                         },
4378                         _ => panic!("Unexpected event"),
4379                 }
4380
4381                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
4382                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
4383                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
4384
4385                 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);
4386                 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
4387                 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
4388                 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
4389
4390                 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
4391                 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
4392         }
4393
4394         #[test]
4395         fn channel_monitor_network_test() {
4396                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
4397                 // tests that ChannelMonitor is able to recover from various states.
4398                 let nodes = create_network(5);
4399
4400                 // Create some initial channels
4401                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4402                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4403                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
4404                 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
4405
4406                 // Rebalance the network a bit by relaying one payment through all the channels...
4407                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4408                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4409                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4410                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4411
4412                 // Simple case with no pending HTLCs:
4413                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
4414                 {
4415                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
4416                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4417                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
4418                         test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
4419                 }
4420                 get_announce_close_broadcast_events(&nodes, 0, 1);
4421                 assert_eq!(nodes[0].node.list_channels().len(), 0);
4422                 assert_eq!(nodes[1].node.list_channels().len(), 1);
4423
4424                 // One pending HTLC is discarded by the force-close:
4425                 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
4426
4427                 // Simple case of one pending HTLC to HTLC-Timeout
4428                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
4429                 {
4430                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
4431                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4432                         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
4433                         test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
4434                 }
4435                 get_announce_close_broadcast_events(&nodes, 1, 2);
4436                 assert_eq!(nodes[1].node.list_channels().len(), 0);
4437                 assert_eq!(nodes[2].node.list_channels().len(), 1);
4438
4439                 macro_rules! claim_funds {
4440                         ($node: expr, $prev_node: expr, $preimage: expr) => {
4441                                 {
4442                                         assert!($node.node.claim_funds($preimage));
4443                                         check_added_monitors!($node, 1);
4444
4445                                         let events = $node.node.get_and_clear_pending_events();
4446                                         assert_eq!(events.len(), 1);
4447                                         match events[0] {
4448                                                 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
4449                                                         assert!(update_add_htlcs.is_empty());
4450                                                         assert!(update_fail_htlcs.is_empty());
4451                                                         assert_eq!(*node_id, $prev_node.node.get_our_node_id());
4452                                                 },
4453                                                 _ => panic!("Unexpected event"),
4454                                         };
4455                                 }
4456                         }
4457                 }
4458
4459                 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
4460                 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
4461                 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
4462                 {
4463                         let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
4464
4465                         // Claim the payment on nodes[3], giving it knowledge of the preimage
4466                         claim_funds!(nodes[3], nodes[2], payment_preimage_1);
4467
4468                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4469                         nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
4470
4471                         check_preimage_claim(&nodes[3], &node_txn);
4472                 }
4473                 get_announce_close_broadcast_events(&nodes, 2, 3);
4474                 assert_eq!(nodes[2].node.list_channels().len(), 0);
4475                 assert_eq!(nodes[3].node.list_channels().len(), 1);
4476
4477                 { // Cheat and reset nodes[4]'s height to 1
4478                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4479                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
4480                 }
4481
4482                 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
4483                 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
4484                 // One pending HTLC to time out:
4485                 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
4486                 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
4487                 // buffer space).
4488
4489                 {
4490                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4491                         nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
4492                         for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
4493                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4494                                 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
4495                         }
4496
4497                         let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
4498
4499                         // Claim the payment on nodes[4], giving it knowledge of the preimage
4500                         claim_funds!(nodes[4], nodes[3], payment_preimage_2);
4501
4502                         header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4503                         nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
4504                         for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
4505                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4506                                 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
4507                         }
4508
4509                         test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
4510
4511                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4512                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
4513
4514                         check_preimage_claim(&nodes[4], &node_txn);
4515                 }
4516                 get_announce_close_broadcast_events(&nodes, 3, 4);
4517                 assert_eq!(nodes[3].node.list_channels().len(), 0);
4518                 assert_eq!(nodes[4].node.list_channels().len(), 0);
4519
4520                 // Create some new channels:
4521                 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
4522
4523                 // A pending HTLC which will be revoked:
4524                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4525                 // Get the will-be-revoked local txn from nodes[0]
4526                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
4527                 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
4528                 assert_eq!(revoked_local_txn[0].input.len(), 1);
4529                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
4530                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
4531                 assert_eq!(revoked_local_txn[1].input.len(), 1);
4532                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
4533                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
4534                 // Revoke the old state
4535                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
4536
4537                 {
4538                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4539                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4540                         {
4541                                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4542                                 assert_eq!(node_txn.len(), 3);
4543                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
4544                                 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
4545
4546                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
4547                                 node_txn.swap_remove(0);
4548                         }
4549                         test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
4550
4551                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4552                         let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
4553                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4554                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
4555                         test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
4556                 }
4557                 get_announce_close_broadcast_events(&nodes, 0, 1);
4558                 assert_eq!(nodes[0].node.list_channels().len(), 0);
4559                 assert_eq!(nodes[1].node.list_channels().len(), 0);
4560         }
4561
4562         #[test]
4563         fn revoked_output_claim() {
4564                 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
4565                 // transaction is broadcast by its counterparty
4566                 let nodes = create_network(2);
4567                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4568                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
4569                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4570                 assert_eq!(revoked_local_txn.len(), 1);
4571                 // Only output is the full channel value back to nodes[0]:
4572                 assert_eq!(revoked_local_txn[0].output.len(), 1);
4573                 // Send a payment through, updating everyone's latest commitment txn
4574                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
4575
4576                 // Inform nodes[1] that nodes[0] broadcast a stale tx
4577                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4578                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4579                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4580                 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
4581
4582                 assert_eq!(node_txn[0], node_txn[2]);
4583
4584                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
4585                 check_spends!(node_txn[1], chan_1.3.clone());
4586
4587                 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
4588                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4589                 get_announce_close_broadcast_events(&nodes, 0, 1);
4590         }
4591
4592         #[test]
4593         fn claim_htlc_outputs_shared_tx() {
4594                 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
4595                 let nodes = create_network(2);
4596
4597                 // Create some new channel:
4598                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4599
4600                 // Rebalance the network to generate htlc in the two directions
4601                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4602                 // 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
4603                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4604                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
4605
4606                 // Get the will-be-revoked local txn from node[0]
4607                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4608                 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
4609                 assert_eq!(revoked_local_txn[0].input.len(), 1);
4610                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4611                 assert_eq!(revoked_local_txn[1].input.len(), 1);
4612                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
4613                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
4614                 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
4615
4616                 //Revoke the old state
4617                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
4618
4619                 {
4620                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4621
4622                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4623
4624                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4625                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4626                         assert_eq!(node_txn.len(), 4);
4627
4628                         assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
4629                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
4630
4631                         assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
4632
4633                         let mut witness_lens = BTreeSet::new();
4634                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
4635                         witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
4636                         witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
4637                         assert_eq!(witness_lens.len(), 3);
4638                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
4639                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
4640                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
4641
4642                         // Next nodes[1] broadcasts its current local tx state:
4643                         assert_eq!(node_txn[1].input.len(), 1);
4644                         assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
4645
4646                         assert_eq!(node_txn[2].input.len(), 1);
4647                         let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
4648                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
4649                         assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
4650                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
4651                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
4652                 }
4653                 get_announce_close_broadcast_events(&nodes, 0, 1);
4654                 assert_eq!(nodes[0].node.list_channels().len(), 0);
4655                 assert_eq!(nodes[1].node.list_channels().len(), 0);
4656         }
4657
4658         #[test]
4659         fn claim_htlc_outputs_single_tx() {
4660                 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
4661                 let nodes = create_network(2);
4662
4663                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4664
4665                 // Rebalance the network to generate htlc in the two directions
4666                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4667                 // 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
4668                 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
4669                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4670                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
4671
4672                 // Get the will-be-revoked local txn from node[0]
4673                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4674
4675                 //Revoke the old state
4676                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
4677
4678                 {
4679                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4680
4681                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
4682
4683                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
4684                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4685                         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)
4686
4687                         assert_eq!(node_txn[0], node_txn[7]);
4688                         assert_eq!(node_txn[1], node_txn[8]);
4689                         assert_eq!(node_txn[2], node_txn[9]);
4690                         assert_eq!(node_txn[3], node_txn[10]);
4691                         assert_eq!(node_txn[4], node_txn[11]);
4692                         assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
4693                         assert_eq!(node_txn[4], node_txn[6]);
4694
4695                         assert_eq!(node_txn[0].input.len(), 1);
4696                         assert_eq!(node_txn[1].input.len(), 1);
4697                         assert_eq!(node_txn[2].input.len(), 1);
4698
4699                         let mut revoked_tx_map = HashMap::new();
4700                         revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
4701                         node_txn[0].verify(&revoked_tx_map).unwrap();
4702                         node_txn[1].verify(&revoked_tx_map).unwrap();
4703                         node_txn[2].verify(&revoked_tx_map).unwrap();
4704
4705                         let mut witness_lens = BTreeSet::new();
4706                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
4707                         witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
4708                         witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
4709                         assert_eq!(witness_lens.len(), 3);
4710                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
4711                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
4712                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
4713
4714                         assert_eq!(node_txn[3].input.len(), 1);
4715                         check_spends!(node_txn[3], chan_1.3.clone());
4716
4717                         assert_eq!(node_txn[4].input.len(), 1);
4718                         let witness_script = node_txn[4].input[0].witness.last().unwrap();
4719                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
4720                         assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
4721                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
4722                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
4723                 }
4724                 get_announce_close_broadcast_events(&nodes, 0, 1);
4725                 assert_eq!(nodes[0].node.list_channels().len(), 0);
4726                 assert_eq!(nodes[1].node.list_channels().len(), 0);
4727         }
4728
4729         #[test]
4730         fn test_htlc_ignore_latest_remote_commitment() {
4731                 // Test that HTLC transactions spending the latest remote commitment transaction are simply
4732                 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
4733                 let nodes = create_network(2);
4734                 create_announced_chan_between_nodes(&nodes, 0, 1);
4735
4736                 route_payment(&nodes[0], &[&nodes[1]], 10000000);
4737                 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
4738                 {
4739                         let events = nodes[0].node.get_and_clear_pending_events();
4740                         assert_eq!(events.len(), 1);
4741                         match events[0] {
4742                                 Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4743                                         assert_eq!(flags & 0b10, 0b10);
4744                                 },
4745                                 _ => panic!("Unexpected event"),
4746                         }
4747                 }
4748
4749                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4750                 assert_eq!(node_txn.len(), 2);
4751
4752                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4753                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
4754
4755                 {
4756                         let events = nodes[1].node.get_and_clear_pending_events();
4757                         assert_eq!(events.len(), 1);
4758                         match events[0] {
4759                                 Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4760                                         assert_eq!(flags & 0b10, 0b10);
4761                                 },
4762                                 _ => panic!("Unexpected event"),
4763                         }
4764                 }
4765
4766                 // Duplicate the block_connected call since this may happen due to other listeners
4767                 // registering new transactions
4768                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
4769         }
4770
4771         #[test]
4772         fn test_force_close_fail_back() {
4773                 // Check which HTLCs are failed-backwards on channel force-closure
4774                 let mut nodes = create_network(3);
4775                 create_announced_chan_between_nodes(&nodes, 0, 1);
4776                 create_announced_chan_between_nodes(&nodes, 1, 2);
4777
4778                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
4779
4780                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4781
4782                 let mut payment_event = {
4783                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4784                         check_added_monitors!(nodes[0], 1);
4785
4786                         let mut events = nodes[0].node.get_and_clear_pending_events();
4787                         assert_eq!(events.len(), 1);
4788                         SendEvent::from_event(events.remove(0))
4789                 };
4790
4791                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4792                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4793
4794                 let events_1 = nodes[1].node.get_and_clear_pending_events();
4795                 assert_eq!(events_1.len(), 1);
4796                 match events_1[0] {
4797                         Event::PendingHTLCsForwardable { .. } => { },
4798                         _ => panic!("Unexpected event"),
4799                 };
4800
4801                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
4802                 nodes[1].node.process_pending_htlc_forwards();
4803
4804                 let mut events_2 = nodes[1].node.get_and_clear_pending_events();
4805                 assert_eq!(events_2.len(), 1);
4806                 payment_event = SendEvent::from_event(events_2.remove(0));
4807                 assert_eq!(payment_event.msgs.len(), 1);
4808
4809                 check_added_monitors!(nodes[1], 1);
4810                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4811                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
4812                 check_added_monitors!(nodes[2], 1);
4813
4814                 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
4815                 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
4816                 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
4817
4818                 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
4819                 let events_3 = nodes[2].node.get_and_clear_pending_events();
4820                 assert_eq!(events_3.len(), 1);
4821                 match events_3[0] {
4822                         Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4823                                 assert_eq!(flags & 0b10, 0b10);
4824                         },
4825                         _ => panic!("Unexpected event"),
4826                 }
4827
4828                 let tx = {
4829                         let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
4830                         // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
4831                         // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
4832                         // back to nodes[1] upon timeout otherwise.
4833                         assert_eq!(node_txn.len(), 1);
4834                         node_txn.remove(0)
4835                 };
4836
4837                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4838                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
4839
4840                 let events_4 = nodes[1].node.get_and_clear_pending_events();
4841                 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
4842                 assert_eq!(events_4.len(), 1);
4843                 match events_4[0] {
4844                         Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4845                                 assert_eq!(flags & 0b10, 0b10);
4846                         },
4847                         _ => panic!("Unexpected event"),
4848                 }
4849
4850                 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
4851                 {
4852                         let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
4853                         monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
4854                                 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
4855                 }
4856                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
4857                 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
4858                 assert_eq!(node_txn.len(), 1);
4859                 assert_eq!(node_txn[0].input.len(), 1);
4860                 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
4861                 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
4862                 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
4863
4864                 check_spends!(node_txn[0], tx);
4865         }
4866
4867         #[test]
4868         fn test_unconf_chan() {
4869                 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
4870                 let nodes = create_network(2);
4871                 create_announced_chan_between_nodes(&nodes, 0, 1);
4872
4873                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
4874                 assert_eq!(channel_state.by_id.len(), 1);
4875                 assert_eq!(channel_state.short_to_id.len(), 1);
4876                 mem::drop(channel_state);
4877
4878                 let mut headers = Vec::new();
4879                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4880                 headers.push(header.clone());
4881                 for _i in 2..100 {
4882                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4883                         headers.push(header.clone());
4884                 }
4885                 while !headers.is_empty() {
4886                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
4887                 }
4888                 {
4889                         let events = nodes[0].node.get_and_clear_pending_events();
4890                         assert_eq!(events.len(), 1);
4891                         match events[0] {
4892                                 Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4893                                         assert_eq!(flags & 0b10, 0b10);
4894                                 },
4895                                 _ => panic!("Unexpected event"),
4896                         }
4897                 }
4898                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
4899                 assert_eq!(channel_state.by_id.len(), 0);
4900                 assert_eq!(channel_state.short_to_id.len(), 0);
4901         }
4902
4903         /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
4904         /// for claims/fails they are separated out.
4905         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)) {
4906                 let reestablish_1 = node_a.node.peer_connected(&node_b.node.get_our_node_id());
4907                 let reestablish_2 = node_b.node.peer_connected(&node_a.node.get_our_node_id());
4908
4909                 let mut resp_1 = Vec::new();
4910                 for msg in reestablish_1 {
4911                         resp_1.push(node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap());
4912                 }
4913                 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
4914                         check_added_monitors!(node_b, 1);
4915                 } else {
4916                         check_added_monitors!(node_b, 0);
4917                 }
4918
4919                 let mut resp_2 = Vec::new();
4920                 for msg in reestablish_2 {
4921                         resp_2.push(node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap());
4922                 }
4923                 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
4924                         check_added_monitors!(node_a, 1);
4925                 } else {
4926                         check_added_monitors!(node_a, 0);
4927                 }
4928
4929                 // We dont yet support both needing updates, as that would require a different commitment dance:
4930                 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
4931                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
4932
4933                 for chan_msgs in resp_1.drain(..) {
4934                         if pre_all_htlcs {
4935                                 let a = node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
4936                                 let _announcement_sigs_opt = a.unwrap();
4937                                 //TODO: Test announcement_sigs re-sending when we've implemented it
4938                         } else {
4939                                 assert!(chan_msgs.0.is_none());
4940                         }
4941                         if pending_raa.0 {
4942                                 assert!(chan_msgs.3 == msgs::RAACommitmentOrder::RevokeAndACKFirst);
4943                                 assert!(node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap().is_none());
4944                                 check_added_monitors!(node_a, 1);
4945                         } else {
4946                                 assert!(chan_msgs.1.is_none());
4947                         }
4948                         if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
4949                                 let commitment_update = chan_msgs.2.unwrap();
4950                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
4951                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
4952                                 } else {
4953                                         assert!(commitment_update.update_add_htlcs.is_empty());
4954                                 }
4955                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
4956                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
4957                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4958                                 for update_add in commitment_update.update_add_htlcs {
4959                                         node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
4960                                 }
4961                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
4962                                         node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
4963                                 }
4964                                 for update_fail in commitment_update.update_fail_htlcs {
4965                                         node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
4966                                 }
4967
4968                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
4969                                         commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
4970                                 } else {
4971                                         let (as_revoke_and_ack, as_commitment_signed) = node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4972                                         check_added_monitors!(node_a, 1);
4973                                         assert!(as_commitment_signed.is_none());
4974                                         assert!(node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
4975                                         check_added_monitors!(node_b, 1);
4976                                 }
4977                         } else {
4978                                 assert!(chan_msgs.2.is_none());
4979                         }
4980                 }
4981
4982                 for chan_msgs in resp_2.drain(..) {
4983                         if pre_all_htlcs {
4984                                 let _announcement_sigs_opt = node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
4985                                 //TODO: Test announcement_sigs re-sending when we've implemented it
4986                         } else {
4987                                 assert!(chan_msgs.0.is_none());
4988                         }
4989                         if pending_raa.1 {
4990                                 assert!(chan_msgs.3 == msgs::RAACommitmentOrder::RevokeAndACKFirst);
4991                                 assert!(node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap().is_none());
4992                                 check_added_monitors!(node_b, 1);
4993                         } else {
4994                                 assert!(chan_msgs.1.is_none());
4995                         }
4996                         if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
4997                                 let commitment_update = chan_msgs.2.unwrap();
4998                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
4999                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
5000                                 }
5001                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
5002                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
5003                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
5004                                 for update_add in commitment_update.update_add_htlcs {
5005                                         node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
5006                                 }
5007                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
5008                                         node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
5009                                 }
5010                                 for update_fail in commitment_update.update_fail_htlcs {
5011                                         node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
5012                                 }
5013
5014                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
5015                                         commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
5016                                 } else {
5017                                         let (bs_revoke_and_ack, bs_commitment_signed) = node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
5018                                         check_added_monitors!(node_b, 1);
5019                                         assert!(bs_commitment_signed.is_none());
5020                                         assert!(node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
5021                                         check_added_monitors!(node_a, 1);
5022                                 }
5023                         } else {
5024                                 assert!(chan_msgs.2.is_none());
5025                         }
5026                 }
5027         }
5028
5029         #[test]
5030         fn test_simple_peer_disconnect() {
5031                 // Test that we can reconnect when there are no lost messages
5032                 let nodes = create_network(3);
5033                 create_announced_chan_between_nodes(&nodes, 0, 1);
5034                 create_announced_chan_between_nodes(&nodes, 1, 2);
5035
5036                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5037                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5038                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5039
5040                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5041                 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5042                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
5043                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
5044
5045                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5046                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5047                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5048
5049                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5050                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5051                 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5052                 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5053
5054                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5055                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5056
5057                 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
5058                 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
5059
5060                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
5061                 {
5062                         let events = nodes[0].node.get_and_clear_pending_events();
5063                         assert_eq!(events.len(), 2);
5064                         match events[0] {
5065                                 Event::PaymentSent { payment_preimage } => {
5066                                         assert_eq!(payment_preimage, payment_preimage_3);
5067                                 },
5068                                 _ => panic!("Unexpected event"),
5069                         }
5070                         match events[1] {
5071                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
5072                                         assert_eq!(payment_hash, payment_hash_5);
5073                                         assert!(rejected_by_dest);
5074                                 },
5075                                 _ => panic!("Unexpected event"),
5076                         }
5077                 }
5078
5079                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
5080                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
5081         }
5082
5083         fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
5084                 // Test that we can reconnect when in-flight HTLC updates get dropped
5085                 let mut nodes = create_network(2);
5086                 if messages_delivered == 0 {
5087                         create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
5088                         // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
5089                 } else {
5090                         create_announced_chan_between_nodes(&nodes, 0, 1);
5091                 }
5092
5093                 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();
5094                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
5095
5096                 let payment_event = {
5097                         nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
5098                         check_added_monitors!(nodes[0], 1);
5099
5100                         let mut events = nodes[0].node.get_and_clear_pending_events();
5101                         assert_eq!(events.len(), 1);
5102                         SendEvent::from_event(events.remove(0))
5103                 };
5104                 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
5105
5106                 if messages_delivered < 2 {
5107                         // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
5108                 } else {
5109                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5110                         let (bs_revoke_and_ack, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
5111                         check_added_monitors!(nodes[1], 1);
5112
5113                         if messages_delivered >= 3 {
5114                                 assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
5115                                 check_added_monitors!(nodes[0], 1);
5116
5117                                 if messages_delivered >= 4 {
5118                                         let (as_revoke_and_ack, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed.unwrap()).unwrap();
5119                                         assert!(as_commitment_signed.is_none());
5120                                         check_added_monitors!(nodes[0], 1);
5121
5122                                         if messages_delivered >= 5 {
5123                                                 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
5124                                                 check_added_monitors!(nodes[1], 1);
5125                                         }
5126                                 }
5127                         }
5128                 }
5129
5130                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5131                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5132                 if messages_delivered < 2 {
5133                         // Even if the funding_locked messages get exchanged, as long as nothing further was
5134                         // received on either side, both sides will need to resend them.
5135                         reconnect_nodes(&nodes[0], &nodes[1], true, (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
5136                 } else if messages_delivered == 2 {
5137                         // nodes[0] still wants its RAA + commitment_signed
5138                         reconnect_nodes(&nodes[0], &nodes[1], false, (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
5139                 } else if messages_delivered == 3 {
5140                         // nodes[0] still wants its commitment_signed
5141                         reconnect_nodes(&nodes[0], &nodes[1], false, (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
5142                 } else if messages_delivered == 4 {
5143                         // nodes[1] still wants its final RAA
5144                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
5145                 } else if messages_delivered == 5 {
5146                         // Everything was delivered...
5147                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5148                 }
5149
5150                 let events_1 = nodes[1].node.get_and_clear_pending_events();
5151                 assert_eq!(events_1.len(), 1);
5152                 match events_1[0] {
5153                         Event::PendingHTLCsForwardable { .. } => { },
5154                         _ => panic!("Unexpected event"),
5155                 };
5156
5157                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5158                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5159                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5160
5161                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
5162                 nodes[1].node.process_pending_htlc_forwards();
5163
5164                 let events_2 = nodes[1].node.get_and_clear_pending_events();
5165                 assert_eq!(events_2.len(), 1);
5166                 match events_2[0] {
5167                         Event::PaymentReceived { ref payment_hash, amt } => {
5168                                 assert_eq!(payment_hash_1, *payment_hash);
5169                                 assert_eq!(amt, 1000000);
5170                         },
5171                         _ => panic!("Unexpected event"),
5172                 }
5173
5174                 nodes[1].node.claim_funds(payment_preimage_1);
5175                 check_added_monitors!(nodes[1], 1);
5176
5177                 let events_3 = nodes[1].node.get_and_clear_pending_events();
5178                 assert_eq!(events_3.len(), 1);
5179                 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
5180                         Event::UpdateHTLCs { ref node_id, ref updates } => {
5181                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
5182                                 assert!(updates.update_add_htlcs.is_empty());
5183                                 assert!(updates.update_fail_htlcs.is_empty());
5184                                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5185                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
5186                                 assert!(updates.update_fee.is_none());
5187                                 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
5188                         },
5189                         _ => panic!("Unexpected event"),
5190                 };
5191
5192                 if messages_delivered >= 1 {
5193                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
5194
5195                         let events_4 = nodes[0].node.get_and_clear_pending_events();
5196                         assert_eq!(events_4.len(), 1);
5197                         match events_4[0] {
5198                                 Event::PaymentSent { ref payment_preimage } => {
5199                                         assert_eq!(payment_preimage_1, *payment_preimage);
5200                                 },
5201                                 _ => panic!("Unexpected event"),
5202                         }
5203
5204                         if messages_delivered >= 2 {
5205                                 let (as_revoke_and_ack, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
5206                                 check_added_monitors!(nodes[0], 1);
5207
5208                                 if messages_delivered >= 3 {
5209                                         assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
5210                                         check_added_monitors!(nodes[1], 1);
5211
5212                                         if messages_delivered >= 4 {
5213                                                 let (bs_revoke_and_ack, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.unwrap()).unwrap();
5214                                                 assert!(bs_commitment_signed.is_none());
5215                                                 check_added_monitors!(nodes[1], 1);
5216
5217                                                 if messages_delivered >= 5 {
5218                                                         assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
5219                                                         check_added_monitors!(nodes[0], 1);
5220                                                 }
5221                                         }
5222                                 }
5223                         }
5224                 }
5225
5226                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5227                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5228                 if messages_delivered < 2 {
5229                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
5230                         //TODO: Deduplicate PaymentSent events, then enable this if:
5231                         //if messages_delivered < 1 {
5232                                 let events_4 = nodes[0].node.get_and_clear_pending_events();
5233                                 assert_eq!(events_4.len(), 1);
5234                                 match events_4[0] {
5235                                         Event::PaymentSent { ref payment_preimage } => {
5236                                                 assert_eq!(payment_preimage_1, *payment_preimage);
5237                                         },
5238                                         _ => panic!("Unexpected event"),
5239                                 }
5240                         //}
5241                 } else if messages_delivered == 2 {
5242                         // nodes[0] still wants its RAA + commitment_signed
5243                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
5244                 } else if messages_delivered == 3 {
5245                         // nodes[0] still wants its commitment_signed
5246                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
5247                 } else if messages_delivered == 4 {
5248                         // nodes[1] still wants its final RAA
5249                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
5250                 } else if messages_delivered == 5 {
5251                         // Everything was delivered...
5252                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5253                 }
5254
5255                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5256                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5257                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5258
5259                 // Channel should still work fine...
5260                 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
5261                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
5262         }
5263
5264         #[test]
5265         fn test_drop_messages_peer_disconnect_a() {
5266                 do_test_drop_messages_peer_disconnect(0);
5267                 do_test_drop_messages_peer_disconnect(1);
5268                 do_test_drop_messages_peer_disconnect(2);
5269         }
5270
5271         #[test]
5272         fn test_drop_messages_peer_disconnect_b() {
5273                 do_test_drop_messages_peer_disconnect(3);
5274                 do_test_drop_messages_peer_disconnect(4);
5275                 do_test_drop_messages_peer_disconnect(5);
5276         }
5277
5278         #[test]
5279         fn test_funding_peer_disconnect() {
5280                 // Test that we can lock in our funding tx while disconnected
5281                 let nodes = create_network(2);
5282                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
5283
5284                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5285                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5286
5287                 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
5288                 let events_1 = nodes[0].node.get_and_clear_pending_events();
5289                 assert_eq!(events_1.len(), 1);
5290                 match events_1[0] {
5291                         Event::SendFundingLocked { ref node_id, msg: _, ref announcement_sigs } => {
5292                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5293                                 assert!(announcement_sigs.is_none());
5294                         },
5295                         _ => panic!("Unexpected event"),
5296                 }
5297
5298                 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
5299                 let events_2 = nodes[1].node.get_and_clear_pending_events();
5300                 assert_eq!(events_2.len(), 1);
5301                 match events_2[0] {
5302                         Event::SendFundingLocked { ref node_id, msg: _, ref announcement_sigs } => {
5303                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
5304                                 assert!(announcement_sigs.is_none());
5305                         },
5306                         _ => panic!("Unexpected event"),
5307                 }
5308
5309                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5310                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5311                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5312                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5313
5314                 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
5315                 // rebroadcasting announcement_signatures upon reconnect.
5316
5317                 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();
5318                 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
5319                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
5320         }
5321
5322         #[test]
5323         fn test_drop_messages_peer_disconnect_dual_htlc() {
5324                 // Test that we can handle reconnecting when both sides of a channel have pending
5325                 // commitment_updates when we disconnect.
5326                 let mut nodes = create_network(2);
5327                 create_announced_chan_between_nodes(&nodes, 0, 1);
5328
5329                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5330
5331                 // Now try to send a second payment which will fail to send
5332                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5333                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
5334
5335                 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
5336                 check_added_monitors!(nodes[0], 1);
5337
5338                 let events_1 = nodes[0].node.get_and_clear_pending_events();
5339                 assert_eq!(events_1.len(), 1);
5340                 match events_1[0] {
5341                         Event::UpdateHTLCs { .. } => {},
5342                         _ => panic!("Unexpected event"),
5343                 }
5344
5345                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
5346                 check_added_monitors!(nodes[1], 1);
5347
5348                 let events_2 = nodes[1].node.get_and_clear_pending_events();
5349                 assert_eq!(events_2.len(), 1);
5350                 match events_2[0] {
5351                         Event::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 } } => {
5352                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
5353                                 assert!(update_add_htlcs.is_empty());
5354                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5355                                 assert!(update_fail_htlcs.is_empty());
5356                                 assert!(update_fail_malformed_htlcs.is_empty());
5357                                 assert!(update_fee.is_none());
5358
5359                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
5360                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
5361                                 assert_eq!(events_3.len(), 1);
5362                                 match events_3[0] {
5363                                         Event::PaymentSent { ref payment_preimage } => {
5364                                                 assert_eq!(*payment_preimage, payment_preimage_1);
5365                                         },
5366                                         _ => panic!("Unexpected event"),
5367                                 }
5368
5369                                 let (_, commitment_update) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
5370                                 assert!(commitment_update.is_none());
5371                                 check_added_monitors!(nodes[0], 1);
5372                         },
5373                         _ => panic!("Unexpected event"),
5374                 }
5375
5376                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5377                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5378
5379                 let reestablish_1 = nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5380                 assert_eq!(reestablish_1.len(), 1);
5381                 let reestablish_2 = nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5382                 assert_eq!(reestablish_2.len(), 1);
5383
5384                 let as_resp = nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5385                 let bs_resp = nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5386
5387                 assert!(as_resp.0.is_none());
5388                 assert!(bs_resp.0.is_none());
5389
5390                 assert!(bs_resp.1.is_none());
5391                 assert!(bs_resp.2.is_none());
5392
5393                 assert!(as_resp.3 == msgs::RAACommitmentOrder::CommitmentFirst);
5394
5395                 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
5396                 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
5397                 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
5398                 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
5399                 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
5400                 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();
5401                 let (bs_revoke_and_ack, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
5402                 assert!(bs_commitment_signed.is_none());
5403                 check_added_monitors!(nodes[1], 1);
5404
5405                 let bs_second_commitment_signed = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap().unwrap();
5406                 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
5407                 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
5408                 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
5409                 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
5410                 assert!(bs_second_commitment_signed.update_fee.is_none());
5411                 check_added_monitors!(nodes[1], 1);
5412
5413                 let as_commitment_signed = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap().unwrap();
5414                 assert!(as_commitment_signed.update_add_htlcs.is_empty());
5415                 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
5416                 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
5417                 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
5418                 assert!(as_commitment_signed.update_fee.is_none());
5419                 check_added_monitors!(nodes[0], 1);
5420
5421                 let (as_revoke_and_ack, as_second_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
5422                 assert!(as_second_commitment_signed.is_none());
5423                 check_added_monitors!(nodes[0], 1);
5424
5425                 let (bs_second_revoke_and_ack, bs_third_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
5426                 assert!(bs_third_commitment_signed.is_none());
5427                 check_added_monitors!(nodes[1], 1);
5428
5429                 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
5430                 check_added_monitors!(nodes[1], 1);
5431
5432                 let events_4 = nodes[1].node.get_and_clear_pending_events();
5433                 assert_eq!(events_4.len(), 1);
5434                 match events_4[0] {
5435                         Event::PendingHTLCsForwardable { .. } => { },
5436                         _ => panic!("Unexpected event"),
5437                 };
5438
5439                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
5440                 nodes[1].node.process_pending_htlc_forwards();
5441
5442                 let events_5 = nodes[1].node.get_and_clear_pending_events();
5443                 assert_eq!(events_5.len(), 1);
5444                 match events_5[0] {
5445                         Event::PaymentReceived { ref payment_hash, amt: _ } => {
5446                                 assert_eq!(payment_hash_2, *payment_hash);
5447                         },
5448                         _ => panic!("Unexpected event"),
5449                 }
5450
5451                 assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap().is_none());
5452                 check_added_monitors!(nodes[0], 1);
5453
5454                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
5455         }
5456
5457         #[test]
5458         fn test_invalid_channel_announcement() {
5459                 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
5460                 let secp_ctx = Secp256k1::new();
5461                 let nodes = create_network(2);
5462
5463                 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
5464
5465                 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
5466                 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
5467                 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
5468                 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
5469
5470                 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 } );
5471
5472                 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
5473                 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
5474
5475                 let as_network_key = nodes[0].node.get_our_node_id();
5476                 let bs_network_key = nodes[1].node.get_our_node_id();
5477
5478                 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
5479
5480                 let mut chan_announcement;
5481
5482                 macro_rules! dummy_unsigned_msg {
5483                         () => {
5484                                 msgs::UnsignedChannelAnnouncement {
5485                                         features: msgs::GlobalFeatures::new(),
5486                                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
5487                                         short_channel_id: as_chan.get_short_channel_id().unwrap(),
5488                                         node_id_1: if were_node_one { as_network_key } else { bs_network_key },
5489                                         node_id_2: if were_node_one { bs_network_key } else { as_network_key },
5490                                         bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
5491                                         bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
5492                                         excess_data: Vec::new(),
5493                                 };
5494                         }
5495                 }
5496
5497                 macro_rules! sign_msg {
5498                         ($unsigned_msg: expr) => {
5499                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
5500                                 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
5501                                 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
5502                                 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
5503                                 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
5504                                 chan_announcement = msgs::ChannelAnnouncement {
5505                                         node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
5506                                         node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
5507                                         bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
5508                                         bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
5509                                         contents: $unsigned_msg
5510                                 }
5511                         }
5512                 }
5513
5514                 let unsigned_msg = dummy_unsigned_msg!();
5515                 sign_msg!(unsigned_msg);
5516                 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
5517                 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 } );
5518
5519                 // Configured with Network::Testnet
5520                 let mut unsigned_msg = dummy_unsigned_msg!();
5521                 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
5522                 sign_msg!(unsigned_msg);
5523                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
5524
5525                 let mut unsigned_msg = dummy_unsigned_msg!();
5526                 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
5527                 sign_msg!(unsigned_msg);
5528                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
5529         }
5530 }