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