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

   1 use bitcoin::blockdata::block::BlockHeader;
   2 use bitcoin::blockdata::transaction::Transaction;
   3 use bitcoin::blockdata::constants::genesis_block;
   4 use bitcoin::network::constants::Network;
   5 use bitcoin::network::serialize::BitcoinHash;
   6 use bitcoin::util::hash::Sha256dHash;
   7 use bitcoin::util::uint::Uint256;
   8
   9 use secp256k1::key::{SecretKey,PublicKey};
  10 use secp256k1::{Secp256k1,Message};
  11 use secp256k1::ecdh::SharedSecret;
  12 use secp256k1;
  13
  14 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
  15 use ln::channel::{Channel, ChannelKeys};
  16 use ln::channelmonitor::ManyChannelMonitor;
  17 use ln::router::{Route,RouteHop};
  18 use ln::msgs;
  19 use ln::msgs::{HandleError,ChannelMessageHandler,MsgEncodable,MsgDecodable};
  20 use util::{byte_utils, events, internal_traits, rng};
  21 use util::sha2::Sha256;
  22
  23 use crypto;
  24 use crypto::mac::{Mac,MacResult};
  25 use crypto::hmac::Hmac;
  26 use crypto::digest::Digest;
  27 use crypto::symmetriccipher::SynchronousStreamCipher;
  28 use crypto::chacha20::ChaCha20;
  29
  30 use std::sync::{Mutex,MutexGuard,Arc};
  31 use std::collections::HashMap;
  32 use std::collections::hash_map;
  33 use std::{ptr, mem};
  34 use std::time::{Instant,Duration};
  35
  36 mod channel_held_info {
  37         use ln::msgs;
  38
  39         /// Stores the info we will need to send when we want to forward an HTLC onwards
  40         pub struct PendingForwardHTLCInfo {
  41                 pub(super) onion_packet: Option<msgs::OnionPacket>,
  42                 pub(super) payment_hash: [u8; 32],
  43                 pub(super) short_channel_id: u64,
  44                 pub(super) prev_short_channel_id: u64,
  45                 pub(super) amt_to_forward: u64,
  46                 pub(super) outgoing_cltv_value: u32,
  47         }
  48
  49         #[cfg(feature = "fuzztarget")]
  50         impl PendingForwardHTLCInfo {
  51                 pub fn dummy() -> Self {
  52                         Self {
  53                                 onion_packet: None,
  54                                 payment_hash: [0; 32],
  55                                 short_channel_id: 0,
  56                                 prev_short_channel_id: 0,
  57                                 amt_to_forward: 0,
  58                                 outgoing_cltv_value: 0,
  59                         }
  60                 }
  61         }
  62
  63         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
  64         pub enum HTLCFailReason {
  65                 ErrorPacket {
  66                         err: msgs::OnionErrorPacket,
  67                 },
  68                 Reason {
  69                         failure_code: u16,
  70                         data: Vec<u8>,
  71                 }
  72         }
  73
  74         #[cfg(feature = "fuzztarget")]
  75         impl HTLCFailReason {
  76                 pub fn dummy() -> Self {
  77                         HTLCFailReason::Reason {
  78                                 failure_code: 0, data: Vec::new(),
  79                         }
  80                 }
  81         }
  82 }
  83 #[cfg(feature = "fuzztarget")]
  84 pub use self::channel_held_info::*;
  85 #[cfg(not(feature = "fuzztarget"))]
  86 pub(crate) use self::channel_held_info::*;
  87
  88 enum PendingOutboundHTLC {
  89         IntermediaryHopData {
  90                 source_short_channel_id: u64,
  91                 incoming_packet_shared_secret: SharedSecret,
  92         },
  93         OutboundRoute {
  94                 route: Route,
  95                 session_priv: SecretKey,
  96         },
  97         /// Used for channel rebalancing
  98         CycledRoute {
  99                 source_short_channel_id: u64,
 100                 incoming_packet_shared_secret: SharedSecret,
 101                 route: Route,
 102                 session_priv: SecretKey,
 103         }
 104 }
 105
 106 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
 107 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
 108 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
 109 /// probably increase this significantly.
 110 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
 111
 112 struct ChannelHolder {
 113         by_id: HashMap<Uint256, Channel>,
 114         short_to_id: HashMap<u64, Uint256>,
 115         next_forward: Instant,
 116         /// short channel id -> forward infos. Key of 0 means payments received
 117         forward_htlcs: HashMap<u64, Vec<PendingForwardHTLCInfo>>,
 118         claimable_htlcs: HashMap<[u8; 32], PendingOutboundHTLC>,
 119 }
 120 struct MutChannelHolder<'a> {
 121         by_id: &'a mut HashMap<Uint256, Channel>,
 122         short_to_id: &'a mut HashMap<u64, Uint256>,
 123         next_forward: &'a mut Instant,
 124         /// short channel id -> forward infos. Key of 0 means payments received
 125         forward_htlcs: &'a mut HashMap<u64, Vec<PendingForwardHTLCInfo>>,
 126         claimable_htlcs: &'a mut HashMap<[u8; 32], PendingOutboundHTLC>,
 127 }
 128 impl ChannelHolder {
 129         fn borrow_parts(&mut self) -> MutChannelHolder {
 130                 MutChannelHolder {
 131                         by_id: &mut self.by_id,
 132                         short_to_id: &mut self.short_to_id,
 133                         next_forward: &mut self.next_forward,
 134                         /// short channel id -> forward infos. Key of 0 means payments received
 135                         forward_htlcs: &mut self.forward_htlcs,
 136                         claimable_htlcs: &mut self.claimable_htlcs,
 137                 }
 138         }
 139 }
 140
 141 /// Manager which keeps track of a number of channels and sends messages to the appropriate
 142 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
 143 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
 144 /// to individual Channels.
 145 pub struct ChannelManager {
 146         genesis_hash: Sha256dHash,
 147         fee_estimator: Arc<FeeEstimator>,
 148         monitor: Arc<ManyChannelMonitor>,
 149         chain_monitor: Arc<ChainWatchInterface>,
 150         tx_broadcaster: Arc<BroadcasterInterface>,
 151
 152         announce_channels_publicly: bool,
 153         fee_proportional_millionths: u32,
 154         secp_ctx: Secp256k1,
 155
 156         channel_state: Mutex<ChannelHolder>,
 157         our_network_key: SecretKey,
 158
 159         pending_events: Mutex<Vec<events::Event>>,
 160 }
 161
 162 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
 163
 164 macro_rules! secp_call {
 165         ( $res : expr ) => {
 166                 match $res {
 167                         Ok(key) => key,
 168                         //TODO: Make the err a parameter!
 169                         Err(_) => return Err(HandleError{err: "Key error", msg: None})
 170                 }
 171         };
 172 }
 173
 174 struct OnionKeys {
 175         #[cfg(test)]
 176         shared_secret: SharedSecret,
 177         #[cfg(test)]
 178         blinding_factor: [u8; 32],
 179         ephemeral_pubkey: PublicKey,
 180         rho: [u8; 32],
 181         mu: [u8; 32],
 182 }
 183
 184 pub struct ChannelDetails {
 185         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
 186         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
 187         /// Note that this means this value is *not* persistent - it can change once during the
 188         /// lifetime of the channel.
 189         pub channel_id: Uint256,
 190         /// The position of the funding transaction in the chain. None if the funding transaction has
 191         /// not yet been confirmed and the channel fully opened.
 192         pub short_channel_id: Option<u64>,
 193         pub remote_network_id: PublicKey,
 194         pub channel_value_satoshis: u64,
 195         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
 196         pub user_id: u64,
 197 }
 198
 199 impl ChannelManager {
 200         /// Constructs a new ChannelManager to hold several channels and route between them. This is
 201         /// the main "logic hub" for all channel-related actions, and implements ChannelMessageHandler.
 202         /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
 203         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
 204         /// panics if channel_value_satoshis is >= (1 << 24)!
 205         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>) -> Result<Arc<ChannelManager>, secp256k1::Error> {
 206                 let secp_ctx = Secp256k1::new();
 207
 208                 let res = Arc::new(ChannelManager {
 209                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
 210                         fee_estimator: feeest.clone(),
 211                         monitor: monitor.clone(),
 212                         chain_monitor,
 213                         tx_broadcaster,
 214
 215                         announce_channels_publicly,
 216                         fee_proportional_millionths,
 217                         secp_ctx,
 218
 219                         channel_state: Mutex::new(ChannelHolder{
 220                                 by_id: HashMap::new(),
 221                                 short_to_id: HashMap::new(),
 222                                 next_forward: Instant::now(),
 223                                 forward_htlcs: HashMap::new(),
 224                                 claimable_htlcs: HashMap::new(),
 225                         }),
 226                         our_network_key,
 227
 228                         pending_events: Mutex::new(Vec::new()),
 229                 });
 230                 let weak_res = Arc::downgrade(&res);
 231                 res.chain_monitor.register_listener(weak_res);
 232                 Ok(res)
 233         }
 234
 235         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, user_id: u64) -> Result<msgs::OpenChannel, HandleError> {
 236                 let chan_keys = if cfg!(feature = "fuzztarget") {
 237                         ChannelKeys {
 238                                 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(),
 239                                 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(),
 240                                 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(),
 241                                 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(),
 242                                 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(),
 243                                 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(),
 244                                 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(),
 245                                 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],
 246                         }
 247                 } else {
 248                         let mut key_seed = [0u8; 32];
 249                         rng::fill_bytes(&mut key_seed);
 250                         match ChannelKeys::new_from_seed(&key_seed) {
 251                                 Ok(key) => key,
 252                                 Err(_) => panic!("RNG is busted!")
 253                         }
 254                 };
 255
 256                 let channel = Channel::new_outbound(&*self.fee_estimator, chan_keys, their_network_key, channel_value_satoshis, self.announce_channels_publicly, user_id);
 257                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator)?;
 258                 let mut channel_state = self.channel_state.lock().unwrap();
 259                 match channel_state.by_id.insert(channel.channel_id(), channel) {
 260                         Some(_) => panic!("RNG is bad???"),
 261                         None => Ok(res)
 262                 }
 263         }
 264
 265         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
 266         /// more information.
 267         pub fn list_channels(&self) -> Vec<ChannelDetails> {
 268                 let channel_state = self.channel_state.lock().unwrap();
 269                 let mut res = Vec::with_capacity(channel_state.by_id.len());
 270                 for (channel_id, channel) in channel_state.by_id.iter() {
 271                         res.push(ChannelDetails {
 272                                 channel_id: (*channel_id).clone(),
 273                                 short_channel_id: channel.get_short_channel_id(),
 274                                 remote_network_id: channel.get_their_node_id(),
 275                                 channel_value_satoshis: channel.get_value_satoshis(),
 276                                 user_id: channel.get_user_id(),
 277                         });
 278                 }
 279                 res
 280         }
 281
 282         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
 283         /// will be accepted on the given channel, and after additional timeout/the closing of all
 284         /// pending HTLCs, the channel will be closed on chain.
 285         pub fn close_channel(&self, channel_id: &Uint256) -> Result<msgs::Shutdown, HandleError> {
 286                 let res = {
 287                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 288                         let channel_state = channel_state_lock.borrow_parts();
 289
 290                         match channel_state.by_id.entry(channel_id.clone()) {
 291                                 hash_map::Entry::Occupied(mut chan_entry) => {
 292                                         let res = chan_entry.get_mut().get_shutdown()?;
 293                                         if chan_entry.get().is_shutdown() {
 294                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
 295                                                         channel_state.short_to_id.remove(&short_id);
 296                                                 }
 297                                                 chan_entry.remove_entry();
 298                                         }
 299                                         res
 300                                 },
 301                                 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", msg: None})
 302                         }
 303                 };
 304                 for payment_hash in res.1 {
 305                         // unknown_next_peer...I dunno who that is anymore....
 306                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
 307                 }
 308                 Ok(res.0)
 309         }
 310
 311         #[inline]
 312         fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
 313                 ({
 314                         let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
 315                         hmac.input(&shared_secret[..]);
 316                         let mut res = [0; 32];
 317                         hmac.raw_result(&mut res);
 318                         res
 319                 },
 320                 {
 321                         let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
 322                         hmac.input(&shared_secret[..]);
 323                         let mut res = [0; 32];
 324                         hmac.raw_result(&mut res);
 325                         res
 326                 })
 327         }
 328
 329         #[inline]
 330         fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
 331                 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
 332                 hmac.input(&shared_secret[..]);
 333                 let mut res = [0; 32];
 334                 hmac.raw_result(&mut res);
 335                 res
 336         }
 337
 338         #[inline]
 339         fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
 340                 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
 341                 hmac.input(&shared_secret[..]);
 342                 let mut res = [0; 32];
 343                 hmac.raw_result(&mut res);
 344                 res
 345         }
 346
 347         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 348         #[inline]
 349         fn construct_onion_keys_callback<FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1, route: &Route, session_priv: &SecretKey, mut callback: FType) -> Result<(), HandleError> {
 350                 let mut blinded_priv = session_priv.clone();
 351                 let mut blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
 352                 let mut first_iteration = true;
 353
 354                 for hop in route.hops.iter() {
 355                         let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
 356
 357                         let mut sha = Sha256::new();
 358                         sha.input(&blinded_pub.serialize()[..]);
 359                         sha.input(&shared_secret[..]);
 360                         let mut blinding_factor = [0u8; 32];
 361                         sha.result(&mut blinding_factor);
 362
 363                         if first_iteration {
 364                                 blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
 365                                 first_iteration = false;
 366                         }
 367                         let ephemeral_pubkey = blinded_pub;
 368
 369                         secp_call!(blinded_priv.mul_assign(secp_ctx, &secp_call!(SecretKey::from_slice(secp_ctx, &blinding_factor))));
 370                         blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
 371
 372                         callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
 373                 }
 374
 375                 Ok(())
 376         }
 377
 378         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 379         fn construct_onion_keys(secp_ctx: &Secp256k1, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, HandleError> {
 380                 let mut res = Vec::with_capacity(route.hops.len());
 381
 382                 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
 383                         let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
 384
 385                         res.push(OnionKeys {
 386                                 #[cfg(test)]
 387                                 shared_secret,
 388                                 #[cfg(test)]
 389                                 blinding_factor: _blinding_factor,
 390                                 ephemeral_pubkey,
 391                                 rho,
 392                                 mu,
 393                         });
 394                 })?;
 395
 396                 Ok(res)
 397         }
 398
 399         /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
 400         fn build_onion_payloads(route: &Route) -> Result<(Vec<msgs::OnionHopData>, u64, u32), HandleError> {
 401                 let mut cur_value_msat = 0u64;
 402                 let mut cur_cltv = 0u32;
 403                 let mut last_short_channel_id = 0;
 404                 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
 405                 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
 406                 unsafe { res.set_len(route.hops.len()); }
 407
 408                 for (idx, hop) in route.hops.iter().enumerate().rev() {
 409                         // First hop gets special values so that it can check, on receipt, that everything is
 410                         // exactly as it should be (and the next hop isn't trying to probe to find out if we're
 411                         // the intended recipient).
 412                         let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
 413                         let cltv = if cur_cltv == 0 { hop.cltv_expiry_delta } else { cur_cltv };
 414                         res[idx] = msgs::OnionHopData {
 415                                 realm: 0,
 416                                 data: msgs::OnionRealm0HopData {
 417                                         short_channel_id: last_short_channel_id,
 418                                         amt_to_forward: value_msat,
 419                                         outgoing_cltv_value: cltv,
 420                                 },
 421                                 hmac: [0; 32],
 422                         };
 423                         cur_value_msat += hop.fee_msat;
 424                         if cur_value_msat >= 21000000 * 100000000 * 1000 {
 425                                 return Err(HandleError{err: "Channel fees overflowed?!", msg: None});
 426                         }
 427                         cur_cltv += hop.cltv_expiry_delta as u32;
 428                         if cur_cltv >= 500000000 {
 429                                 return Err(HandleError{err: "Channel CLTV overflowed?!", msg: None});
 430                         }
 431                         last_short_channel_id = hop.short_channel_id;
 432                 }
 433                 Ok((res, cur_value_msat, cur_cltv))
 434         }
 435
 436         #[inline]
 437         fn shift_arr_right(arr: &mut [u8; 20*65]) {
 438                 unsafe {
 439                         ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
 440                 }
 441                 for i in 0..65 {
 442                         arr[i] = 0;
 443                 }
 444         }
 445
 446         #[inline]
 447         fn xor_bufs(dst: &mut[u8], src: &[u8]) {
 448                 assert_eq!(dst.len(), src.len());
 449
 450                 for i in 0..dst.len() {
 451                         dst[i] ^= src[i];
 452                 }
 453         }
 454
 455         const ZERO:[u8; 21*65] = [0; 21*65];
 456         fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: Vec<u8>) -> Result<msgs::OnionPacket, HandleError> {
 457                 let mut buf = Vec::with_capacity(21*65);
 458                 buf.resize(21*65, 0);
 459
 460                 let filler = {
 461                         let iters = payloads.len() - 1;
 462                         let end_len = iters * 65;
 463                         let mut res = Vec::with_capacity(end_len);
 464                         res.resize(end_len, 0);
 465
 466                         for (i, keys) in onion_keys.iter().enumerate() {
 467                                 if i == payloads.len() - 1 { continue; }
 468                                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 469                                 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
 470                                 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
 471                         }
 472                         res
 473                 };
 474
 475                 let mut packet_data = [0; 20*65];
 476                 let mut hmac_res = [0; 32];
 477
 478                 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
 479                         ChannelManager::shift_arr_right(&mut packet_data);
 480                         payload.hmac = hmac_res;
 481                         packet_data[0..65].copy_from_slice(&payload.encode()[..]);
 482
 483                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 484                         chacha.process(&packet_data, &mut buf[0..20*65]);
 485                         packet_data[..].copy_from_slice(&buf[0..20*65]);
 486
 487                         if i == 0 {
 488                                 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
 489                         }
 490
 491                         let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
 492                         hmac.input(&packet_data);
 493                         hmac.input(&associated_data[..]);
 494                         hmac.raw_result(&mut hmac_res);
 495                 }
 496
 497                 Ok(msgs::OnionPacket{
 498                         version: 0,
 499                         public_key: onion_keys.first().unwrap().ephemeral_pubkey,
 500                         hop_data: packet_data,
 501                         hmac: hmac_res,
 502                 })
 503         }
 504
 505         /// Encrypts a failure packet. raw_packet can either be a
 506         /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
 507         fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
 508                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
 509
 510                 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
 511                 packet_crypted.resize(raw_packet.len(), 0);
 512                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
 513                 chacha.process(&raw_packet, &mut packet_crypted[..]);
 514                 msgs::OnionErrorPacket {
 515                         data: packet_crypted,
 516                 }
 517         }
 518
 519         fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
 520                 assert!(failure_data.len() <= 256 - 2);
 521
 522                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
 523
 524                 let failuremsg = {
 525                         let mut res = Vec::with_capacity(2 + failure_data.len());
 526                         res.push(((failure_type >> 8) & 0xff) as u8);
 527                         res.push(((failure_type >> 0) & 0xff) as u8);
 528                         res.extend_from_slice(&failure_data[..]);
 529                         res
 530                 };
 531                 let pad = {
 532                         let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
 533                         res.resize(256 - 2 - failure_data.len(), 0);
 534                         res
 535                 };
 536                 let mut packet = msgs::DecodedOnionErrorPacket {
 537                         hmac: [0; 32],
 538                         failuremsg: failuremsg,
 539                         pad: pad,
 540                 };
 541
 542                 let mut hmac = Hmac::new(Sha256::new(), &um);
 543                 hmac.input(&packet.encode()[32..]);
 544                 hmac.raw_result(&mut packet.hmac);
 545
 546                 packet
 547         }
 548
 549         #[inline]
 550         fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
 551                 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
 552                 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
 553         }
 554
 555         /// only fails if the channel does not yet have an assigned short_id
 556         fn get_channel_update(&self, chan: &mut Channel) -> Result<msgs::ChannelUpdate, HandleError> {
 557                 let short_channel_id = match chan.get_short_channel_id() {
 558                         None => return Err(HandleError{err: "Channel not yet established", msg: None}),
 559                         Some(id) => id,
 560                 };
 561
 562                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).unwrap().serialize()[..] < chan.get_their_node_id().serialize()[..];
 563
 564                 let unsigned = msgs::UnsignedChannelUpdate {
 565                         chain_hash: self.genesis_hash,
 566                         short_channel_id: short_channel_id,
 567                         timestamp: chan.get_channel_update_count(),
 568                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
 569                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
 570                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
 571                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
 572                         fee_proportional_millionths: self.fee_proportional_millionths,
 573                 };
 574
 575                 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
 576                 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key).unwrap(); //TODO Can we unwrap here?
 577
 578                 Ok(msgs::ChannelUpdate {
 579                         signature: sig,
 580                         contents: unsigned
 581                 })
 582         }
 583
 584         /// Sends a payment along a given route, returning the UpdateAddHTLC message to give to the
 585         /// first hop in route. Value parameters are provided via the last hop in route, see
 586         /// documentation for RouteHop fields for more info.
 587         /// See-also docs on Channel::send_htlc_and_commit.
 588         pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned)>, HandleError> {
 589                 if route.hops.len() < 1 || route.hops.len() > 20 {
 590                         return Err(HandleError{err: "Route didn't go anywhere/had bogus size", msg: None});
 591                 }
 592                 let our_node_id = self.get_our_node_id();
 593                 for (idx, hop) in route.hops.iter().enumerate() {
 594                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
 595                                 return Err(HandleError{err: "Route went through us but wasn't a simple rebalance loop to us", msg: None});
 596                         }
 597                 }
 598
 599                 let session_priv = secp_call!(SecretKey::from_slice(&self.secp_ctx, &{
 600                         let mut session_key = [0; 32];
 601                         rng::fill_bytes(&mut session_key);
 602                         session_key
 603                 }));
 604
 605                 let associated_data = Vec::new(); //TODO: What to put here?
 606
 607                 let onion_keys = ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv)?;
 608                 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route)?;
 609                 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, associated_data)?;
 610
 611                 let mut channel_state = self.channel_state.lock().unwrap();
 612                 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
 613                         None => return Err(HandleError{err: "No channel available with first hop!", msg: None}),
 614                         Some(id) => id.clone()
 615                 };
 616                 let res = {
 617                         let chan = channel_state.by_id.get_mut(&id).unwrap();
 618                         if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
 619                                 return Err(HandleError{err: "Node ID mismatch on first hop!", msg: None});
 620                         }
 621                         chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, onion_packet)?
 622                 };
 623
 624                 if channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::OutboundRoute {
 625                         route,
 626                         session_priv,
 627                 }).is_some() {
 628                         // TODO: We need to track these better, we're not generating these, so a
 629                         // third-party might make this happen:
 630                         panic!("payment_hash was repeated! Don't let this happen");
 631                 }
 632
 633                 Ok(res)
 634         }
 635
 636         /// Call this upon creation of a funding transaction for the given channel.
 637         /// Panics if a funding transaction has already been provided for this channel.
 638         pub fn funding_transaction_generated(&self, temporary_channel_id: &Uint256, funding_txo: (Sha256dHash, u16)) {
 639                 let (chan, msg) = {
 640                         let mut channel_state = self.channel_state.lock().unwrap();
 641                         match channel_state.by_id.remove(&temporary_channel_id) {
 642                                 Some(mut chan) => {
 643                                         match chan.get_outbound_funding_created(funding_txo.0, funding_txo.1) {
 644                                                 Ok(funding_msg) => {
 645                                                         (chan, funding_msg)
 646                                                 },
 647                                                 Err(_e) => {
 648                                                         //TODO: Push e to pendingevents
 649                                                         return;
 650                                                 }
 651                                         }
 652                                 },
 653                                 None => return
 654                         }
 655                 }; // Release channel lock for install_watch_outpoint call,
 656                 let chan_monitor = chan.channel_monitor();
 657                 match self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
 658                         Ok(()) => {},
 659                         Err(_e) => {
 660                                 //TODO: Push e to pendingevents?
 661                                 return;
 662                         }
 663                 };
 664
 665                 {
 666                         let mut pending_events = self.pending_events.lock().unwrap();
 667                         pending_events.push(events::Event::SendFundingCreated {
 668                                 node_id: chan.get_their_node_id(),
 669                                 msg: msg,
 670                         });
 671                 }
 672
 673                 let mut channel_state = self.channel_state.lock().unwrap();
 674                 channel_state.by_id.insert(chan.channel_id(), chan);
 675         }
 676
 677         fn get_announcement_sigs(&self, chan: &Channel) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
 678                 if !chan.is_usable() { return Ok(None) }
 679
 680                 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone())?;
 681                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
 682                 let our_node_sig = secp_call!(self.secp_ctx.sign(&msghash, &self.our_network_key));
 683
 684                 Ok(Some(msgs::AnnouncementSignatures {
 685                         channel_id: chan.channel_id(),
 686                         short_channel_id: chan.get_short_channel_id().unwrap(),
 687                         node_signature: our_node_sig,
 688                         bitcoin_signature: our_bitcoin_sig,
 689                 }))
 690         }
 691
 692         pub fn process_pending_htlc_forward(&self) {
 693                 let mut new_events = Vec::new();
 694                 let mut failed_forwards = Vec::new();
 695                 {
 696                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 697                         let channel_state = channel_state_lock.borrow_parts();
 698
 699                         if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
 700                                 return;
 701                         }
 702
 703                         for (short_chan_id, pending_forwards) in channel_state.forward_htlcs.drain() {
 704                                 if short_chan_id != 0 {
 705                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
 706                                                 Some(chan_id) => chan_id.clone(),
 707                                                 None => {
 708                                                         failed_forwards.reserve(pending_forwards.len());
 709                                                         for forward_info in pending_forwards {
 710                                                                 failed_forwards.push((forward_info.payment_hash, 0x4000 | 10, None));
 711                                                         }
 712                                                         // TODO: Send a failure packet back on each pending_forward
 713                                                         continue;
 714                                                 }
 715                                         };
 716                                         let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
 717
 718                                         let mut add_htlc_msgs = Vec::new();
 719                                         for forward_info in pending_forwards {
 720                                                 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, forward_info.onion_packet.unwrap()) {
 721                                                         Err(_e) => {
 722                                                                 let chan_update = self.get_channel_update(forward_chan).unwrap();
 723                                                                 failed_forwards.push((forward_info.payment_hash, 0x4000 | 7, Some(chan_update)));
 724                                                                 continue;
 725                                                         },
 726                                                         Ok(update_add) => {
 727                                                                 match update_add {
 728                                                                         Some(msg) => { add_htlc_msgs.push(msg); },
 729                                                                         None => {
 730                                                                                 // Nothing to do here...we're waiting on a remote
 731                                                                                 // revoke_and_ack before we can add anymore HTLCs. The Channel
 732                                                                                 // will automatically handle building the update_add_htlc and
 733                                                                                 // commitment_signed messages when we can.
 734                                                                                 // TODO: Do some kind of timer to set the channel as !is_live()
 735                                                                                 // as we don't really want others relying on us relaying through
 736                                                                                 // this channel currently :/.
 737                                                                         }
 738                                                                 }
 739                                                         }
 740                                                 }
 741                                         }
 742
 743                                         if !add_htlc_msgs.is_empty() {
 744                                                 let commitment_msg = match forward_chan.send_commitment() {
 745                                                         Ok(msg) => msg,
 746                                                         Err(_) => {
 747                                                                 //TODO: Handle...this is bad!
 748                                                                 continue;
 749                                                         },
 750                                                 };
 751                                                 new_events.push(events::Event::SendHTLCs {
 752                                                         node_id: forward_chan.get_their_node_id(),
 753                                                         msgs: add_htlc_msgs,
 754                                                         commitment_msg: commitment_msg,
 755                                                 });
 756                                         }
 757                                 } else {
 758                                         for forward_info in pending_forwards {
 759                                                 new_events.push(events::Event::PaymentReceived {
 760                                                         payment_hash: forward_info.payment_hash,
 761                                                         amt: forward_info.amt_to_forward,
 762                                                 });
 763                                         }
 764                                 }
 765                         }
 766                 }
 767
 768                 for failed_forward in failed_forwards.drain(..) {
 769                         match failed_forward.2 {
 770                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: Vec::new() }),
 771                                 Some(chan_update) => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: chan_update.encode_with_len() }),
 772                         };
 773                 }
 774
 775                 if new_events.is_empty() { return }
 776
 777                 let mut events = self.pending_events.lock().unwrap();
 778                 events.reserve(new_events.len());
 779                 for event in new_events.drain(..) {
 780                         events.push(event);
 781                 }
 782         }
 783
 784         /// Indicates that the preimage for payment_hash is unknown after a PaymentReceived event.
 785         pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32]) -> bool {
 786                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: Vec::new() })
 787         }
 788
 789         fn fail_htlc_backwards_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, payment_hash: &[u8; 32], onion_error: HTLCFailReason) -> bool {
 790                 let mut pending_htlc = {
 791                         match channel_state.claimable_htlcs.remove(payment_hash) {
 792                                 Some(pending_htlc) => pending_htlc,
 793                                 None => return false,
 794                         }
 795                 };
 796
 797                 match pending_htlc {
 798                         PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
 799                                 channel_state.claimable_htlcs.insert(payment_hash.clone(), PendingOutboundHTLC::OutboundRoute {
 800                                         route,
 801                                         session_priv,
 802                                 });
 803                                 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
 804                         },
 805                         _ => {}
 806                 }
 807
 808                 match pending_htlc {
 809                         PendingOutboundHTLC::CycledRoute { .. } => { panic!("WAT"); },
 810                         PendingOutboundHTLC::OutboundRoute { .. } => {
 811                                 mem::drop(channel_state);
 812
 813                                 let mut pending_events = self.pending_events.lock().unwrap();
 814                                 pending_events.push(events::Event::PaymentFailed {
 815                                         payment_hash: payment_hash.clone()
 816                                 });
 817                                 false
 818                         },
 819                         PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret } => {
 820                                 let err_packet = match onion_error {
 821                                         HTLCFailReason::Reason { failure_code, data } => {
 822                                                 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
 823                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
 824                                         },
 825                                         HTLCFailReason::ErrorPacket { err } => {
 826                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
 827                                         }
 828                                 };
 829
 830                                 let (node_id, fail_msgs) = {
 831                                         let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
 832                                                 Some(chan_id) => chan_id.clone(),
 833                                                 None => return false
 834                                         };
 835
 836                                         let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
 837                                         match chan.get_update_fail_htlc_and_commit(payment_hash, err_packet) {
 838                                                 Ok(msg) => (chan.get_their_node_id(), msg),
 839                                                 Err(_e) => {
 840                                                         //TODO: Do something with e?
 841                                                         return false;
 842                                                 },
 843                                         }
 844                                 };
 845
 846                                 match fail_msgs {
 847                                         Some(msgs) => {
 848                                                 mem::drop(channel_state);
 849                                                 let mut pending_events = self.pending_events.lock().unwrap();
 850                                                 pending_events.push(events::Event::SendFailHTLC {
 851                                                         node_id,
 852                                                         msg: msgs.0,
 853                                                         commitment_msg: msgs.1,
 854                                                 });
 855                                         },
 856                                         None => {},
 857                                 }
 858
 859                                 true
 860                         },
 861                 }
 862         }
 863
 864         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
 865         /// generating message events for the net layer to claim the payment, if possible. Thus, you
 866         /// should probably kick the net layer to go send messages if this returns true!
 867         /// May panic if called except in response to a PaymentReceived event.
 868         pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
 869                 self.claim_funds_internal(payment_preimage, true)
 870         }
 871         pub fn claim_funds_internal(&self, payment_preimage: [u8; 32], from_user: bool) -> bool {
 872                 let mut sha = Sha256::new();
 873                 sha.input(&payment_preimage);
 874                 let mut payment_hash = [0; 32];
 875                 sha.result(&mut payment_hash);
 876
 877                 let mut channel_state = self.channel_state.lock().unwrap();
 878                 let mut pending_htlc = {
 879                         match channel_state.claimable_htlcs.remove(&payment_hash) {
 880                                 Some(pending_htlc) => pending_htlc,
 881                                 None => return false,
 882                         }
 883                 };
 884
 885                 match pending_htlc {
 886                         PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
 887                                 if from_user { // This was the end hop back to us
 888                                         pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
 889                                         channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::OutboundRoute { route, session_priv });
 890                                 } else { // This came from the first upstream node
 891                                         // Bank error in our favor! Maybe we should tell the user this somehow???
 892                                         pending_htlc = PendingOutboundHTLC::OutboundRoute { route, session_priv };
 893                                         channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret });
 894                                 }
 895                         },
 896                         _ => {},
 897                 }
 898
 899                 match pending_htlc {
 900                         PendingOutboundHTLC::CycledRoute { .. } => { panic!("WAT"); },
 901                         PendingOutboundHTLC::OutboundRoute { .. } => {
 902                                 if from_user {
 903                                         panic!("Called claim_funds with a preimage for an outgoing payment. There is nothing we can do with this, and something is seriously wrong if you knew this...");
 904                                 }
 905                                 mem::drop(channel_state);
 906                                 let mut pending_events = self.pending_events.lock().unwrap();
 907                                 pending_events.push(events::Event::PaymentSent {
 908                                         payment_preimage
 909                                 });
 910                                 false
 911                         },
 912                         PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, .. } => {
 913                                 let (node_id, fulfill_msgs, monitor) = {
 914                                         let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
 915                                                 Some(chan_id) => chan_id.clone(),
 916                                                 None => return false
 917                                         };
 918
 919                                         let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
 920                                         match chan.get_update_fulfill_htlc_and_commit(payment_preimage) {
 921                                                 Ok(msg) => (chan.get_their_node_id(), msg, if from_user { Some(chan.channel_monitor()) } else { None }),
 922                                                 Err(_e) => {
 923                                                         //TODO: Do something with e?
 924                                                         return false;
 925                                                 },
 926                                         }
 927                                 };
 928
 929                                 mem::drop(channel_state);
 930                                 match fulfill_msgs {
 931                                         Some(msgs) => {
 932                                                 let mut pending_events = self.pending_events.lock().unwrap();
 933                                                 pending_events.push(events::Event::SendFulfillHTLC {
 934                                                         node_id: node_id,
 935                                                         msg: msgs.0,
 936                                                         commitment_msg: msgs.1,
 937                                                 });
 938                                         },
 939                                         None => {},
 940                                 }
 941
 942                                 //TODO: It may not be possible to handle add_update_monitor fails gracefully, maybe
 943                                 //it should return no Err? Sadly, panic!()s instead doesn't help much :(
 944                                 if from_user {
 945                                         match self.monitor.add_update_monitor(monitor.as_ref().unwrap().get_funding_txo().unwrap(), monitor.unwrap()) {
 946                                                 Ok(()) => true,
 947                                                 Err(_) => true,
 948                                         }
 949                                 } else { true }
 950                         },
 951                 }
 952         }
 953
 954         /// Gets the node_id held by this ChannelManager
 955         pub fn get_our_node_id(&self) -> PublicKey {
 956                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).unwrap()
 957         }
 958 }
 959
 960 impl events::EventsProvider for ChannelManager {
 961         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
 962                 let mut pending_events = self.pending_events.lock().unwrap();
 963                 let mut ret = Vec::new();
 964                 mem::swap(&mut ret, &mut *pending_events);
 965                 ret
 966         }
 967 }
 968
 969 impl ChainListener for ChannelManager {
 970         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
 971                 let mut new_funding_locked_messages = Vec::new();
 972                 {
 973                         let mut channel_state = self.channel_state.lock().unwrap();
 974                         let mut short_to_ids_to_insert = Vec::new();
 975                         for channel in channel_state.by_id.values_mut() {
 976                                 match channel.block_connected(header, height, txn_matched, indexes_of_txn_matched) {
 977                                         Some(funding_locked) => {
 978                                                 let announcement_sigs = match self.get_announcement_sigs(channel) {
 979                                                         Ok(res) => res,
 980                                                         Err(_e) => {
 981                                                                 //TODO: push e on events and blow up the channel (it has bad keys)
 982                                                                 continue;
 983                                                         }
 984                                                 };
 985                                                 new_funding_locked_messages.push(events::Event::SendFundingLocked {
 986                                                         node_id: channel.get_their_node_id(),
 987                                                         msg: funding_locked,
 988                                                         announcement_sigs: announcement_sigs
 989                                                 });
 990                                                 short_to_ids_to_insert.push((channel.get_short_channel_id().unwrap(), channel.channel_id()));
 991                                         },
 992                                         None => {}
 993                                 }
 994                                 //TODO: Check if channel was closed (or disabled) here
 995                         }
 996                         for to_insert in short_to_ids_to_insert {
 997                                 channel_state.short_to_id.insert(to_insert.0, to_insert.1);
 998                         }
 999                 }
1000                 let mut pending_events = self.pending_events.lock().unwrap();
1001                 for funding_locked in new_funding_locked_messages.drain(..) {
1002                         pending_events.push(funding_locked);
1003                 }
1004         }
1005
1006         fn block_disconnected(&self, header: &BlockHeader) {
1007                 let mut channel_state = self.channel_state.lock().unwrap();
1008                 for channel in channel_state.by_id.values_mut() {
1009                         if channel.block_disconnected(header) {
1010                                 //TODO Close channel here
1011                         }
1012                 }
1013         }
1014 }
1015
1016 impl ChannelMessageHandler for ChannelManager {
1017         //TODO: Handle errors and close channel (or so)
1018         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, HandleError> {
1019                 if msg.chain_hash != self.genesis_hash {
1020                         return Err(HandleError{err: "Unknown genesis block hash", msg: None});
1021                 }
1022                 let mut channel_state = self.channel_state.lock().unwrap();
1023                 if channel_state.by_id.contains_key(&msg.temporary_channel_id) {
1024                         return Err(HandleError{err: "temporary_channel_id collision!", msg: None});
1025                 }
1026
1027                 let chan_keys = if cfg!(feature = "fuzztarget") {
1028                         ChannelKeys {
1029                                 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, 0]).unwrap(),
1030                                 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, 0]).unwrap(),
1031                                 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, 0]).unwrap(),
1032                                 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, 0]).unwrap(),
1033                                 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, 0]).unwrap(),
1034                                 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, 0]).unwrap(),
1035                                 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, 0]).unwrap(),
1036                                 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],
1037                         }
1038                 } else {
1039                         let mut key_seed = [0u8; 32];
1040                         rng::fill_bytes(&mut key_seed);
1041                         match ChannelKeys::new_from_seed(&key_seed) {
1042                                 Ok(key) => key,
1043                                 Err(_) => panic!("RNG is busted!")
1044                         }
1045                 };
1046
1047                 let channel = Channel::new_from_req(&*self.fee_estimator, chan_keys, their_node_id.clone(), msg, 0, self.announce_channels_publicly)?;
1048                 let accept_msg = channel.get_accept_channel()?;
1049                 channel_state.by_id.insert(channel.channel_id(), channel);
1050                 Ok(accept_msg)
1051         }
1052
1053         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
1054                 let (value, output_script, user_id) = {
1055                         let mut channel_state = self.channel_state.lock().unwrap();
1056                         match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1057                                 Some(chan) => {
1058                                         if chan.get_their_node_id() != *their_node_id {
1059                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1060                                         }
1061                                         chan.accept_channel(&msg)?;
1062                                         (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1063                                 },
1064                                 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1065                         }
1066                 };
1067                 let mut pending_events = self.pending_events.lock().unwrap();
1068                 pending_events.push(events::Event::FundingGenerationReady {
1069                         temporary_channel_id: msg.temporary_channel_id,
1070                         channel_value_satoshis: value,
1071                         output_script: output_script,
1072                         user_channel_id: user_id,
1073                 });
1074                 Ok(())
1075         }
1076
1077         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, HandleError> {
1078                 //TODO: broke this - a node shouldn't be able to get their channel removed by sending a
1079                 //funding_created a second time, or long after the first, or whatever (note this also
1080                 //leaves the short_to_id map in a busted state.
1081                 let chan = {
1082                         let mut channel_state = self.channel_state.lock().unwrap();
1083                         match channel_state.by_id.remove(&msg.temporary_channel_id) {
1084                                 Some(mut chan) => {
1085                                         if chan.get_their_node_id() != *their_node_id {
1086                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1087                                         }
1088                                         match chan.funding_created(msg) {
1089                                                 Ok(funding_msg) => {
1090                                                         (chan, funding_msg)
1091                                                 },
1092                                                 Err(e) => {
1093                                                         return Err(e);
1094                                                 }
1095                                         }
1096                                 },
1097                                 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1098                         }
1099                 }; // Release channel lock for install_watch_outpoint call,
1100                    // note that this means if the remote end is misbehaving and sends a message for the same
1101                    // channel back-to-back with funding_created, we'll end up thinking they sent a message
1102                    // for a bogus channel.
1103                 let chan_monitor = chan.0.channel_monitor();
1104                 self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor)?;
1105                 let mut channel_state = self.channel_state.lock().unwrap();
1106                 channel_state.by_id.insert(chan.1.channel_id, chan.0);
1107                 Ok(chan.1)
1108         }
1109
1110         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
1111                 let (funding_txo, user_id) = {
1112                         let mut channel_state = self.channel_state.lock().unwrap();
1113                         match channel_state.by_id.get_mut(&msg.channel_id) {
1114                                 Some(chan) => {
1115                                         if chan.get_their_node_id() != *their_node_id {
1116                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1117                                         }
1118                                         chan.funding_signed(&msg)?;
1119                                         (chan.get_funding_txo().unwrap(), chan.get_user_id())
1120                                 },
1121                                 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1122                         }
1123                 };
1124                 let mut pending_events = self.pending_events.lock().unwrap();
1125                 pending_events.push(events::Event::FundingBroadcastSafe {
1126                         funding_txo: funding_txo,
1127                         user_channel_id: user_id,
1128                 });
1129                 Ok(())
1130         }
1131
1132         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
1133                 let mut channel_state = self.channel_state.lock().unwrap();
1134                 match channel_state.by_id.get_mut(&msg.channel_id) {
1135                         Some(chan) => {
1136                                 if chan.get_their_node_id() != *their_node_id {
1137                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1138                                 }
1139                                 chan.funding_locked(&msg)?;
1140                                 return Ok(self.get_announcement_sigs(chan)?);
1141                         },
1142                         None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1143                 };
1144         }
1145
1146         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), HandleError> {
1147                 let res = {
1148                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1149                         let channel_state = channel_state_lock.borrow_parts();
1150
1151                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1152                                 hash_map::Entry::Occupied(mut chan_entry) => {
1153                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1154                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1155                                         }
1156                                         let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg)?;
1157                                         if chan_entry.get().is_shutdown() {
1158                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1159                                                         channel_state.short_to_id.remove(&short_id);
1160                                                 }
1161                                                 chan_entry.remove_entry();
1162                                         }
1163                                         res
1164                                 },
1165                                 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1166                         }
1167                 };
1168                 for payment_hash in res.2 {
1169                         // unknown_next_peer...I dunno who that is anymore....
1170                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1171                 }
1172                 Ok((res.0, res.1))
1173         }
1174
1175         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, HandleError> {
1176                 let res = {
1177                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1178                         let channel_state = channel_state_lock.borrow_parts();
1179                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1180                                 hash_map::Entry::Occupied(mut chan_entry) => {
1181                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1182                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1183                                         }
1184                                         let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg)?;
1185                                         if res.1.is_some() {
1186                                                 // We're done with this channel, we've got a signed closing transaction and
1187                                                 // will send the closing_signed back to the remote peer upon return. This
1188                                                 // also implies there are no pending HTLCs left on the channel, so we can
1189                                                 // fully delete it from tracking (the channel monitor is still around to
1190                                                 // watch for old state broadcasts)!
1191                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1192                                                         channel_state.short_to_id.remove(&short_id);
1193                                                 }
1194                                                 chan_entry.remove_entry();
1195                                         }
1196                                         res
1197                                 },
1198                                 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1199                         }
1200                 };
1201                 if let Some(broadcast_tx) = res.1 {
1202                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1203                 }
1204                 Ok(res.0)
1205         }
1206
1207         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
1208                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1209                 //determine the state of the payment based on our response/if we forward anything/the time
1210                 //we take to respond. We should take care to avoid allowing such an attack.
1211                 //
1212                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1213                 //us repeatedly garbled in different ways, and compare our error messages, which are
1214                 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1215                 //but we should prevent it anyway.
1216
1217                 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key, &self.our_network_key);
1218                 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
1219
1220                 let associated_data = Vec::new(); //TODO: What to put here?
1221
1222                 macro_rules! get_onion_hash {
1223                         () => {
1224                                 {
1225                                         let mut sha = Sha256::new();
1226                                         sha.input(&msg.onion_routing_packet.hop_data);
1227                                         let mut onion_hash = [0; 32];
1228                                         sha.result(&mut onion_hash);
1229                                         onion_hash
1230                                 }
1231                         }
1232                 }
1233
1234                 macro_rules! return_err {
1235                         ($msg: expr, $err_code: expr, $data: expr) => {
1236                                 return Err(msgs::HandleError {
1237                                         err: $msg,
1238                                         msg: Some(msgs::ErrorAction::UpdateFailHTLC {
1239                                                 msg: msgs::UpdateFailHTLC {
1240                                                         channel_id: msg.channel_id,
1241                                                         htlc_id: msg.htlc_id,
1242                                                         reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1243                                                 }
1244                                         }),
1245                                 });
1246                         }
1247                 }
1248
1249                 if msg.onion_routing_packet.version != 0 {
1250                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1251                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1252                         //the hash doesn't really serve any purpuse - in the case of hashing all data, the
1253                         //receiving node would have to brute force to figure out which version was put in the
1254                         //packet by the node that send us the message, in the case of hashing the hop_data, the
1255                         //node knows the HMAC matched, so they already know what is there...
1256                         return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
1257                 }
1258
1259                 let mut hmac = Hmac::new(Sha256::new(), &mu);
1260                 hmac.input(&msg.onion_routing_packet.hop_data);
1261                 hmac.input(&associated_data[..]);
1262                 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
1263                         return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
1264                 }
1265
1266                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1267                 let next_hop_data = {
1268                         let mut decoded = [0; 65];
1269                         chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
1270                         match msgs::OnionHopData::decode(&decoded[..]) {
1271                                 Err(err) => {
1272                                         let error_code = match err {
1273                                                 msgs::DecodeError::UnknownRealmByte => 0x4000 | 1,
1274                                                 _ => 0x2000 | 2, // Should never happen
1275                                         };
1276                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
1277                                 },
1278                                 Ok(msg) => msg
1279                         }
1280                 };
1281
1282                 let mut pending_forward_info = if next_hop_data.hmac == [0; 32] {
1283                                 // OUR PAYMENT!
1284                                 if next_hop_data.data.amt_to_forward != msg.amount_msat {
1285                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1286                                 }
1287                                 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
1288                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1289                                 }
1290
1291                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
1292                                 // message, however that would leak that we are the recipient of this payment, so
1293                                 // instead we stay symmetric with the forwarding case, only responding (after a
1294                                 // delay) once they've send us a commitment_signed!
1295
1296                                 PendingForwardHTLCInfo {
1297                                         onion_packet: None,
1298                                         payment_hash: msg.payment_hash.clone(),
1299                                         short_channel_id: 0,
1300                                         prev_short_channel_id: 0,
1301                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1302                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1303                                 }
1304                         } else {
1305                                 let mut new_packet_data = [0; 20*65];
1306                                 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
1307                                 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
1308
1309                                 let mut new_pubkey = msg.onion_routing_packet.public_key.clone();
1310
1311                                 let blinding_factor = {
1312                                         let mut sha = Sha256::new();
1313                                         sha.input(&new_pubkey.serialize()[..]);
1314                                         sha.input(&shared_secret[..]);
1315                                         let mut res = [0u8; 32];
1316                                         sha.result(&mut res);
1317                                         match SecretKey::from_slice(&self.secp_ctx, &res) {
1318                                                 Err(_) => {
1319                                                         // Return temporary node failure as its technically our issue, not the
1320                                                         // channel's issue.
1321                                                         return_err!("Blinding factor is an invalid private key", 0x2000 | 2, &[0;0]);
1322                                                 },
1323                                                 Ok(key) => key
1324                                         }
1325                                 };
1326
1327                                 match new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
1328                                         Err(_) => {
1329                                                 // Return temporary node failure as its technically our issue, not the
1330                                                 // channel's issue.
1331                                                 return_err!("New blinding factor is an invalid private key", 0x2000 | 2, &[0;0]);
1332                                         },
1333                                         Ok(_) => {}
1334                                 };
1335
1336                                 let outgoing_packet = msgs::OnionPacket {
1337                                         version: 0,
1338                                         public_key: new_pubkey,
1339                                         hop_data: new_packet_data,
1340                                         hmac: next_hop_data.hmac.clone(),
1341                                 };
1342
1343                                 //TODO: Check amt_to_forward and outgoing_cltv_value are within acceptable ranges!
1344
1345                                 PendingForwardHTLCInfo {
1346                                         onion_packet: Some(outgoing_packet),
1347                                         payment_hash: msg.payment_hash.clone(),
1348                                         short_channel_id: next_hop_data.data.short_channel_id,
1349                                         prev_short_channel_id: 0,
1350                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1351                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1352                                 }
1353                         };
1354
1355                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1356                 let channel_state = channel_state_lock.borrow_parts();
1357
1358                 if pending_forward_info.onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1359                         let forwarding_id = match channel_state.short_to_id.get(&pending_forward_info.short_channel_id) {
1360                                 None => {
1361                                         return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1362                                 },
1363                                 Some(id) => id.clone(),
1364                         };
1365                         let chan = channel_state.by_id.get_mut(&forwarding_id).unwrap();
1366                         if !chan.is_live() {
1367                                 let chan_update = self.get_channel_update(chan).unwrap();
1368                                 return_err!("Forwarding channel is not in a ready state.", 0x4000 | 7, &chan_update.encode_with_len()[..]);
1369                         }
1370                 }
1371
1372                 let claimable_htlcs_entry = channel_state.claimable_htlcs.entry(msg.payment_hash.clone());
1373
1374                 // We dont correctly handle payments that route through us twice on their way to their
1375                 // destination. That's OK since those nodes are probably busted or trying to do network
1376                 // mapping through repeated loops. In either case, we want them to stop talking to us, so
1377                 // we send permanent_node_failure.
1378                 match &claimable_htlcs_entry {
1379                         &hash_map::Entry::Occupied(ref e) => {
1380                                 let mut acceptable_cycle = false;
1381                                 match e.get() {
1382                                         &PendingOutboundHTLC::OutboundRoute { .. } => {
1383                                                 acceptable_cycle = pending_forward_info.short_channel_id == 0;
1384                                         },
1385                                         _ => {},
1386                                 }
1387                                 if !acceptable_cycle {
1388                                         return_err!("Payment looped through us twice", 0x4000 | 0x2000 | 2, &[0;0]);
1389                                 }
1390                         },
1391                         _ => {},
1392                 }
1393
1394                 let (source_short_channel_id, res) = match channel_state.by_id.get_mut(&msg.channel_id) {
1395                         Some(chan) => {
1396                                 if chan.get_their_node_id() != *their_node_id {
1397                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1398                                 }
1399                                 if !chan.is_usable() {
1400                                         return Err(HandleError{err: "Channel not yet available for receiving HTLCs", msg: None});
1401                                 }
1402                                 let short_channel_id = chan.get_short_channel_id().unwrap();
1403                                 pending_forward_info.prev_short_channel_id = short_channel_id;
1404                                 (short_channel_id, chan.update_add_htlc(&msg, pending_forward_info)?)
1405                         },
1406                         None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}), //TODO: panic?
1407                 };
1408
1409                 match claimable_htlcs_entry {
1410                         hash_map::Entry::Occupied(mut e) => {
1411                                 let outbound_route = e.get_mut();
1412                                 let (route, session_priv) = match outbound_route {
1413                                         &mut PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1414                                                 (route.clone(), session_priv.clone())
1415                                         },
1416                                         _ => { panic!("WAT") },
1417                                 };
1418                                 *outbound_route = PendingOutboundHTLC::CycledRoute {
1419                                         source_short_channel_id,
1420                                         incoming_packet_shared_secret: shared_secret,
1421                                         route,
1422                                         session_priv,
1423                                 };
1424                         },
1425                         hash_map::Entry::Vacant(e) => {
1426                                 e.insert(PendingOutboundHTLC::IntermediaryHopData {
1427                                         source_short_channel_id,
1428                                         incoming_packet_shared_secret: shared_secret,
1429                                 });
1430                         }
1431                 }
1432
1433                 Ok(res)
1434         }
1435
1436         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
1437                 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1438                 // Claim funds first, cause we don't really care if the channel we received the message on
1439                 // is broken, we may have enough info to get our own money!
1440                 self.claim_funds_internal(msg.payment_preimage.clone(), false);
1441
1442                 let monitor = {
1443                         let mut channel_state = self.channel_state.lock().unwrap();
1444                         match channel_state.by_id.get_mut(&msg.channel_id) {
1445                                 Some(chan) => {
1446                                         if chan.get_their_node_id() != *their_node_id {
1447                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1448                                         }
1449                                         chan.update_fulfill_htlc(&msg)?;
1450                                         chan.channel_monitor()
1451                                 },
1452                                 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1453                         }
1454                 };
1455                 self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor)?;
1456                 Ok(())
1457         }
1458
1459         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<Option<msgs::HTLCFailChannelUpdate>, HandleError> {
1460                 let mut channel_state = self.channel_state.lock().unwrap();
1461                 let payment_hash = match channel_state.by_id.get_mut(&msg.channel_id) {
1462                         Some(chan) => {
1463                                 if chan.get_their_node_id() != *their_node_id {
1464                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1465                                 }
1466                                 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
1467                         },
1468                         None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1469                 }?;
1470
1471                 if let Some(pending_htlc) = channel_state.claimable_htlcs.get(&payment_hash) {
1472                         match pending_htlc {
1473                                 &PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1474                                         // Handle packed channel/node updates for passing back for the route handler
1475                                         let mut packet_decrypted = msg.reason.data.clone();
1476                                         let mut res = None;
1477                                         Self::construct_onion_keys_callback(&self.secp_ctx, &route, &session_priv, |shared_secret, _, _, route_hop| {
1478                                                 if res.is_some() { return; }
1479
1480                                                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
1481
1482                                                 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1483                                                 decryption_tmp.resize(packet_decrypted.len(), 0);
1484                                                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1485                                                 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1486                                                 packet_decrypted = decryption_tmp;
1487
1488                                                 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::decode(&packet_decrypted) {
1489                                                         if err_packet.failuremsg.len() >= 2 {
1490                                                                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
1491
1492                                                                 let mut hmac = Hmac::new(Sha256::new(), &um);
1493                                                                 hmac.input(&err_packet.encode()[32..]);
1494                                                                 let mut calc_tag =  [0u8; 32];
1495                                                                 hmac.raw_result(&mut calc_tag);
1496                                                                 if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
1497                                                                         const UNKNOWN_CHAN: u16 = 0x4000|10;
1498                                                                         const TEMP_CHAN_FAILURE: u16 = 0x4000|7;
1499                                                                         match byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]) {
1500                                                                                 TEMP_CHAN_FAILURE => {
1501                                                                                         if err_packet.failuremsg.len() >= 4 {
1502                                                                                                 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[2..4]) as usize;
1503                                                                                                 if err_packet.failuremsg.len() >= 4 + update_len {
1504                                                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::decode(&err_packet.failuremsg[4..4 + update_len]) {
1505                                                                                                                 res = Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
1506                                                                                                                         msg: chan_update,
1507                                                                                                                 });
1508                                                                                                         }
1509                                                                                                 }
1510                                                                                         }
1511                                                                                 },
1512                                                                                 UNKNOWN_CHAN => {
1513                                                                                         // No such next-hop. We know this came from the
1514                                                                                         // current node as the HMAC validated.
1515                                                                                         res = Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
1516                                                                                                 short_channel_id: route_hop.short_channel_id
1517                                                                                         });
1518                                                                                 },
1519                                                                                 _ => {}, //TODO: Enumerate all of these!
1520                                                                         }
1521                                                                 }
1522                                                         }
1523                                                 }
1524                                         }).unwrap();
1525                                         Ok(res)
1526                                 },
1527                                 _ => { Ok(None) },
1528                         }
1529                 } else {
1530                         Ok(None)
1531                 }
1532         }
1533
1534         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
1535                 let mut channel_state = self.channel_state.lock().unwrap();
1536                 match channel_state.by_id.get_mut(&msg.channel_id) {
1537                         Some(chan) => {
1538                                 if chan.get_their_node_id() != *their_node_id {
1539                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1540                                 }
1541                                 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
1542                         },
1543                         None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1544                 }
1545         }
1546
1547         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), HandleError> {
1548                 let (res, monitor) = {
1549                         let mut channel_state = self.channel_state.lock().unwrap();
1550                         match channel_state.by_id.get_mut(&msg.channel_id) {
1551                                 Some(chan) => {
1552                                         if chan.get_their_node_id() != *their_node_id {
1553                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1554                                         }
1555                                         (chan.commitment_signed(&msg)?, chan.channel_monitor())
1556                                 },
1557                                 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1558                         }
1559                 };
1560                 //TODO: Only if we store HTLC sigs
1561                 self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor)?;
1562
1563                 Ok(res)
1564         }
1565
1566         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, HandleError> {
1567                 let ((res, mut pending_forwards, mut pending_failures), monitor) = {
1568                         let mut channel_state = self.channel_state.lock().unwrap();
1569                         match channel_state.by_id.get_mut(&msg.channel_id) {
1570                                 Some(chan) => {
1571                                         if chan.get_their_node_id() != *their_node_id {
1572                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1573                                         }
1574                                         (chan.revoke_and_ack(&msg)?, chan.channel_monitor())
1575                                 },
1576                                 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1577                         }
1578                 };
1579                 self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor)?;
1580                 for failure in pending_failures.drain(..) {
1581                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failure.0, failure.1);
1582                 }
1583
1584                 let mut forward_event = None;
1585                 if !pending_forwards.is_empty() {
1586                         let mut channel_state = self.channel_state.lock().unwrap();
1587                         if channel_state.forward_htlcs.is_empty() {
1588                                 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));
1589                                 channel_state.next_forward = forward_event.unwrap();
1590                         }
1591                         for forward_info in pending_forwards.drain(..) {
1592                                 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
1593                                         hash_map::Entry::Occupied(mut entry) => {
1594                                                 entry.get_mut().push(forward_info);
1595                                         },
1596                                         hash_map::Entry::Vacant(entry) => {
1597                                                 entry.insert(vec!(forward_info));
1598                                         }
1599                                 }
1600                         }
1601                 }
1602                 match forward_event {
1603                         Some(time) => {
1604                                 let mut pending_events = self.pending_events.lock().unwrap();
1605                                 pending_events.push(events::Event::PendingHTLCsForwardable {
1606                                         time_forwardable: time
1607                                 });
1608                         }
1609                         None => {},
1610                 }
1611
1612                 Ok(res)
1613         }
1614
1615         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
1616                 let mut channel_state = self.channel_state.lock().unwrap();
1617                 match channel_state.by_id.get_mut(&msg.channel_id) {
1618                         Some(chan) => {
1619                                 if chan.get_their_node_id() != *their_node_id {
1620                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1621                                 }
1622                                 chan.update_fee(&*self.fee_estimator, &msg)
1623                         },
1624                         None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1625                 }
1626         }
1627
1628         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
1629                 let (chan_announcement, chan_update) = {
1630                         let mut channel_state = self.channel_state.lock().unwrap();
1631                         match channel_state.by_id.get_mut(&msg.channel_id) {
1632                                 Some(chan) => {
1633                                         if chan.get_their_node_id() != *their_node_id {
1634                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1635                                         }
1636                                         if !chan.is_usable() {
1637                                                 return Err(HandleError{err: "Got an announcement_signatures before we were ready for it", msg: None });
1638                                         }
1639
1640                                         let our_node_id = self.get_our_node_id();
1641                                         let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())?;
1642
1643                                         let were_node_one = announcement.node_id_1 == our_node_id;
1644                                         let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1645                                         secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }));
1646                                         secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }));
1647
1648                                         let our_node_sig = secp_call!(self.secp_ctx.sign(&msghash, &self.our_network_key));
1649
1650                                         (msgs::ChannelAnnouncement {
1651                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
1652                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
1653                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
1654                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
1655                                                 contents: announcement,
1656                                         }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state
1657                                 },
1658                                 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1659                         }
1660                 };
1661                 let mut pending_events = self.pending_events.lock().unwrap();
1662                 pending_events.push(events::Event::BroadcastChannelAnnouncement { msg: chan_announcement, update_msg: chan_update });
1663                 Ok(())
1664         }
1665
1666         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
1667                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1668                 let channel_state = channel_state_lock.borrow_parts();
1669                 let short_to_id = channel_state.short_to_id;
1670                 if no_connection_possible {
1671                         channel_state.by_id.retain(move |_, chan| {
1672                                 if chan.get_their_node_id() == *their_node_id {
1673                                         if let Some(short_id) = chan.get_short_channel_id() {
1674                                                 short_to_id.remove(&short_id);
1675                                         }
1676                                         //TODO: get the latest commitment tx, any HTLC txn built on top of it, etc out
1677                                         //of the channel and throw those into the announcement blackhole.
1678                                         false
1679                                 } else {
1680                                         true
1681                                 }
1682                         });
1683                 } else {
1684                         for chan in channel_state.by_id {
1685                                 if chan.1.get_their_node_id() == *their_node_id {
1686                                         //TODO: mark channel disabled (and maybe announce such after a timeout). Also
1687                                         //fail and wipe any uncommitted outbound HTLCs as those are considered after
1688                                         //reconnect.
1689                                 }
1690                         }
1691                 }
1692         }
1693 }
1694
1695 #[cfg(test)]
1696 mod tests {
1697         use chain::chaininterface;
1698         use ln::channelmanager::{ChannelManager,OnionKeys};
1699         use ln::router::{Route, RouteHop, Router};
1700         use ln::msgs;
1701         use ln::msgs::{MsgEncodable,ChannelMessageHandler,RoutingMessageHandler};
1702         use util::test_utils;
1703         use util::events::{Event, EventsProvider};
1704
1705         use bitcoin::util::misc::hex_bytes;
1706         use bitcoin::util::hash::Sha256dHash;
1707         use bitcoin::util::uint::Uint256;
1708         use bitcoin::blockdata::block::BlockHeader;
1709         use bitcoin::blockdata::transaction::{Transaction, TxOut};
1710         use bitcoin::network::constants::Network;
1711         use bitcoin::network::serialize::serialize;
1712         use bitcoin::network::serialize::BitcoinHash;
1713
1714         use secp256k1::Secp256k1;
1715         use secp256k1::key::{PublicKey,SecretKey};
1716
1717         use crypto::sha2::Sha256;
1718         use crypto::digest::Digest;
1719
1720         use rand::{thread_rng,Rng};
1721
1722         use std::collections::HashMap;
1723         use std::default::Default;
1724         use std::sync::{Arc, Mutex};
1725         use std::time::Instant;
1726
1727         fn build_test_onion_keys() -> Vec<OnionKeys> {
1728                 // Keys from BOLT 4, used in both test vector tests
1729                 let secp_ctx = Secp256k1::new();
1730
1731                 let route = Route {
1732                         hops: vec!(
1733                                         RouteHop {
1734                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
1735                                                 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
1736                                         },
1737                                         RouteHop {
1738                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
1739                                                 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
1740                                         },
1741                                         RouteHop {
1742                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
1743                                                 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
1744                                         },
1745                                         RouteHop {
1746                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
1747                                                 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
1748                                         },
1749                                         RouteHop {
1750                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
1751                                                 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
1752                                         },
1753                         ),
1754                 };
1755
1756                 let session_priv = SecretKey::from_slice(&secp_ctx, &hex_bytes("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
1757
1758                 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1759                 assert_eq!(onion_keys.len(), route.hops.len());
1760                 onion_keys
1761         }
1762
1763         #[test]
1764         fn onion_vectors() {
1765                 // Packet creation test vectors from BOLT 4
1766                 let onion_keys = build_test_onion_keys();
1767
1768                 assert_eq!(onion_keys[0].shared_secret[..], hex_bytes("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
1769                 assert_eq!(onion_keys[0].blinding_factor[..], hex_bytes("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
1770                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex_bytes("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
1771                 assert_eq!(onion_keys[0].rho, hex_bytes("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
1772                 assert_eq!(onion_keys[0].mu, hex_bytes("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
1773
1774                 assert_eq!(onion_keys[1].shared_secret[..], hex_bytes("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
1775                 assert_eq!(onion_keys[1].blinding_factor[..], hex_bytes("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
1776                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex_bytes("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
1777                 assert_eq!(onion_keys[1].rho, hex_bytes("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
1778                 assert_eq!(onion_keys[1].mu, hex_bytes("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
1779
1780                 assert_eq!(onion_keys[2].shared_secret[..], hex_bytes("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
1781                 assert_eq!(onion_keys[2].blinding_factor[..], hex_bytes("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
1782                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex_bytes("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
1783                 assert_eq!(onion_keys[2].rho, hex_bytes("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
1784                 assert_eq!(onion_keys[2].mu, hex_bytes("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
1785
1786                 assert_eq!(onion_keys[3].shared_secret[..], hex_bytes("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
1787                 assert_eq!(onion_keys[3].blinding_factor[..], hex_bytes("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
1788                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex_bytes("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
1789                 assert_eq!(onion_keys[3].rho, hex_bytes("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
1790                 assert_eq!(onion_keys[3].mu, hex_bytes("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
1791
1792                 assert_eq!(onion_keys[4].shared_secret[..], hex_bytes("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
1793                 assert_eq!(onion_keys[4].blinding_factor[..], hex_bytes("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
1794                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex_bytes("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
1795                 assert_eq!(onion_keys[4].rho, hex_bytes("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
1796                 assert_eq!(onion_keys[4].mu, hex_bytes("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
1797
1798                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
1799                 let payloads = vec!(
1800                         msgs::OnionHopData {
1801                                 realm: 0,
1802                                 data: msgs::OnionRealm0HopData {
1803                                         short_channel_id: 0,
1804                                         amt_to_forward: 0,
1805                                         outgoing_cltv_value: 0,
1806                                 },
1807                                 hmac: [0; 32],
1808                         },
1809                         msgs::OnionHopData {
1810                                 realm: 0,
1811                                 data: msgs::OnionRealm0HopData {
1812                                         short_channel_id: 0x0101010101010101,
1813                                         amt_to_forward: 0x0100000001,
1814                                         outgoing_cltv_value: 0,
1815                                 },
1816                                 hmac: [0; 32],
1817                         },
1818                         msgs::OnionHopData {
1819                                 realm: 0,
1820                                 data: msgs::OnionRealm0HopData {
1821                                         short_channel_id: 0x0202020202020202,
1822                                         amt_to_forward: 0x0200000002,
1823                                         outgoing_cltv_value: 0,
1824                                 },
1825                                 hmac: [0; 32],
1826                         },
1827                         msgs::OnionHopData {
1828                                 realm: 0,
1829                                 data: msgs::OnionRealm0HopData {
1830                                         short_channel_id: 0x0303030303030303,
1831                                         amt_to_forward: 0x0300000003,
1832                                         outgoing_cltv_value: 0,
1833                                 },
1834                                 hmac: [0; 32],
1835                         },
1836                         msgs::OnionHopData {
1837                                 realm: 0,
1838                                 data: msgs::OnionRealm0HopData {
1839                                         short_channel_id: 0x0404040404040404,
1840                                         amt_to_forward: 0x0400000004,
1841                                         outgoing_cltv_value: 0,
1842                                 },
1843                                 hmac: [0; 32],
1844                         },
1845                 );
1846
1847                 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, hex_bytes("4242424242424242424242424242424242424242424242424242424242424242").unwrap()).unwrap();
1848                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
1849                 // anyway...
1850                 assert_eq!(packet.encode(), hex_bytes("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
1851         }
1852
1853         #[test]
1854         fn test_failure_packet_onion() {
1855                 // Returning Errors test vectors from BOLT 4
1856
1857                 let onion_keys = build_test_onion_keys();
1858                 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
1859                 assert_eq!(onion_error.encode(), hex_bytes("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
1860
1861                 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
1862                 assert_eq!(onion_packet_1.data, hex_bytes("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
1863
1864                 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
1865                 assert_eq!(onion_packet_2.data, hex_bytes("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
1866
1867                 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
1868                 assert_eq!(onion_packet_3.data, hex_bytes("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
1869
1870                 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
1871                 assert_eq!(onion_packet_4.data, hex_bytes("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
1872
1873                 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
1874                 assert_eq!(onion_packet_5.data, hex_bytes("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
1875         }
1876
1877         fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
1878                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1879                 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
1880                 for i in 2..100 {
1881                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1882                         chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
1883                 }
1884         }
1885
1886         struct Node {
1887                 feeest: Arc<test_utils::TestFeeEstimator>,
1888                 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
1889                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
1890                 chan_monitor: Arc<test_utils::TestChannelMonitor>,
1891                 node_id: SecretKey,
1892                 node: Arc<ChannelManager>,
1893                 router: Router,
1894         }
1895
1896         static mut CHAN_COUNT: u32 = 0;
1897         fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, Uint256, Transaction) {
1898                 let open_chan = node_a.node.create_channel(node_b.node.get_our_node_id(), 100000, 42).unwrap();
1899                 let accept_chan = node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_chan).unwrap();
1900                 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap();
1901
1902                 let chan_id = unsafe { CHAN_COUNT };
1903                 let tx;
1904                 let funding_output;
1905
1906                 let events_1 = node_a.node.get_and_clear_pending_events();
1907                 assert_eq!(events_1.len(), 1);
1908                 match events_1[0] {
1909                         Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1910                                 assert_eq!(*channel_value_satoshis, 100000);
1911                                 assert_eq!(user_channel_id, 42);
1912
1913                                 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
1914                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1915                                 }]};
1916                                 funding_output = (Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
1917
1918                                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output.clone());
1919                                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
1920                                 assert_eq!(added_monitors.len(), 1);
1921                                 assert_eq!(added_monitors[0].0, funding_output);
1922                                 added_monitors.clear();
1923                         },
1924                         _ => panic!("Unexpected event"),
1925                 }
1926
1927                 let events_2 = node_a.node.get_and_clear_pending_events();
1928                 assert_eq!(events_2.len(), 1);
1929                 let funding_signed = match events_2[0] {
1930                         Event::SendFundingCreated { ref node_id, ref msg } => {
1931                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
1932                                 let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap();
1933                                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
1934                                 assert_eq!(added_monitors.len(), 1);
1935                                 assert_eq!(added_monitors[0].0, funding_output);
1936                                 added_monitors.clear();
1937                                 res
1938                         },
1939                         _ => panic!("Unexpected event"),
1940                 };
1941
1942                 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &funding_signed).unwrap();
1943
1944                 let events_3 = node_a.node.get_and_clear_pending_events();
1945                 assert_eq!(events_3.len(), 1);
1946                 match events_3[0] {
1947                         Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
1948                                 assert_eq!(user_channel_id, 42);
1949                                 assert_eq!(*funding_txo, funding_output);
1950                         },
1951                         _ => panic!("Unexpected event"),
1952                 };
1953
1954                 confirm_transaction(&node_a.chain_monitor, &tx, chan_id);
1955                 let events_4 = node_a.node.get_and_clear_pending_events();
1956                 assert_eq!(events_4.len(), 1);
1957                 match events_4[0] {
1958                         Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
1959                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
1960                                 assert!(announcement_sigs.is_none());
1961                                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), msg).unwrap()
1962                         },
1963                         _ => panic!("Unexpected event"),
1964                 };
1965
1966                 let channel_id;
1967
1968                 confirm_transaction(&node_b.chain_monitor, &tx, chan_id);
1969                 let events_5 = node_b.node.get_and_clear_pending_events();
1970                 assert_eq!(events_5.len(), 1);
1971                 let as_announcement_sigs = match events_5[0] {
1972                         Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
1973                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
1974                                 channel_id = msg.channel_id.clone();
1975                                 let as_announcement_sigs = node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), msg).unwrap().unwrap();
1976                                 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &(*announcement_sigs).clone().unwrap()).unwrap();
1977                                 as_announcement_sigs
1978                         },
1979                         _ => panic!("Unexpected event"),
1980                 };
1981
1982                 let events_6 = node_a.node.get_and_clear_pending_events();
1983                 assert_eq!(events_6.len(), 1);
1984                 let (announcement, as_update) = match events_6[0] {
1985                         Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1986                                 (msg, update_msg)
1987                         },
1988                         _ => panic!("Unexpected event"),
1989                 };
1990
1991                 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_announcement_sigs).unwrap();
1992                 let events_7 = node_b.node.get_and_clear_pending_events();
1993                 assert_eq!(events_7.len(), 1);
1994                 let bs_update = match events_7[0] {
1995                         Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1996                                 assert!(*announcement == *msg);
1997                                 update_msg
1998                         },
1999                         _ => panic!("Unexpected event"),
2000                 };
2001
2002                 unsafe {
2003                         CHAN_COUNT += 1;
2004                 }
2005
2006                 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone(), channel_id, tx)
2007         }
2008
2009         fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Uint256, Transaction) {
2010                 let chan_announcement = create_chan_between_nodes(&nodes[a], &nodes[b]);
2011                 for node in nodes {
2012                         assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
2013                         node.router.handle_channel_update(&chan_announcement.1).unwrap();
2014                         node.router.handle_channel_update(&chan_announcement.2).unwrap();
2015                 }
2016                 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
2017         }
2018
2019         fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &Uint256, funding_tx: Transaction, close_inbound_first: bool) {
2020                 let (node_a, broadcaster_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster) } else { (&outbound_node.node, &outbound_node.tx_broadcaster) };
2021                 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
2022                 let (tx_a, tx_b);
2023
2024                 let shutdown_a = node_a.close_channel(channel_id).unwrap();
2025                 let (shutdown_b, mut closing_signed_b) = node_b.handle_shutdown(&node_a.get_our_node_id(), &shutdown_a).unwrap();
2026                 if !close_inbound_first {
2027                         assert!(closing_signed_b.is_none());
2028                 }
2029                 let (empty_a, mut closing_signed_a) = node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b.unwrap()).unwrap();
2030                 assert!(empty_a.is_none());
2031                 if close_inbound_first {
2032                         assert!(closing_signed_a.is_none());
2033                         closing_signed_a = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2034                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2035                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2036
2037                         let empty_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2038                         assert!(empty_b.is_none());
2039                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2040                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2041                 } else {
2042                         closing_signed_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2043                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2044                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2045
2046                         let empty_a2 = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2047                         assert!(empty_a2.is_none());
2048                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2049                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2050                 }
2051                 assert_eq!(tx_a, tx_b);
2052                 let mut funding_tx_map = HashMap::new();
2053                 funding_tx_map.insert(funding_tx.txid(), funding_tx);
2054                 tx_a.verify(&funding_tx_map).unwrap();
2055         }
2056
2057         struct SendEvent {
2058                 node_id: PublicKey,
2059                 msgs: Vec<msgs::UpdateAddHTLC>,
2060                 commitment_msg: msgs::CommitmentSigned,
2061         }
2062         impl SendEvent {
2063                 fn from_event(event: Event) -> SendEvent {
2064                         match event {
2065                                 Event::SendHTLCs { node_id, msgs, commitment_msg } => {
2066                                         SendEvent { node_id: node_id, msgs: msgs, commitment_msg: commitment_msg }
2067                                 },
2068                                 _ => panic!("Unexpected event type!"),
2069                         }
2070                 }
2071         }
2072
2073         static mut PAYMENT_COUNT: u8 = 0;
2074         fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2075                 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2076                 unsafe { PAYMENT_COUNT += 1 };
2077                 let our_payment_hash = {
2078                         let mut sha = Sha256::new();
2079                         sha.input(&our_payment_preimage[..]);
2080                         let mut ret = [0; 32];
2081                         sha.result(&mut ret);
2082                         ret
2083                 };
2084
2085                 let mut payment_event = {
2086                         let msgs = origin_node.node.send_payment(route, our_payment_hash).unwrap().unwrap();
2087                         SendEvent {
2088                                 node_id: expected_route[0].node.get_our_node_id(),
2089                                 msgs: vec!(msgs.0),
2090                                 commitment_msg: msgs.1,
2091                         }
2092                 };
2093                 let mut prev_node = origin_node;
2094
2095                 for (idx, &node) in expected_route.iter().enumerate() {
2096                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2097
2098                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2099                         {
2100                                 let added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2101                                 assert_eq!(added_monitors.len(), 0);
2102                         }
2103
2104                         let revoke_and_ack = node.node.handle_commitment_signed(&prev_node.node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2105                         {
2106                                 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2107                                 assert_eq!(added_monitors.len(), 1);
2108                                 added_monitors.clear();
2109                         }
2110                         assert!(prev_node.node.handle_revoke_and_ack(&node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2111                         let prev_revoke_and_ack = prev_node.node.handle_commitment_signed(&node.node.get_our_node_id(), &revoke_and_ack.1.unwrap()).unwrap();
2112                         {
2113                                 let mut added_monitors = prev_node.chan_monitor.added_monitors.lock().unwrap();
2114                                 assert_eq!(added_monitors.len(), 2);
2115                                 added_monitors.clear();
2116                         }
2117                         assert!(node.node.handle_revoke_and_ack(&prev_node.node.get_our_node_id(), &prev_revoke_and_ack.0).unwrap().is_none());
2118                         assert!(prev_revoke_and_ack.1.is_none());
2119                         {
2120                                 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2121                                 assert_eq!(added_monitors.len(), 1);
2122                                 added_monitors.clear();
2123                         }
2124
2125                         let events_1 = node.node.get_and_clear_pending_events();
2126                         assert_eq!(events_1.len(), 1);
2127                         match events_1[0] {
2128                                 Event::PendingHTLCsForwardable { .. } => { },
2129                                 _ => panic!("Unexpected event"),
2130                         };
2131
2132                         node.node.channel_state.lock().unwrap().next_forward = Instant::now();
2133                         node.node.process_pending_htlc_forward();
2134
2135                         let mut events_2 = node.node.get_and_clear_pending_events();
2136                         assert_eq!(events_2.len(), 1);
2137                         if idx == expected_route.len() - 1 {
2138                                 match events_2[0] {
2139                                         Event::PaymentReceived { ref payment_hash, amt } => {
2140                                                 assert_eq!(our_payment_hash, *payment_hash);
2141                                                 assert_eq!(amt, recv_value);
2142                                         },
2143                                         _ => panic!("Unexpected event"),
2144                                 }
2145                         } else {
2146                                 for event in events_2.drain(..) {
2147                                         payment_event = SendEvent::from_event(event);
2148                                 }
2149                                 assert_eq!(payment_event.msgs.len(), 1);
2150                         }
2151
2152                         prev_node = node;
2153                 }
2154
2155                 (our_payment_preimage, our_payment_hash)
2156         }
2157
2158         fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
2159                 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
2160                 {
2161                         let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2162                         assert_eq!(added_monitors.len(), 1);
2163                         added_monitors.clear();
2164                 }
2165
2166                 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
2167                 macro_rules! update_fulfill_dance {
2168                         ($node: expr, $prev_node: expr) => {
2169                                 {
2170                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2171                                         let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2172                                         {
2173                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2174                                                 assert_eq!(added_monitors.len(), 2);
2175                                                 added_monitors.clear();
2176                                         }
2177                                         assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2178                                         let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2179                                         assert!(revoke_and_ack.1.is_none());
2180                                         {
2181                                                 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2182                                                 assert_eq!(added_monitors.len(), 2);
2183                                                 added_monitors.clear();
2184                                         }
2185                                         assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2186                                         {
2187                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2188                                                 assert_eq!(added_monitors.len(), 1);
2189                                                 added_monitors.clear();
2190                                         }
2191                                 }
2192                         }
2193                 }
2194
2195                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2196                 let mut prev_node = expected_route.last().unwrap();
2197                 for node in expected_route.iter().rev() {
2198                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2199                         if next_msgs.is_some() {
2200                                 update_fulfill_dance!(node, prev_node);
2201                         }
2202
2203                         let events = node.node.get_and_clear_pending_events();
2204                         assert_eq!(events.len(), 1);
2205                         match events[0] {
2206                                 Event::SendFulfillHTLC { ref node_id, ref msg, ref commitment_msg } => {
2207                                         expected_next_node = node_id.clone();
2208                                         next_msgs = Some((msg.clone(), commitment_msg.clone()));
2209                                 },
2210                                 _ => panic!("Unexpected event"),
2211                         };
2212
2213                         prev_node = node;
2214                 }
2215
2216                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2217                 update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2218
2219                 let events = origin_node.node.get_and_clear_pending_events();
2220                 assert_eq!(events.len(), 1);
2221                 match events[0] {
2222                         Event::PaymentSent { payment_preimage } => {
2223                                 assert_eq!(payment_preimage, our_payment_preimage);
2224                         },
2225                         _ => panic!("Unexpected event"),
2226                 }
2227         }
2228
2229         fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2230                 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), &Vec::new(), recv_value, 142).unwrap();
2231                 assert_eq!(route.hops.len(), expected_route.len());
2232                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2233                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
2234                 }
2235
2236                 send_along_route(origin_node, route, expected_route, recv_value)
2237         }
2238
2239         fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
2240                 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), &Vec::new(), recv_value, 142).unwrap();
2241                 assert_eq!(route.hops.len(), expected_route.len());
2242                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2243                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
2244                 }
2245
2246                 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2247                 unsafe { PAYMENT_COUNT += 1 };
2248                 let our_payment_hash = {
2249                         let mut sha = Sha256::new();
2250                         sha.input(&our_payment_preimage[..]);
2251                         let mut ret = [0; 32];
2252                         sha.result(&mut ret);
2253                         ret
2254                 };
2255
2256                 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
2257                 assert_eq!(err.err, "Cannot send value that would put us over our max HTLC value in flight");
2258         }
2259
2260         fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
2261                 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2262                 claim_payment(&origin, expected_route, our_payment_preimage);
2263         }
2264
2265         fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
2266                 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
2267
2268                 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
2269                 macro_rules! update_fail_dance {
2270                         ($node: expr, $prev_node: expr) => {
2271                                 {
2272                                         $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2273                                         let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2274                                         {
2275                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2276                                                 assert_eq!(added_monitors.len(), 1);
2277                                                 added_monitors.clear();
2278                                         }
2279                                         assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2280                                         let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2281                                         assert!(revoke_and_ack.1.is_none());
2282                                         {
2283                                                 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2284                                                 assert_eq!(added_monitors.len(), 2);
2285                                                 added_monitors.clear();
2286                                         }
2287                                         assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2288                                         {
2289                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2290                                                 assert_eq!(added_monitors.len(), 1);
2291                                                 added_monitors.clear();
2292                                         }
2293                                 }
2294                         }
2295                 }
2296
2297                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2298                 let mut prev_node = expected_route.last().unwrap();
2299                 for node in expected_route.iter().rev() {
2300                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2301                         if next_msgs.is_some() {
2302                                 update_fail_dance!(node, prev_node);
2303                         }
2304
2305                         let events = node.node.get_and_clear_pending_events();
2306                         assert_eq!(events.len(), 1);
2307                         match events[0] {
2308                                 Event::SendFailHTLC { ref node_id, ref msg, ref commitment_msg } => {
2309                                         expected_next_node = node_id.clone();
2310                                         next_msgs = Some((msg.clone(), commitment_msg.clone()));
2311                                 },
2312                                 _ => panic!("Unexpected event"),
2313                         };
2314
2315                         prev_node = node;
2316                 }
2317
2318                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2319                 update_fail_dance!(origin_node, expected_route.first().unwrap());
2320
2321                 let events = origin_node.node.get_and_clear_pending_events();
2322                 assert_eq!(events.len(), 1);
2323                 match events[0] {
2324                         Event::PaymentFailed { payment_hash } => {
2325                                 assert_eq!(payment_hash, our_payment_hash);
2326                         },
2327                         _ => panic!("Unexpected event"),
2328                 }
2329         }
2330
2331         fn create_network(node_count: usize) -> Vec<Node> {
2332                 let mut nodes = Vec::new();
2333                 let mut rng = thread_rng();
2334                 let secp_ctx = Secp256k1::new();
2335
2336                 for _ in 0..node_count {
2337                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_vbyte: 1 });
2338                         let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new());
2339                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
2340                         let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
2341                         let node_id = {
2342                                 let mut key_slice = [0; 32];
2343                                 rng.fill_bytes(&mut key_slice);
2344                                 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
2345                         };
2346                         let node = ChannelManager::new(node_id.clone(), 0, true, Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone()).unwrap();
2347                         let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &node_id).unwrap());
2348                         nodes.push(Node { feeest, chain_monitor, tx_broadcaster, chan_monitor, node_id, node, router });
2349                 }
2350
2351                 nodes
2352         }
2353
2354         #[test]
2355         fn fake_network_test() {
2356                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2357                 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
2358                 let nodes = create_network(4);
2359
2360                 // Create some initial channels
2361                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2362                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2363                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2364
2365                 // Rebalance the network a bit by relaying one payment through all the channels...
2366                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2367                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2368                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2369                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2370
2371                 // Send some more payments
2372                 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
2373                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
2374                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
2375
2376                 // Test failure packets
2377                 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
2378                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
2379
2380                 // Add a new channel that skips 3
2381                 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
2382
2383                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
2384                 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
2385                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2386                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2387                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2388                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2389                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2390
2391                 // Do some rebalance loop payments, simultaneously
2392                 let mut hops = Vec::with_capacity(3);
2393                 hops.push(RouteHop {
2394                         pubkey: nodes[2].node.get_our_node_id(),
2395                         short_channel_id: chan_2.0.contents.short_channel_id,
2396                         fee_msat: 0,
2397                         cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
2398                 });
2399                 hops.push(RouteHop {
2400                         pubkey: nodes[3].node.get_our_node_id(),
2401                         short_channel_id: chan_3.0.contents.short_channel_id,
2402                         fee_msat: 0,
2403                         cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
2404                 });
2405                 hops.push(RouteHop {
2406                         pubkey: nodes[1].node.get_our_node_id(),
2407                         short_channel_id: chan_4.0.contents.short_channel_id,
2408                         fee_msat: 1000000,
2409                         cltv_expiry_delta: 142,
2410                 });
2411                 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;
2412                 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;
2413                 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
2414
2415                 let mut hops = Vec::with_capacity(3);
2416                 hops.push(RouteHop {
2417                         pubkey: nodes[3].node.get_our_node_id(),
2418                         short_channel_id: chan_4.0.contents.short_channel_id,
2419                         fee_msat: 0,
2420                         cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
2421                 });
2422                 hops.push(RouteHop {
2423                         pubkey: nodes[2].node.get_our_node_id(),
2424                         short_channel_id: chan_3.0.contents.short_channel_id,
2425                         fee_msat: 0,
2426                         cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
2427                 });
2428                 hops.push(RouteHop {
2429                         pubkey: nodes[1].node.get_our_node_id(),
2430                         short_channel_id: chan_2.0.contents.short_channel_id,
2431                         fee_msat: 1000000,
2432                         cltv_expiry_delta: 142,
2433                 });
2434                 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;
2435                 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;
2436                 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
2437
2438                 // Claim the rebalances...
2439                 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
2440                 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
2441
2442                 // Add a duplicate new channel from 2 to 4
2443                 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
2444
2445                 // Send some payments across both channels
2446                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2447                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2448                 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2449
2450                 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
2451
2452                 //TODO: Test that routes work again here as we've been notified that the channel is full
2453
2454                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
2455                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
2456                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
2457
2458                 // Close down the channels...
2459                 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
2460                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
2461                 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
2462                 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
2463                 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
2464
2465                 // Check that we processed all pending events
2466                 for node in nodes {
2467                         assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
2468                         assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
2469                 }
2470         }
2471 }