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