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