20a3779899a620b185723bdf78d7513017321ee4
[rust-lightning] / src / ln / channelmanager.rs
1 //! The top-level channel management and payment tracking stuff lives here.
2 //!
3 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
4 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
5 //! upon reconnect to the relevant peer(s).
6 //!
7 //! It does not manage routing logic (see ln::router for that) nor does it manage constructing
8 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
9 //! imply it needs to fail HTLCs/payments/channels it manages).
10
11 use bitcoin::blockdata::block::BlockHeader;
12 use bitcoin::blockdata::transaction::Transaction;
13 use bitcoin::blockdata::constants::genesis_block;
14 use bitcoin::network::constants::Network;
15 use bitcoin::util::hash::{BitcoinHash, Sha256dHash};
16
17 use secp256k1::key::{SecretKey,PublicKey};
18 use secp256k1::{Secp256k1,Message};
19 use secp256k1::ecdh::SharedSecret;
20 use secp256k1;
21
22 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
23 use chain::transaction::OutPoint;
24 use ln::channel::{Channel, ChannelError};
25 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS};
26 use ln::router::{Route,RouteHop};
27 use ln::msgs;
28 use ln::msgs::{ChannelMessageHandler, DecodeError, HandleError};
29 use chain::keysinterface::KeysInterface;
30 use util::config::UserConfig;
31 use util::{byte_utils, events, internal_traits, rng};
32 use util::sha2::Sha256;
33 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
34 use util::chacha20poly1305rfc::ChaCha20;
35 use util::logger::Logger;
36 use util::errors::APIError;
37
38 use crypto;
39 use crypto::mac::{Mac,MacResult};
40 use crypto::hmac::Hmac;
41 use crypto::digest::Digest;
42 use crypto::symmetriccipher::SynchronousStreamCipher;
43
44 use std::{cmp, ptr, mem};
45 use std::collections::{HashMap, hash_map, HashSet};
46 use std::io::Cursor;
47 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
48 use std::sync::atomic::{AtomicUsize, Ordering};
49 use std::time::{Instant,Duration};
50
51 /// We hold various information about HTLC relay in the HTLC objects in Channel itself:
52 ///
53 /// Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
54 /// forward the HTLC with information it will give back to us when it does so, or if it should Fail
55 /// the HTLC with the relevant message for the Channel to handle giving to the remote peer.
56 ///
57 /// When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo
58 /// which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData
59 /// filled in to indicate where it came from (which we can use to either fail-backwards or fulfill
60 /// the HTLC backwards along the relevant path).
61 /// Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
62 /// our payment, which we can use to decode errors or inform the user that the payment was sent.
63 mod channel_held_info {
64         use ln::msgs;
65         use ln::router::Route;
66         use secp256k1::key::SecretKey;
67
68         /// Stores the info we will need to send when we want to forward an HTLC onwards
69         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
70         pub struct PendingForwardHTLCInfo {
71                 pub(super) onion_packet: Option<msgs::OnionPacket>,
72                 pub(super) incoming_shared_secret: [u8; 32],
73                 pub(super) payment_hash: [u8; 32],
74                 pub(super) short_channel_id: u64,
75                 pub(super) amt_to_forward: u64,
76                 pub(super) outgoing_cltv_value: u32,
77         }
78
79         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
80         pub enum HTLCFailureMsg {
81                 Relay(msgs::UpdateFailHTLC),
82                 Malformed(msgs::UpdateFailMalformedHTLC),
83         }
84
85         /// Stores whether we can't forward an HTLC or relevant forwarding info
86         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
87         pub enum PendingHTLCStatus {
88                 Forward(PendingForwardHTLCInfo),
89                 Fail(HTLCFailureMsg),
90         }
91
92         /// Tracks the inbound corresponding to an outbound HTLC
93         #[derive(Clone)]
94         pub struct HTLCPreviousHopData {
95                 pub(super) short_channel_id: u64,
96                 pub(super) htlc_id: u64,
97                 pub(super) incoming_packet_shared_secret: [u8; 32],
98         }
99
100         /// Tracks the inbound corresponding to an outbound HTLC
101         #[derive(Clone)]
102         pub enum HTLCSource {
103                 PreviousHopData(HTLCPreviousHopData),
104                 OutboundRoute {
105                         route: Route,
106                         session_priv: SecretKey,
107                         /// Technically we can recalculate this from the route, but we cache it here to avoid
108                         /// doing a double-pass on route when we get a failure back
109                         first_hop_htlc_msat: u64,
110                 },
111         }
112         #[cfg(test)]
113         impl HTLCSource {
114                 pub fn dummy() -> Self {
115                         HTLCSource::OutboundRoute {
116                                 route: Route { hops: Vec::new() },
117                                 session_priv: SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[1; 32]).unwrap(),
118                                 first_hop_htlc_msat: 0,
119                         }
120                 }
121         }
122
123         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
124         pub(crate) enum HTLCFailReason {
125                 ErrorPacket {
126                         err: msgs::OnionErrorPacket,
127                 },
128                 Reason {
129                         failure_code: u16,
130                         data: Vec<u8>,
131                 }
132         }
133 }
134 pub(super) use self::channel_held_info::*;
135
136 struct MsgHandleErrInternal {
137         err: msgs::HandleError,
138         needs_channel_force_close: bool,
139 }
140 impl MsgHandleErrInternal {
141         #[inline]
142         fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
143                 Self {
144                         err: HandleError {
145                                 err,
146                                 action: Some(msgs::ErrorAction::SendErrorMessage {
147                                         msg: msgs::ErrorMessage {
148                                                 channel_id,
149                                                 data: err.to_string()
150                                         },
151                                 }),
152                         },
153                         needs_channel_force_close: false,
154                 }
155         }
156         #[inline]
157         fn send_err_msg_close_chan(err: &'static str, channel_id: [u8; 32]) -> Self {
158                 Self {
159                         err: HandleError {
160                                 err,
161                                 action: Some(msgs::ErrorAction::SendErrorMessage {
162                                         msg: msgs::ErrorMessage {
163                                                 channel_id,
164                                                 data: err.to_string()
165                                         },
166                                 }),
167                         },
168                         needs_channel_force_close: true,
169                 }
170         }
171         #[inline]
172         fn from_maybe_close(err: msgs::HandleError) -> Self {
173                 Self { err, needs_channel_force_close: true }
174         }
175         #[inline]
176         fn from_no_close(err: msgs::HandleError) -> Self {
177                 Self { err, needs_channel_force_close: false }
178         }
179         #[inline]
180         fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
181                 Self {
182                         err: match err {
183                                 ChannelError::Ignore(msg) => HandleError {
184                                         err: msg,
185                                         action: Some(msgs::ErrorAction::IgnoreError),
186                                 },
187                                 ChannelError::Close(msg) => HandleError {
188                                         err: msg,
189                                         action: Some(msgs::ErrorAction::SendErrorMessage {
190                                                 msg: msgs::ErrorMessage {
191                                                         channel_id,
192                                                         data: msg.to_string()
193                                                 },
194                                         }),
195                                 },
196                         },
197                         needs_channel_force_close: false,
198                 }
199         }
200         #[inline]
201         fn from_chan_maybe_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
202                 Self {
203                         err: match err {
204                                 ChannelError::Ignore(msg) => HandleError {
205                                         err: msg,
206                                         action: Some(msgs::ErrorAction::IgnoreError),
207                                 },
208                                 ChannelError::Close(msg) => HandleError {
209                                         err: msg,
210                                         action: Some(msgs::ErrorAction::SendErrorMessage {
211                                                 msg: msgs::ErrorMessage {
212                                                         channel_id,
213                                                         data: msg.to_string()
214                                                 },
215                                         }),
216                                 },
217                         },
218                         needs_channel_force_close: true,
219                 }
220         }
221 }
222
223 /// Pass to fail_htlc_backwwards to indicate the reason to fail the payment
224 /// after a PaymentReceived event.
225 #[derive(PartialEq)]
226 pub enum PaymentFailReason {
227         /// Indicate the preimage for payment_hash is not known after a PaymentReceived event
228         PreimageUnknown,
229         /// Indicate the payment amount is incorrect ( received is < expected or > 2*expected ) after a PaymentReceived event
230         AmountMismatch,
231 }
232
233 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
234 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
235 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
236 /// probably increase this significantly.
237 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
238
239 struct HTLCForwardInfo {
240         prev_short_channel_id: u64,
241         prev_htlc_id: u64,
242         forward_info: PendingForwardHTLCInfo,
243 }
244
245 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
246 /// be sent in the order they appear in the return value, however sometimes the order needs to be
247 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
248 /// they were originally sent). In those cases, this enum is also returned.
249 #[derive(Clone, PartialEq)]
250 pub(super) enum RAACommitmentOrder {
251         /// Send the CommitmentUpdate messages first
252         CommitmentFirst,
253         /// Send the RevokeAndACK message first
254         RevokeAndACKFirst,
255 }
256
257 struct ChannelHolder {
258         by_id: HashMap<[u8; 32], Channel>,
259         short_to_id: HashMap<u64, [u8; 32]>,
260         next_forward: Instant,
261         /// short channel id -> forward infos. Key of 0 means payments received
262         /// Note that while this is held in the same mutex as the channels themselves, no consistency
263         /// guarantees are made about there existing a channel with the short id here, nor the short
264         /// ids in the PendingForwardHTLCInfo!
265         forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
266         /// Note that while this is held in the same mutex as the channels themselves, no consistency
267         /// guarantees are made about the channels given here actually existing anymore by the time you
268         /// go to read them!
269         claimable_htlcs: HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
270         /// Messages to send to peers - pushed to in the same lock that they are generated in (except
271         /// for broadcast messages, where ordering isn't as strict).
272         pending_msg_events: Vec<events::MessageSendEvent>,
273 }
274 struct MutChannelHolder<'a> {
275         by_id: &'a mut HashMap<[u8; 32], Channel>,
276         short_to_id: &'a mut HashMap<u64, [u8; 32]>,
277         next_forward: &'a mut Instant,
278         forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
279         claimable_htlcs: &'a mut HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
280         pending_msg_events: &'a mut Vec<events::MessageSendEvent>,
281 }
282 impl ChannelHolder {
283         fn borrow_parts(&mut self) -> MutChannelHolder {
284                 MutChannelHolder {
285                         by_id: &mut self.by_id,
286                         short_to_id: &mut self.short_to_id,
287                         next_forward: &mut self.next_forward,
288                         forward_htlcs: &mut self.forward_htlcs,
289                         claimable_htlcs: &mut self.claimable_htlcs,
290                         pending_msg_events: &mut self.pending_msg_events,
291                 }
292         }
293 }
294
295 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
296 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
297
298 /// Manager which keeps track of a number of channels and sends messages to the appropriate
299 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
300 ///
301 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
302 /// to individual Channels.
303 ///
304 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
305 /// all peers during write/read (though does not modify this instance, only the instance being
306 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
307 /// called funding_transaction_generated for outbound channels).
308 ///
309 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
310 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
311 /// returning from ManyChannelMonitor::add_update_monitor, with ChannelManagers, writing updates
312 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
313 /// the serialization process). If the deserialized version is out-of-date compared to the
314 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
315 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
316 ///
317 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
318 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
319 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
320 /// block_connected() to step towards your best block) upon deserialization before using the
321 /// object!
322 pub struct ChannelManager {
323         default_configuration: UserConfig,
324         genesis_hash: Sha256dHash,
325         fee_estimator: Arc<FeeEstimator>,
326         monitor: Arc<ManyChannelMonitor>,
327         chain_monitor: Arc<ChainWatchInterface>,
328         tx_broadcaster: Arc<BroadcasterInterface>,
329
330         latest_block_height: AtomicUsize,
331         last_block_hash: Mutex<Sha256dHash>,
332         secp_ctx: Secp256k1<secp256k1::All>,
333
334         channel_state: Mutex<ChannelHolder>,
335         our_network_key: SecretKey,
336
337         pending_events: Mutex<Vec<events::Event>>,
338         /// Used when we have to take a BIG lock to make sure everything is self-consistent.
339         /// Essentially just when we're serializing ourselves out.
340         /// Taken first everywhere where we are making changes before any other locks.
341         total_consistency_lock: RwLock<()>,
342
343         keys_manager: Arc<KeysInterface>,
344
345         logger: Arc<Logger>,
346 }
347
348 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
349 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
350 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
351 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
352 /// CLTV_CLAIM_BUFFER point (we static assert that its at least 3 blocks more).
353 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
354 const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
355
356 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + 2*HTLC_FAIL_TIMEOUT_BLOCKS, ie that
357 // if the next-hop peer fails the HTLC within HTLC_FAIL_TIMEOUT_BLOCKS then we'll still have
358 // HTLC_FAIL_TIMEOUT_BLOCKS left to fail it backwards ourselves before hitting the
359 // CLTV_CLAIM_BUFFER point and failing the channel on-chain to time out the HTLC.
360 #[deny(const_err)]
361 #[allow(dead_code)]
362 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - 2*HTLC_FAIL_TIMEOUT_BLOCKS - CLTV_CLAIM_BUFFER;
363
364 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
365 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
366 #[deny(const_err)]
367 #[allow(dead_code)]
368 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - HTLC_FAIL_TIMEOUT_BLOCKS - 2*CLTV_CLAIM_BUFFER;
369
370 macro_rules! secp_call {
371         ( $res: expr, $err: expr ) => {
372                 match $res {
373                         Ok(key) => key,
374                         Err(_) => return Err($err),
375                 }
376         };
377 }
378
379 struct OnionKeys {
380         #[cfg(test)]
381         shared_secret: SharedSecret,
382         #[cfg(test)]
383         blinding_factor: [u8; 32],
384         ephemeral_pubkey: PublicKey,
385         rho: [u8; 32],
386         mu: [u8; 32],
387 }
388
389 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
390 pub struct ChannelDetails {
391         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
392         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
393         /// Note that this means this value is *not* persistent - it can change once during the
394         /// lifetime of the channel.
395         pub channel_id: [u8; 32],
396         /// The position of the funding transaction in the chain. None if the funding transaction has
397         /// not yet been confirmed and the channel fully opened.
398         pub short_channel_id: Option<u64>,
399         /// The node_id of our counterparty
400         pub remote_network_id: PublicKey,
401         /// The value, in satoshis, of this channel as appears in the funding output
402         pub channel_value_satoshis: u64,
403         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
404         pub user_id: u64,
405 }
406
407 impl ChannelManager {
408         /// Constructs a new ChannelManager to hold several channels and route between them.
409         ///
410         /// This is the main "logic hub" for all channel-related actions, and implements
411         /// ChannelMessageHandler.
412         ///
413         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
414         ///
415         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
416         pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface>, config: UserConfig) -> Result<Arc<ChannelManager>, secp256k1::Error> {
417                 let secp_ctx = Secp256k1::new();
418
419                 let res = Arc::new(ChannelManager {
420                         default_configuration: config.clone(),
421                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
422                         fee_estimator: feeest.clone(),
423                         monitor: monitor.clone(),
424                         chain_monitor,
425                         tx_broadcaster,
426
427                         latest_block_height: AtomicUsize::new(0), //TODO: Get an init value
428                         last_block_hash: Mutex::new(Default::default()),
429                         secp_ctx,
430
431                         channel_state: Mutex::new(ChannelHolder{
432                                 by_id: HashMap::new(),
433                                 short_to_id: HashMap::new(),
434                                 next_forward: Instant::now(),
435                                 forward_htlcs: HashMap::new(),
436                                 claimable_htlcs: HashMap::new(),
437                                 pending_msg_events: Vec::new(),
438                         }),
439                         our_network_key: keys_manager.get_node_secret(),
440
441                         pending_events: Mutex::new(Vec::new()),
442                         total_consistency_lock: RwLock::new(()),
443
444                         keys_manager,
445
446                         logger,
447                 });
448                 let weak_res = Arc::downgrade(&res);
449                 res.chain_monitor.register_listener(weak_res);
450                 Ok(res)
451         }
452
453         /// Creates a new outbound channel to the given remote node and with the given value.
454         ///
455         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
456         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
457         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
458         /// may wish to avoid using 0 for user_id here.
459         ///
460         /// If successful, will generate a SendOpenChannel message event, so you should probably poll
461         /// PeerManager::process_events afterwards.
462         ///
463         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
464         /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
465         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
466                 if channel_value_satoshis < 1000 {
467                         return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
468                 }
469
470                 let channel = Channel::new_outbound(&*self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, Arc::clone(&self.logger), &self.default_configuration)?;
471                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
472
473                 let _ = self.total_consistency_lock.read().unwrap();
474                 let mut channel_state = self.channel_state.lock().unwrap();
475                 match channel_state.by_id.entry(channel.channel_id()) {
476                         hash_map::Entry::Occupied(_) => {
477                                 if cfg!(feature = "fuzztarget") {
478                                         return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
479                                 } else {
480                                         panic!("RNG is bad???");
481                                 }
482                         },
483                         hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
484                 }
485                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
486                         node_id: their_network_key,
487                         msg: res,
488                 });
489                 Ok(())
490         }
491
492         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
493         /// more information.
494         pub fn list_channels(&self) -> Vec<ChannelDetails> {
495                 let channel_state = self.channel_state.lock().unwrap();
496                 let mut res = Vec::with_capacity(channel_state.by_id.len());
497                 for (channel_id, channel) in channel_state.by_id.iter() {
498                         res.push(ChannelDetails {
499                                 channel_id: (*channel_id).clone(),
500                                 short_channel_id: channel.get_short_channel_id(),
501                                 remote_network_id: channel.get_their_node_id(),
502                                 channel_value_satoshis: channel.get_value_satoshis(),
503                                 user_id: channel.get_user_id(),
504                         });
505                 }
506                 res
507         }
508
509         /// Gets the list of usable channels, in random order. Useful as an argument to
510         /// Router::get_route to ensure non-announced channels are used.
511         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
512                 let channel_state = self.channel_state.lock().unwrap();
513                 let mut res = Vec::with_capacity(channel_state.by_id.len());
514                 for (channel_id, channel) in channel_state.by_id.iter() {
515                         // Note we use is_live here instead of usable which leads to somewhat confused
516                         // internal/external nomenclature, but that's ok cause that's probably what the user
517                         // really wanted anyway.
518                         if channel.is_live() {
519                                 res.push(ChannelDetails {
520                                         channel_id: (*channel_id).clone(),
521                                         short_channel_id: channel.get_short_channel_id(),
522                                         remote_network_id: channel.get_their_node_id(),
523                                         channel_value_satoshis: channel.get_value_satoshis(),
524                                         user_id: channel.get_user_id(),
525                                 });
526                         }
527                 }
528                 res
529         }
530
531         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
532         /// will be accepted on the given channel, and after additional timeout/the closing of all
533         /// pending HTLCs, the channel will be closed on chain.
534         ///
535         /// May generate a SendShutdown message event on success, which should be relayed.
536         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
537                 let _ = self.total_consistency_lock.read().unwrap();
538
539                 let (mut failed_htlcs, chan_option) = {
540                         let mut channel_state_lock = self.channel_state.lock().unwrap();
541                         let channel_state = channel_state_lock.borrow_parts();
542                         match channel_state.by_id.entry(channel_id.clone()) {
543                                 hash_map::Entry::Occupied(mut chan_entry) => {
544                                         let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
545                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
546                                                 node_id: chan_entry.get().get_their_node_id(),
547                                                 msg: shutdown_msg
548                                         });
549                                         if chan_entry.get().is_shutdown() {
550                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
551                                                         channel_state.short_to_id.remove(&short_id);
552                                                 }
553                                                 (failed_htlcs, Some(chan_entry.remove_entry().1))
554                                         } else { (failed_htlcs, None) }
555                                 },
556                                 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
557                         }
558                 };
559                 for htlc_source in failed_htlcs.drain(..) {
560                         // unknown_next_peer...I dunno who that is anymore....
561                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
562                 }
563                 let chan_update = if let Some(chan) = chan_option {
564                         if let Ok(update) = self.get_channel_update(&chan) {
565                                 Some(update)
566                         } else { None }
567                 } else { None };
568
569                 if let Some(update) = chan_update {
570                         let mut channel_state = self.channel_state.lock().unwrap();
571                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
572                                 msg: update
573                         });
574                 }
575
576                 Ok(())
577         }
578
579         #[inline]
580         fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>)) {
581                 let (local_txn, mut failed_htlcs) = shutdown_res;
582                 for htlc_source in failed_htlcs.drain(..) {
583                         // unknown_next_peer...I dunno who that is anymore....
584                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
585                 }
586                 for tx in local_txn {
587                         self.tx_broadcaster.broadcast_transaction(&tx);
588                 }
589                 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
590                 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
591                 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
592                 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
593                 //timeouts are hit and our claims confirm).
594                 //TODO: In any case, we need to make sure we remove any pending htlc tracking (via
595                 //fail_backwards or claim_funds) eventually for all HTLCs that were in the channel
596         }
597
598         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
599         /// the chain and rejecting new HTLCs on the given channel.
600         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
601                 let _ = self.total_consistency_lock.read().unwrap();
602
603                 let mut chan = {
604                         let mut channel_state_lock = self.channel_state.lock().unwrap();
605                         let channel_state = channel_state_lock.borrow_parts();
606                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
607                                 if let Some(short_id) = chan.get_short_channel_id() {
608                                         channel_state.short_to_id.remove(&short_id);
609                                 }
610                                 chan
611                         } else {
612                                 return;
613                         }
614                 };
615                 self.finish_force_close_channel(chan.force_shutdown());
616                 if let Ok(update) = self.get_channel_update(&chan) {
617                         let mut channel_state = self.channel_state.lock().unwrap();
618                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
619                                 msg: update
620                         });
621                 }
622         }
623
624         /// Force close all channels, immediately broadcasting the latest local commitment transaction
625         /// for each to the chain and rejecting new HTLCs on each.
626         pub fn force_close_all_channels(&self) {
627                 for chan in self.list_channels() {
628                         self.force_close_channel(&chan.channel_id);
629                 }
630         }
631
632         fn handle_monitor_update_fail(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, channel_id: &[u8; 32], err: ChannelMonitorUpdateErr, reason: RAACommitmentOrder) {
633                 match err {
634                         ChannelMonitorUpdateErr::PermanentFailure => {
635                                 let mut chan = {
636                                         let channel_state = channel_state_lock.borrow_parts();
637                                         let chan = channel_state.by_id.remove(channel_id).expect("monitor_update_failed must be called within the same lock as the channel get!");
638                                         if let Some(short_id) = chan.get_short_channel_id() {
639                                                 channel_state.short_to_id.remove(&short_id);
640                                         }
641                                         chan
642                                 };
643                                 mem::drop(channel_state_lock);
644                                 self.finish_force_close_channel(chan.force_shutdown());
645                                 if let Ok(update) = self.get_channel_update(&chan) {
646                                         let mut channel_state = self.channel_state.lock().unwrap();
647                                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
648                                                 msg: update
649                                         });
650                                 }
651                         },
652                         ChannelMonitorUpdateErr::TemporaryFailure => {
653                                 let channel = channel_state_lock.by_id.get_mut(channel_id).expect("monitor_update_failed must be called within the same lock as the channel get!");
654                                 channel.monitor_update_failed(reason);
655                         },
656                 }
657         }
658
659         #[inline]
660         fn gen_rho_mu_from_shared_secret(shared_secret: &[u8]) -> ([u8; 32], [u8; 32]) {
661                 assert_eq!(shared_secret.len(), 32);
662                 ({
663                         let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
664                         hmac.input(&shared_secret[..]);
665                         let mut res = [0; 32];
666                         hmac.raw_result(&mut res);
667                         res
668                 },
669                 {
670                         let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
671                         hmac.input(&shared_secret[..]);
672                         let mut res = [0; 32];
673                         hmac.raw_result(&mut res);
674                         res
675                 })
676         }
677
678         #[inline]
679         fn gen_um_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
680                 assert_eq!(shared_secret.len(), 32);
681                 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
682                 hmac.input(&shared_secret[..]);
683                 let mut res = [0; 32];
684                 hmac.raw_result(&mut res);
685                 res
686         }
687
688         #[inline]
689         fn gen_ammag_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
690                 assert_eq!(shared_secret.len(), 32);
691                 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
692                 hmac.input(&shared_secret[..]);
693                 let mut res = [0; 32];
694                 hmac.raw_result(&mut res);
695                 res
696         }
697
698         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
699         #[inline]
700         fn construct_onion_keys_callback<T: secp256k1::Signing, FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey, mut callback: FType) -> Result<(), secp256k1::Error> {
701                 let mut blinded_priv = session_priv.clone();
702                 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
703
704                 for hop in route.hops.iter() {
705                         let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
706
707                         let mut sha = Sha256::new();
708                         sha.input(&blinded_pub.serialize()[..]);
709                         sha.input(&shared_secret[..]);
710                         let mut blinding_factor = [0u8; 32];
711                         sha.result(&mut blinding_factor);
712
713                         let ephemeral_pubkey = blinded_pub;
714
715                         blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
716                         blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
717
718                         callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
719                 }
720
721                 Ok(())
722         }
723
724         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
725         fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
726                 let mut res = Vec::with_capacity(route.hops.len());
727
728                 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
729                         let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret[..]);
730
731                         res.push(OnionKeys {
732                                 #[cfg(test)]
733                                 shared_secret,
734                                 #[cfg(test)]
735                                 blinding_factor: _blinding_factor,
736                                 ephemeral_pubkey,
737                                 rho,
738                                 mu,
739                         });
740                 })?;
741
742                 Ok(res)
743         }
744
745         /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
746         fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
747                 let mut cur_value_msat = 0u64;
748                 let mut cur_cltv = starting_htlc_offset;
749                 let mut last_short_channel_id = 0;
750                 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
751                 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
752                 unsafe { res.set_len(route.hops.len()); }
753
754                 for (idx, hop) in route.hops.iter().enumerate().rev() {
755                         // First hop gets special values so that it can check, on receipt, that everything is
756                         // exactly as it should be (and the next hop isn't trying to probe to find out if we're
757                         // the intended recipient).
758                         let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
759                         let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
760                         res[idx] = msgs::OnionHopData {
761                                 realm: 0,
762                                 data: msgs::OnionRealm0HopData {
763                                         short_channel_id: last_short_channel_id,
764                                         amt_to_forward: value_msat,
765                                         outgoing_cltv_value: cltv,
766                                 },
767                                 hmac: [0; 32],
768                         };
769                         cur_value_msat += hop.fee_msat;
770                         if cur_value_msat >= 21000000 * 100000000 * 1000 {
771                                 return Err(APIError::RouteError{err: "Channel fees overflowed?!"});
772                         }
773                         cur_cltv += hop.cltv_expiry_delta as u32;
774                         if cur_cltv >= 500000000 {
775                                 return Err(APIError::RouteError{err: "Channel CLTV overflowed?!"});
776                         }
777                         last_short_channel_id = hop.short_channel_id;
778                 }
779                 Ok((res, cur_value_msat, cur_cltv))
780         }
781
782         #[inline]
783         fn shift_arr_right(arr: &mut [u8; 20*65]) {
784                 unsafe {
785                         ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
786                 }
787                 for i in 0..65 {
788                         arr[i] = 0;
789                 }
790         }
791
792         #[inline]
793         fn xor_bufs(dst: &mut[u8], src: &[u8]) {
794                 assert_eq!(dst.len(), src.len());
795
796                 for i in 0..dst.len() {
797                         dst[i] ^= src[i];
798                 }
799         }
800
801         const ZERO:[u8; 21*65] = [0; 21*65];
802         fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> msgs::OnionPacket {
803                 let mut buf = Vec::with_capacity(21*65);
804                 buf.resize(21*65, 0);
805
806                 let filler = {
807                         let iters = payloads.len() - 1;
808                         let end_len = iters * 65;
809                         let mut res = Vec::with_capacity(end_len);
810                         res.resize(end_len, 0);
811
812                         for (i, keys) in onion_keys.iter().enumerate() {
813                                 if i == payloads.len() - 1 { continue; }
814                                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
815                                 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
816                                 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
817                         }
818                         res
819                 };
820
821                 let mut packet_data = [0; 20*65];
822                 let mut hmac_res = [0; 32];
823
824                 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
825                         ChannelManager::shift_arr_right(&mut packet_data);
826                         payload.hmac = hmac_res;
827                         packet_data[0..65].copy_from_slice(&payload.encode()[..]);
828
829                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
830                         chacha.process(&packet_data, &mut buf[0..20*65]);
831                         packet_data[..].copy_from_slice(&buf[0..20*65]);
832
833                         if i == 0 {
834                                 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
835                         }
836
837                         let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
838                         hmac.input(&packet_data);
839                         hmac.input(&associated_data[..]);
840                         hmac.raw_result(&mut hmac_res);
841                 }
842
843                 msgs::OnionPacket{
844                         version: 0,
845                         public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
846                         hop_data: packet_data,
847                         hmac: hmac_res,
848                 }
849         }
850
851         /// Encrypts a failure packet. raw_packet can either be a
852         /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
853         fn encrypt_failure_packet(shared_secret: &[u8], raw_packet: &[u8]) -> msgs::OnionErrorPacket {
854                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
855
856                 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
857                 packet_crypted.resize(raw_packet.len(), 0);
858                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
859                 chacha.process(&raw_packet, &mut packet_crypted[..]);
860                 msgs::OnionErrorPacket {
861                         data: packet_crypted,
862                 }
863         }
864
865         fn build_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
866                 assert_eq!(shared_secret.len(), 32);
867                 assert!(failure_data.len() <= 256 - 2);
868
869                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
870
871                 let failuremsg = {
872                         let mut res = Vec::with_capacity(2 + failure_data.len());
873                         res.push(((failure_type >> 8) & 0xff) as u8);
874                         res.push(((failure_type >> 0) & 0xff) as u8);
875                         res.extend_from_slice(&failure_data[..]);
876                         res
877                 };
878                 let pad = {
879                         let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
880                         res.resize(256 - 2 - failure_data.len(), 0);
881                         res
882                 };
883                 let mut packet = msgs::DecodedOnionErrorPacket {
884                         hmac: [0; 32],
885                         failuremsg: failuremsg,
886                         pad: pad,
887                 };
888
889                 let mut hmac = Hmac::new(Sha256::new(), &um);
890                 hmac.input(&packet.encode()[32..]);
891                 hmac.raw_result(&mut packet.hmac);
892
893                 packet
894         }
895
896         #[inline]
897         fn build_first_hop_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
898                 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
899                 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
900         }
901
902         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
903                 macro_rules! get_onion_hash {
904                         () => {
905                                 {
906                                         let mut sha = Sha256::new();
907                                         sha.input(&msg.onion_routing_packet.hop_data);
908                                         let mut onion_hash = [0; 32];
909                                         sha.result(&mut onion_hash);
910                                         onion_hash
911                                 }
912                         }
913                 }
914
915                 if let Err(_) = msg.onion_routing_packet.public_key {
916                         log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
917                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
918                                 channel_id: msg.channel_id,
919                                 htlc_id: msg.htlc_id,
920                                 sha256_of_onion: get_onion_hash!(),
921                                 failure_code: 0x8000 | 0x4000 | 6,
922                         })), self.channel_state.lock().unwrap());
923                 }
924
925                 let shared_secret = {
926                         let mut arr = [0; 32];
927                         arr.copy_from_slice(&SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
928                         arr
929                 };
930                 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
931
932                 let mut channel_state = None;
933                 macro_rules! return_err {
934                         ($msg: expr, $err_code: expr, $data: expr) => {
935                                 {
936                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
937                                         if channel_state.is_none() {
938                                                 channel_state = Some(self.channel_state.lock().unwrap());
939                                         }
940                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
941                                                 channel_id: msg.channel_id,
942                                                 htlc_id: msg.htlc_id,
943                                                 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
944                                         })), channel_state.unwrap());
945                                 }
946                         }
947                 }
948
949                 if msg.onion_routing_packet.version != 0 {
950                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
951                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
952                         //the hash doesn't really serve any purpuse - in the case of hashing all data, the
953                         //receiving node would have to brute force to figure out which version was put in the
954                         //packet by the node that send us the message, in the case of hashing the hop_data, the
955                         //node knows the HMAC matched, so they already know what is there...
956                         return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
957                 }
958
959                 let mut hmac = Hmac::new(Sha256::new(), &mu);
960                 hmac.input(&msg.onion_routing_packet.hop_data);
961                 hmac.input(&msg.payment_hash);
962                 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
963                         return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
964                 }
965
966                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
967                 let next_hop_data = {
968                         let mut decoded = [0; 65];
969                         chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
970                         match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
971                                 Err(err) => {
972                                         let error_code = match err {
973                                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
974                                                 _ => 0x2000 | 2, // Should never happen
975                                         };
976                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
977                                 },
978                                 Ok(msg) => msg
979                         }
980                 };
981
982                 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
983                                 // OUR PAYMENT!
984                                 // final_expiry_too_soon
985                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS) as u64 {
986                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
987                                 }
988                                 // final_incorrect_htlc_amount
989                                 if next_hop_data.data.amt_to_forward > msg.amount_msat {
990                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
991                                 }
992                                 // final_incorrect_cltv_expiry
993                                 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
994                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
995                                 }
996
997                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
998                                 // message, however that would leak that we are the recipient of this payment, so
999                                 // instead we stay symmetric with the forwarding case, only responding (after a
1000                                 // delay) once they've send us a commitment_signed!
1001
1002                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1003                                         onion_packet: None,
1004                                         payment_hash: msg.payment_hash.clone(),
1005                                         short_channel_id: 0,
1006                                         incoming_shared_secret: shared_secret,
1007                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1008                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1009                                 })
1010                         } else {
1011                                 let mut new_packet_data = [0; 20*65];
1012                                 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
1013                                 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
1014
1015                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1016
1017                                 let blinding_factor = {
1018                                         let mut sha = Sha256::new();
1019                                         sha.input(&new_pubkey.serialize()[..]);
1020                                         sha.input(&shared_secret);
1021                                         let mut res = [0u8; 32];
1022                                         sha.result(&mut res);
1023                                         match SecretKey::from_slice(&self.secp_ctx, &res) {
1024                                                 Err(_) => {
1025                                                         return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1026                                                 },
1027                                                 Ok(key) => key
1028                                         }
1029                                 };
1030
1031                                 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
1032                                         return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1033                                 }
1034
1035                                 let outgoing_packet = msgs::OnionPacket {
1036                                         version: 0,
1037                                         public_key: Ok(new_pubkey),
1038                                         hop_data: new_packet_data,
1039                                         hmac: next_hop_data.hmac.clone(),
1040                                 };
1041
1042                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1043                                         onion_packet: Some(outgoing_packet),
1044                                         payment_hash: msg.payment_hash.clone(),
1045                                         short_channel_id: next_hop_data.data.short_channel_id,
1046                                         incoming_shared_secret: shared_secret,
1047                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1048                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1049                                 })
1050                         };
1051
1052                 channel_state = Some(self.channel_state.lock().unwrap());
1053                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1054                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1055                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1056                                 let forwarding_id = match id_option {
1057                                         None => { // unknown_next_peer
1058                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1059                                         },
1060                                         Some(id) => id.clone(),
1061                                 };
1062                                 if let Some((err, code, chan_update)) = loop {
1063                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1064
1065                                         // Note that we could technically not return an error yet here and just hope
1066                                         // that the connection is reestablished or monitor updated by the time we get
1067                                         // around to doing the actual forward, but better to fail early if we can and
1068                                         // hopefully an attacker trying to path-trace payments cannot make this occur
1069                                         // on a small/per-node/per-channel scale.
1070                                         if !chan.is_live() { // channel_disabled
1071                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1072                                         }
1073                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1074                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1075                                         }
1076                                         let fee = amt_to_forward.checked_mul(chan.get_fee_proportional_millionths() as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan.get_our_fee_base_msat(&*self.fee_estimator) as u64) });
1077                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1078                                                 break Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, Some(self.get_channel_update(chan).unwrap())));
1079                                         }
1080                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1081                                                 break Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, Some(self.get_channel_update(chan).unwrap())));
1082                                         }
1083                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1084                                         // We want to have at least HTLC_FAIL_TIMEOUT_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1085                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS as u32 { // expiry_too_soon
1086                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1087                                         }
1088                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1089                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1090                                         }
1091                                         break None;
1092                                 }
1093                                 {
1094                                         let mut res = Vec::with_capacity(8 + 128);
1095                                         if code == 0x1000 | 11 || code == 0x1000 | 12 {
1096                                                 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1097                                         }
1098                                         else if code == 0x1000 | 13 {
1099                                                 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1100                                         }
1101                                         if let Some(chan_update) = chan_update {
1102                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1103                                         }
1104                                         return_err!(err, code, &res[..]);
1105                                 }
1106                         }
1107                 }
1108
1109                 (pending_forward_info, channel_state.unwrap())
1110         }
1111
1112         /// only fails if the channel does not yet have an assigned short_id
1113         /// May be called with channel_state already locked!
1114         fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
1115                 let short_channel_id = match chan.get_short_channel_id() {
1116                         None => return Err(HandleError{err: "Channel not yet established", action: None}),
1117                         Some(id) => id,
1118                 };
1119
1120                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1121
1122                 let unsigned = msgs::UnsignedChannelUpdate {
1123                         chain_hash: self.genesis_hash,
1124                         short_channel_id: short_channel_id,
1125                         timestamp: chan.get_channel_update_count(),
1126                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1127                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1128                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1129                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1130                         fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1131                         excess_data: Vec::new(),
1132                 };
1133
1134                 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
1135                 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key);
1136
1137                 Ok(msgs::ChannelUpdate {
1138                         signature: sig,
1139                         contents: unsigned
1140                 })
1141         }
1142
1143         /// Sends a payment along a given route.
1144         ///
1145         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1146         /// fields for more info.
1147         ///
1148         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1149         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1150         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1151         /// specified in the last hop in the route! Thus, you should probably do your own
1152         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1153         /// payment") and prevent double-sends yourself.
1154         ///
1155         /// May generate a SendHTLCs message event on success, which should be relayed.
1156         ///
1157         /// Raises APIError::RoutError when invalid route or forward parameter
1158         /// (cltv_delta, fee, node public key) is specified
1159         pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), APIError> {
1160                 if route.hops.len() < 1 || route.hops.len() > 20 {
1161                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1162                 }
1163                 let our_node_id = self.get_our_node_id();
1164                 for (idx, hop) in route.hops.iter().enumerate() {
1165                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1166                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1167                         }
1168                 }
1169
1170                 let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
1171                         let mut session_key = [0; 32];
1172                         rng::fill_bytes(&mut session_key);
1173                         session_key
1174                 }).expect("RNG is bad!");
1175
1176                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1177
1178                 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1179                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1180                 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
1181                 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1182
1183                 let _ = self.total_consistency_lock.read().unwrap();
1184                 let mut channel_state = self.channel_state.lock().unwrap();
1185
1186                 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1187                         None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1188                         Some(id) => id.clone(),
1189                 };
1190
1191                 let res = {
1192                         let chan = channel_state.by_id.get_mut(&id).unwrap();
1193                         if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
1194                                 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1195                         }
1196                         if chan.is_awaiting_monitor_update() {
1197                                 return Err(APIError::MonitorUpdateFailed);
1198                         }
1199                         if !chan.is_live() {
1200                                 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected!"});
1201                         }
1202                         chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1203                                 route: route.clone(),
1204                                 session_priv: session_priv.clone(),
1205                                 first_hop_htlc_msat: htlc_msat,
1206                         }, onion_packet).map_err(|he| APIError::ChannelUnavailable{err: he.err})?
1207                 };
1208                 match res {
1209                         Some((update_add, commitment_signed, chan_monitor)) => {
1210                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1211                                         self.handle_monitor_update_fail(channel_state, &id, e, RAACommitmentOrder::CommitmentFirst);
1212                                         return Err(APIError::MonitorUpdateFailed);
1213                                 }
1214
1215                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1216                                         node_id: route.hops.first().unwrap().pubkey,
1217                                         updates: msgs::CommitmentUpdate {
1218                                                 update_add_htlcs: vec![update_add],
1219                                                 update_fulfill_htlcs: Vec::new(),
1220                                                 update_fail_htlcs: Vec::new(),
1221                                                 update_fail_malformed_htlcs: Vec::new(),
1222                                                 update_fee: None,
1223                                                 commitment_signed,
1224                                         },
1225                                 });
1226                         },
1227                         None => {},
1228                 }
1229
1230                 Ok(())
1231         }
1232
1233         /// Call this upon creation of a funding transaction for the given channel.
1234         ///
1235         /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1236         /// or your counterparty can steal your funds!
1237         ///
1238         /// Panics if a funding transaction has already been provided for this channel.
1239         ///
1240         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1241         /// be trivially prevented by using unique funding transaction keys per-channel).
1242         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1243                 let _ = self.total_consistency_lock.read().unwrap();
1244
1245                 let (chan, msg, chan_monitor) = {
1246                         let mut channel_state = self.channel_state.lock().unwrap();
1247                         match channel_state.by_id.remove(temporary_channel_id) {
1248                                 Some(mut chan) => {
1249                                         match chan.get_outbound_funding_created(funding_txo) {
1250                                                 Ok(funding_msg) => {
1251                                                         (chan, funding_msg.0, funding_msg.1)
1252                                                 },
1253                                                 Err(e) => {
1254                                                         log_error!(self, "Got bad signatures: {}!", e.err);
1255                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1256                                                                 node_id: chan.get_their_node_id(),
1257                                                                 action: e.action,
1258                                                         });
1259                                                         return;
1260                                                 },
1261                                         }
1262                                 },
1263                                 None => return
1264                         }
1265                 };
1266                 // Because we have exclusive ownership of the channel here we can release the channel_state
1267                 // lock before add_update_monitor
1268                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1269                         unimplemented!();
1270                 }
1271
1272                 let mut channel_state = self.channel_state.lock().unwrap();
1273                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1274                         node_id: chan.get_their_node_id(),
1275                         msg: msg,
1276                 });
1277                 match channel_state.by_id.entry(chan.channel_id()) {
1278                         hash_map::Entry::Occupied(_) => {
1279                                 panic!("Generated duplicate funding txid?");
1280                         },
1281                         hash_map::Entry::Vacant(e) => {
1282                                 e.insert(chan);
1283                         }
1284                 }
1285         }
1286
1287         fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1288                 if !chan.should_announce() { return None }
1289
1290                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1291                         Ok(res) => res,
1292                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1293                 };
1294                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1295                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1296
1297                 Some(msgs::AnnouncementSignatures {
1298                         channel_id: chan.channel_id(),
1299                         short_channel_id: chan.get_short_channel_id().unwrap(),
1300                         node_signature: our_node_sig,
1301                         bitcoin_signature: our_bitcoin_sig,
1302                 })
1303         }
1304
1305         /// Processes HTLCs which are pending waiting on random forward delay.
1306         ///
1307         /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1308         /// Will likely generate further events.
1309         pub fn process_pending_htlc_forwards(&self) {
1310                 let _ = self.total_consistency_lock.read().unwrap();
1311
1312                 let mut new_events = Vec::new();
1313                 let mut failed_forwards = Vec::new();
1314                 {
1315                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1316                         let channel_state = channel_state_lock.borrow_parts();
1317
1318                         if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1319                                 return;
1320                         }
1321
1322                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1323                                 if short_chan_id != 0 {
1324                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1325                                                 Some(chan_id) => chan_id.clone(),
1326                                                 None => {
1327                                                         failed_forwards.reserve(pending_forwards.len());
1328                                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1329                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1330                                                                         short_channel_id: prev_short_channel_id,
1331                                                                         htlc_id: prev_htlc_id,
1332                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1333                                                                 });
1334                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1335                                                         }
1336                                                         continue;
1337                                                 }
1338                                         };
1339                                         let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1340
1341                                         let mut add_htlc_msgs = Vec::new();
1342                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1343                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1344                                                         short_channel_id: prev_short_channel_id,
1345                                                         htlc_id: prev_htlc_id,
1346                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1347                                                 });
1348                                                 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, htlc_source.clone(), forward_info.onion_packet.unwrap()) {
1349                                                         Err(_e) => {
1350                                                                 let chan_update = self.get_channel_update(forward_chan).unwrap();
1351                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1352                                                                 continue;
1353                                                         },
1354                                                         Ok(update_add) => {
1355                                                                 match update_add {
1356                                                                         Some(msg) => { add_htlc_msgs.push(msg); },
1357                                                                         None => {
1358                                                                                 // Nothing to do here...we're waiting on a remote
1359                                                                                 // revoke_and_ack before we can add anymore HTLCs. The Channel
1360                                                                                 // will automatically handle building the update_add_htlc and
1361                                                                                 // commitment_signed messages when we can.
1362                                                                                 // TODO: Do some kind of timer to set the channel as !is_live()
1363                                                                                 // as we don't really want others relying on us relaying through
1364                                                                                 // this channel currently :/.
1365                                                                         }
1366                                                                 }
1367                                                         }
1368                                                 }
1369                                         }
1370
1371                                         if !add_htlc_msgs.is_empty() {
1372                                                 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1373                                                         Ok(res) => res,
1374                                                         Err(e) => {
1375                                                                 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(ref _err_msg)}) = &e.action {
1376                                                                 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: ref _err_msg}) = &e.action {
1377                                                                 } else {
1378                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1379                                                                 }
1380                                                                 //TODO: Handle...this is bad!
1381                                                                 continue;
1382                                                         },
1383                                                 };
1384                                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1385                                                         unimplemented!();// but def dont push the event...
1386                                                 }
1387                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1388                                                         node_id: forward_chan.get_their_node_id(),
1389                                                         updates: msgs::CommitmentUpdate {
1390                                                                 update_add_htlcs: add_htlc_msgs,
1391                                                                 update_fulfill_htlcs: Vec::new(),
1392                                                                 update_fail_htlcs: Vec::new(),
1393                                                                 update_fail_malformed_htlcs: Vec::new(),
1394                                                                 update_fee: None,
1395                                                                 commitment_signed: commitment_msg,
1396                                                         },
1397                                                 });
1398                                         }
1399                                 } else {
1400                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1401                                                 let prev_hop_data = HTLCPreviousHopData {
1402                                                         short_channel_id: prev_short_channel_id,
1403                                                         htlc_id: prev_htlc_id,
1404                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1405                                                 };
1406                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1407                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(prev_hop_data),
1408                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![prev_hop_data]); },
1409                                                 };
1410                                                 new_events.push(events::Event::PaymentReceived {
1411                                                         payment_hash: forward_info.payment_hash,
1412                                                         amt: forward_info.amt_to_forward,
1413                                                 });
1414                                         }
1415                                 }
1416                         }
1417                 }
1418
1419                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1420                         match update {
1421                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1422                                 Some(chan_update) => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: chan_update.encode_with_len() }),
1423                         };
1424                 }
1425
1426                 if new_events.is_empty() { return }
1427                 let mut events = self.pending_events.lock().unwrap();
1428                 events.append(&mut new_events);
1429         }
1430
1431         /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect after a PaymentReceived event.
1432         pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32], reason: PaymentFailReason) -> bool {
1433                 let _ = self.total_consistency_lock.read().unwrap();
1434
1435                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1436                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1437                 if let Some(mut sources) = removed_source {
1438                         for htlc_with_hash in sources.drain(..) {
1439                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1440                                 self.fail_htlc_backwards_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_hash, HTLCFailReason::Reason { failure_code: if reason == PaymentFailReason::PreimageUnknown {0x4000 | 15} else {0x4000 | 16}, data: Vec::new() });
1441                         }
1442                         true
1443                 } else { false }
1444         }
1445
1446         /// Fails an HTLC backwards to the sender of it to us.
1447         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1448         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1449         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1450         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1451         /// still-available channels.
1452         fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &[u8; 32], onion_error: HTLCFailReason) {
1453                 match source {
1454                         HTLCSource::OutboundRoute { .. } => {
1455                                 mem::drop(channel_state_lock);
1456                                 if let &HTLCFailReason::ErrorPacket { ref err } = &onion_error {
1457                                         let (channel_update, payment_retryable) = self.process_onion_failure(&source, err.data.clone());
1458                                         if let Some(update) = channel_update {
1459                                                 self.channel_state.lock().unwrap().pending_msg_events.push(
1460                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate {
1461                                                                 update,
1462                                                         }
1463                                                 );
1464                                         }
1465                                         self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1466                                                 payment_hash: payment_hash.clone(),
1467                                                 rejected_by_dest: !payment_retryable,
1468                                         });
1469                                 } else {
1470                                         panic!("should have onion error packet here");
1471                                 }
1472                         },
1473                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1474                                 let err_packet = match onion_error {
1475                                         HTLCFailReason::Reason { failure_code, data } => {
1476                                                 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1477                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1478                                         },
1479                                         HTLCFailReason::ErrorPacket { err } => {
1480                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1481                                         }
1482                                 };
1483
1484                                 let channel_state = channel_state_lock.borrow_parts();
1485
1486                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1487                                         Some(chan_id) => chan_id.clone(),
1488                                         None => return
1489                                 };
1490
1491                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1492                                 match chan.get_update_fail_htlc_and_commit(htlc_id, err_packet) {
1493                                         Ok(Some((msg, commitment_msg, chan_monitor))) => {
1494                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1495                                                         unimplemented!();
1496                                                 }
1497                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1498                                                         node_id: chan.get_their_node_id(),
1499                                                         updates: msgs::CommitmentUpdate {
1500                                                                 update_add_htlcs: Vec::new(),
1501                                                                 update_fulfill_htlcs: Vec::new(),
1502                                                                 update_fail_htlcs: vec![msg],
1503                                                                 update_fail_malformed_htlcs: Vec::new(),
1504                                                                 update_fee: None,
1505                                                                 commitment_signed: commitment_msg,
1506                                                         },
1507                                                 });
1508                                         },
1509                                         Ok(None) => {},
1510                                         Err(_e) => {
1511                                                 //TODO: Do something with e?
1512                                                 return;
1513                                         },
1514                                 }
1515                         },
1516                 }
1517         }
1518
1519         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1520         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1521         /// should probably kick the net layer to go send messages if this returns true!
1522         ///
1523         /// May panic if called except in response to a PaymentReceived event.
1524         pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1525                 let mut sha = Sha256::new();
1526                 sha.input(&payment_preimage);
1527                 let mut payment_hash = [0; 32];
1528                 sha.result(&mut payment_hash);
1529
1530                 let _ = self.total_consistency_lock.read().unwrap();
1531
1532                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1533                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1534                 if let Some(mut sources) = removed_source {
1535                         for htlc_with_hash in sources.drain(..) {
1536                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1537                                 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1538                         }
1539                         true
1540                 } else { false }
1541         }
1542         fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: [u8; 32]) {
1543                 match source {
1544                         HTLCSource::OutboundRoute { .. } => {
1545                                 mem::drop(channel_state_lock);
1546                                 let mut pending_events = self.pending_events.lock().unwrap();
1547                                 pending_events.push(events::Event::PaymentSent {
1548                                         payment_preimage
1549                                 });
1550                         },
1551                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1552                                 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1553                                 let channel_state = channel_state_lock.borrow_parts();
1554
1555                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1556                                         Some(chan_id) => chan_id.clone(),
1557                                         None => {
1558                                                 // TODO: There is probably a channel manager somewhere that needs to
1559                                                 // learn the preimage as the channel already hit the chain and that's
1560                                                 // why its missing.
1561                                                 return
1562                                         }
1563                                 };
1564
1565                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1566                                 match chan.get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1567                                         Ok((msgs, monitor_option)) => {
1568                                                 if let Some(chan_monitor) = monitor_option {
1569                                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1570                                                                 unimplemented!();// but def dont push the event...
1571                                                         }
1572                                                 }
1573                                                 if let Some((msg, commitment_signed)) = msgs {
1574                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1575                                                                 node_id: chan.get_their_node_id(),
1576                                                                 updates: msgs::CommitmentUpdate {
1577                                                                         update_add_htlcs: Vec::new(),
1578                                                                         update_fulfill_htlcs: vec![msg],
1579                                                                         update_fail_htlcs: Vec::new(),
1580                                                                         update_fail_malformed_htlcs: Vec::new(),
1581                                                                         update_fee: None,
1582                                                                         commitment_signed,
1583                                                                 }
1584                                                         });
1585                                                 }
1586                                         },
1587                                         Err(_e) => {
1588                                                 // TODO: There is probably a channel manager somewhere that needs to
1589                                                 // learn the preimage as the channel may be about to hit the chain.
1590                                                 //TODO: Do something with e?
1591                                                 return
1592                                         },
1593                                 }
1594                         },
1595                 }
1596         }
1597
1598         /// Gets the node_id held by this ChannelManager
1599         pub fn get_our_node_id(&self) -> PublicKey {
1600                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1601         }
1602
1603         /// Used to restore channels to normal operation after a
1604         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1605         /// operation.
1606         pub fn test_restore_channel_monitor(&self) {
1607                 let mut close_results = Vec::new();
1608                 let mut htlc_forwards = Vec::new();
1609                 let mut htlc_failures = Vec::new();
1610                 let _ = self.total_consistency_lock.read().unwrap();
1611
1612                 {
1613                         let mut channel_lock = self.channel_state.lock().unwrap();
1614                         let channel_state = channel_lock.borrow_parts();
1615                         let short_to_id = channel_state.short_to_id;
1616                         let pending_msg_events = channel_state.pending_msg_events;
1617                         channel_state.by_id.retain(|_, channel| {
1618                                 if channel.is_awaiting_monitor_update() {
1619                                         let chan_monitor = channel.channel_monitor();
1620                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1621                                                 match e {
1622                                                         ChannelMonitorUpdateErr::PermanentFailure => {
1623                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1624                                                                         short_to_id.remove(&short_id);
1625                                                                 }
1626                                                                 close_results.push(channel.force_shutdown());
1627                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1628                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1629                                                                                 msg: update
1630                                                                         });
1631                                                                 }
1632                                                                 false
1633                                                         },
1634                                                         ChannelMonitorUpdateErr::TemporaryFailure => true,
1635                                                 }
1636                                         } else {
1637                                                 let (raa, commitment_update, order, pending_forwards, mut pending_failures) = channel.monitor_updating_restored();
1638                                                 if !pending_forwards.is_empty() {
1639                                                         htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1640                                                 }
1641                                                 htlc_failures.append(&mut pending_failures);
1642
1643                                                 macro_rules! handle_cs { () => {
1644                                                         if let Some(update) = commitment_update {
1645                                                                 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1646                                                                         node_id: channel.get_their_node_id(),
1647                                                                         updates: update,
1648                                                                 });
1649                                                         }
1650                                                 } }
1651                                                 macro_rules! handle_raa { () => {
1652                                                         if let Some(revoke_and_ack) = raa {
1653                                                                 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1654                                                                         node_id: channel.get_their_node_id(),
1655                                                                         msg: revoke_and_ack,
1656                                                                 });
1657                                                         }
1658                                                 } }
1659                                                 match order {
1660                                                         RAACommitmentOrder::CommitmentFirst => {
1661                                                                 handle_cs!();
1662                                                                 handle_raa!();
1663                                                         },
1664                                                         RAACommitmentOrder::RevokeAndACKFirst => {
1665                                                                 handle_raa!();
1666                                                                 handle_cs!();
1667                                                         },
1668                                                 }
1669                                                 true
1670                                         }
1671                                 } else { true }
1672                         });
1673                 }
1674
1675                 for failure in htlc_failures.drain(..) {
1676                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1677                 }
1678                 self.forward_htlcs(&mut htlc_forwards[..]);
1679
1680                 for res in close_results.drain(..) {
1681                         self.finish_force_close_channel(res);
1682                 }
1683         }
1684
1685         fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1686                 if msg.chain_hash != self.genesis_hash {
1687                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1688                 }
1689
1690                 let channel = Channel::new_from_req(&*self.fee_estimator, &self.keys_manager, their_node_id.clone(), msg, 0, Arc::clone(&self.logger), &self.default_configuration)
1691                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1692                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1693                 let channel_state = channel_state_lock.borrow_parts();
1694                 match channel_state.by_id.entry(channel.channel_id()) {
1695                         hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1696                         hash_map::Entry::Vacant(entry) => {
1697                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1698                                         node_id: their_node_id.clone(),
1699                                         msg: channel.get_accept_channel(),
1700                                 });
1701                                 entry.insert(channel);
1702                         }
1703                 }
1704                 Ok(())
1705         }
1706
1707         fn internal_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1708                 let (value, output_script, user_id) = {
1709                         let mut channel_state = self.channel_state.lock().unwrap();
1710                         match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1711                                 Some(chan) => {
1712                                         if chan.get_their_node_id() != *their_node_id {
1713                                                 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1714                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1715                                         }
1716                                         chan.accept_channel(&msg, &self.default_configuration)
1717                                                 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.temporary_channel_id))?;
1718                                         (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1719                                 },
1720                                 //TODO: same as above
1721                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1722                         }
1723                 };
1724                 let mut pending_events = self.pending_events.lock().unwrap();
1725                 pending_events.push(events::Event::FundingGenerationReady {
1726                         temporary_channel_id: msg.temporary_channel_id,
1727                         channel_value_satoshis: value,
1728                         output_script: output_script,
1729                         user_channel_id: user_id,
1730                 });
1731                 Ok(())
1732         }
1733
1734         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1735                 let (chan, funding_msg, monitor_update) = {
1736                         let mut channel_state = self.channel_state.lock().unwrap();
1737                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1738                                 hash_map::Entry::Occupied(mut chan) => {
1739                                         if chan.get().get_their_node_id() != *their_node_id {
1740                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1741                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1742                                         }
1743                                         match chan.get_mut().funding_created(msg) {
1744                                                 Ok((funding_msg, monitor_update)) => {
1745                                                         (chan.remove(), funding_msg, monitor_update)
1746                                                 },
1747                                                 Err(e) => {
1748                                                         return Err(e).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1749                                                 }
1750                                         }
1751                                 },
1752                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1753                         }
1754                 };
1755                 // Because we have exclusive ownership of the channel here we can release the channel_state
1756                 // lock before add_update_monitor
1757                 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1758                         unimplemented!();
1759                 }
1760                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1761                 let channel_state = channel_state_lock.borrow_parts();
1762                 match channel_state.by_id.entry(funding_msg.channel_id) {
1763                         hash_map::Entry::Occupied(_) => {
1764                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1765                         },
1766                         hash_map::Entry::Vacant(e) => {
1767                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1768                                         node_id: their_node_id.clone(),
1769                                         msg: funding_msg,
1770                                 });
1771                                 e.insert(chan);
1772                         }
1773                 }
1774                 Ok(())
1775         }
1776
1777         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1778                 let (funding_txo, user_id) = {
1779                         let mut channel_state = self.channel_state.lock().unwrap();
1780                         match channel_state.by_id.get_mut(&msg.channel_id) {
1781                                 Some(chan) => {
1782                                         if chan.get_their_node_id() != *their_node_id {
1783                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1784                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1785                                         }
1786                                         let chan_monitor = chan.funding_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1787                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1788                                                 unimplemented!();
1789                                         }
1790                                         (chan.get_funding_txo().unwrap(), chan.get_user_id())
1791                                 },
1792                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1793                         }
1794                 };
1795                 let mut pending_events = self.pending_events.lock().unwrap();
1796                 pending_events.push(events::Event::FundingBroadcastSafe {
1797                         funding_txo: funding_txo,
1798                         user_channel_id: user_id,
1799                 });
1800                 Ok(())
1801         }
1802
1803         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
1804                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1805                 let channel_state = channel_state_lock.borrow_parts();
1806                 match channel_state.by_id.get_mut(&msg.channel_id) {
1807                         Some(chan) => {
1808                                 if chan.get_their_node_id() != *their_node_id {
1809                                         //TODO: here and below MsgHandleErrInternal, #153 case
1810                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1811                                 }
1812                                 chan.funding_locked(&msg)
1813                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1814                                 if let Some(announcement_sigs) = self.get_announcement_sigs(chan) {
1815                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1816                                                 node_id: their_node_id.clone(),
1817                                                 msg: announcement_sigs,
1818                                         });
1819                                 }
1820                                 Ok(())
1821                         },
1822                         None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1823                 }
1824         }
1825
1826         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
1827                 let (mut dropped_htlcs, chan_option) = {
1828                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1829                         let channel_state = channel_state_lock.borrow_parts();
1830
1831                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1832                                 hash_map::Entry::Occupied(mut chan_entry) => {
1833                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1834                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1835                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1836                                         }
1837                                         let (shutdown, closing_signed, dropped_htlcs) = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1838                                         if let Some(msg) = shutdown {
1839                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1840                                                         node_id: their_node_id.clone(),
1841                                                         msg,
1842                                                 });
1843                                         }
1844                                         if let Some(msg) = closing_signed {
1845                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1846                                                         node_id: their_node_id.clone(),
1847                                                         msg,
1848                                                 });
1849                                         }
1850                                         if chan_entry.get().is_shutdown() {
1851                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1852                                                         channel_state.short_to_id.remove(&short_id);
1853                                                 }
1854                                                 (dropped_htlcs, Some(chan_entry.remove_entry().1))
1855                                         } else { (dropped_htlcs, None) }
1856                                 },
1857                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1858                         }
1859                 };
1860                 for htlc_source in dropped_htlcs.drain(..) {
1861                         // unknown_next_peer...I dunno who that is anymore....
1862                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1863                 }
1864                 if let Some(chan) = chan_option {
1865                         if let Ok(update) = self.get_channel_update(&chan) {
1866                                 let mut channel_state = self.channel_state.lock().unwrap();
1867                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1868                                         msg: update
1869                                 });
1870                         }
1871                 }
1872                 Ok(())
1873         }
1874
1875         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
1876                 let (tx, chan_option) = {
1877                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1878                         let channel_state = channel_state_lock.borrow_parts();
1879                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1880                                 hash_map::Entry::Occupied(mut chan_entry) => {
1881                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1882                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1883                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1884                                         }
1885                                         let (closing_signed, tx) = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1886                                         if let Some(msg) = closing_signed {
1887                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1888                                                         node_id: their_node_id.clone(),
1889                                                         msg,
1890                                                 });
1891                                         }
1892                                         if tx.is_some() {
1893                                                 // We're done with this channel, we've got a signed closing transaction and
1894                                                 // will send the closing_signed back to the remote peer upon return. This
1895                                                 // also implies there are no pending HTLCs left on the channel, so we can
1896                                                 // fully delete it from tracking (the channel monitor is still around to
1897                                                 // watch for old state broadcasts)!
1898                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1899                                                         channel_state.short_to_id.remove(&short_id);
1900                                                 }
1901                                                 (tx, Some(chan_entry.remove_entry().1))
1902                                         } else { (tx, None) }
1903                                 },
1904                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1905                         }
1906                 };
1907                 if let Some(broadcast_tx) = tx {
1908                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1909                 }
1910                 if let Some(chan) = chan_option {
1911                         if let Ok(update) = self.get_channel_update(&chan) {
1912                                 let mut channel_state = self.channel_state.lock().unwrap();
1913                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1914                                         msg: update
1915                                 });
1916                         }
1917                 }
1918                 Ok(())
1919         }
1920
1921         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
1922                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1923                 //determine the state of the payment based on our response/if we forward anything/the time
1924                 //we take to respond. We should take care to avoid allowing such an attack.
1925                 //
1926                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1927                 //us repeatedly garbled in different ways, and compare our error messages, which are
1928                 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1929                 //but we should prevent it anyway.
1930
1931                 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1932                 let channel_state = channel_state_lock.borrow_parts();
1933
1934                 match channel_state.by_id.get_mut(&msg.channel_id) {
1935                         Some(chan) => {
1936                                 if chan.get_their_node_id() != *their_node_id {
1937                                         //TODO: here MsgHandleErrInternal, #153 case
1938                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1939                                 }
1940                                 if !chan.is_usable() {
1941                                         // If the update_add is completely bogus, the call will Err and we will close,
1942                                         // but if we've sent a shutdown and they haven't acknowledged it yet, we just
1943                                         // want to reject the new HTLC and fail it backwards instead of forwarding.
1944                                         if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
1945                                                 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1946                                                         channel_id: msg.channel_id,
1947                                                         htlc_id: msg.htlc_id,
1948                                                         reason: ChannelManager::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &self.get_channel_update(chan).unwrap().encode_with_len()[..]),
1949                                                 }));
1950                                         }
1951                                 }
1952                                 chan.update_add_htlc(&msg, pending_forward_info).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1953                         },
1954                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1955                 }
1956         }
1957
1958         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
1959                 let mut channel_state = self.channel_state.lock().unwrap();
1960                 let htlc_source = match channel_state.by_id.get_mut(&msg.channel_id) {
1961                         Some(chan) => {
1962                                 if chan.get_their_node_id() != *their_node_id {
1963                                         //TODO: here and below MsgHandleErrInternal, #153 case
1964                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1965                                 }
1966                                 chan.update_fulfill_htlc(&msg)
1967                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?.clone()
1968                         },
1969                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1970                 };
1971                 self.claim_funds_internal(channel_state, htlc_source, msg.payment_preimage.clone());
1972                 Ok(())
1973         }
1974
1975         // Process failure we got back from upstream on a payment we sent. Returns update and a boolean
1976         // indicating that the payment itself failed
1977         fn process_onion_failure(&self, htlc_source: &HTLCSource, mut packet_decrypted: Vec<u8>) -> (Option<msgs::HTLCFailChannelUpdate>, bool) {
1978                 if let &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } = htlc_source {
1979                         macro_rules! onion_failure_log {
1980                                 ( $error_code_textual: expr, $error_code: expr, $reported_name: expr, $reported_value: expr ) => {
1981                                         log_trace!(self, "{}({:#x}) {}({})", $error_code_textual, $error_code, $reported_name, $reported_value);
1982                                 };
1983                                 ( $error_code_textual: expr, $error_code: expr ) => {
1984                                         log_trace!(self, "{}({})", $error_code_textual, $error_code);
1985                                 };
1986                         }
1987
1988                         const BADONION: u16 = 0x8000;
1989                         const PERM: u16 = 0x4000;
1990                         const UPDATE: u16 = 0x1000;
1991
1992                         let mut res = None;
1993                         let mut htlc_msat = *first_hop_htlc_msat;
1994
1995                         // Handle packed channel/node updates for passing back for the route handler
1996                         Self::construct_onion_keys_callback(&self.secp_ctx, route, session_priv, |shared_secret, _, _, route_hop| {
1997                                 if res.is_some() { return; }
1998
1999                                 let incoming_htlc_msat = htlc_msat;
2000                                 let amt_to_forward = htlc_msat - route_hop.fee_msat;
2001                                 htlc_msat = amt_to_forward;
2002
2003                                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret[..]);
2004
2005                                 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
2006                                 decryption_tmp.resize(packet_decrypted.len(), 0);
2007                                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
2008                                 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
2009                                 packet_decrypted = decryption_tmp;
2010
2011                                 let is_from_final_node = route.hops.last().unwrap().pubkey == route_hop.pubkey;
2012
2013                                 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
2014                                         let um = ChannelManager::gen_um_from_shared_secret(&shared_secret[..]);
2015                                         let mut hmac = Hmac::new(Sha256::new(), &um);
2016                                         hmac.input(&err_packet.encode()[32..]);
2017                                         let mut calc_tag = [0u8; 32];
2018                                         hmac.raw_result(&mut calc_tag);
2019
2020                                         if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
2021                                                 if err_packet.failuremsg.len() < 2 {
2022                                                         // Useless packet that we can't use but it passed HMAC, so it
2023                                                         // definitely came from the peer in question
2024                                                         res = Some((None, !is_from_final_node));
2025                                                 } else {
2026                                                         let error_code = byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]);
2027
2028                                                         match error_code & 0xff {
2029                                                                 1|2|3 => {
2030                                                                         // either from an intermediate or final node
2031                                                                         //   invalid_realm(PERM|1),
2032                                                                         //   temporary_node_failure(NODE|2)
2033                                                                         //   permanent_node_failure(PERM|NODE|2)
2034                                                                         //   required_node_feature_mssing(PERM|NODE|3)
2035                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2036                                                                                 node_id: route_hop.pubkey,
2037                                                                                 is_permanent: error_code & PERM == PERM,
2038                                                                         }), !(error_code & PERM == PERM && is_from_final_node)));
2039                                                                         // node returning invalid_realm is removed from network_map,
2040                                                                         // although NODE flag is not set, TODO: or remove channel only?
2041                                                                         // retry payment when removed node is not a final node
2042                                                                         return;
2043                                                                 },
2044                                                                 _ => {}
2045                                                         }
2046
2047                                                         if is_from_final_node {
2048                                                                 let payment_retryable = match error_code {
2049                                                                         c if c == PERM|15 => false, // unknown_payment_hash
2050                                                                         c if c == PERM|16 => false, // incorrect_payment_amount
2051                                                                         17 => true, // final_expiry_too_soon
2052                                                                         18 if err_packet.failuremsg.len() == 6 => { // final_incorrect_cltv_expiry
2053                                                                                 let _reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2054                                                                                 true
2055                                                                         },
2056                                                                         19 if err_packet.failuremsg.len() == 10 => { // final_incorrect_htlc_amount
2057                                                                                 let _reported_incoming_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2058                                                                                 true
2059                                                                         },
2060                                                                         _ => {
2061                                                                                 // A final node has sent us either an invalid code or an error_code that
2062                                                                                 // MUST be sent from the processing node, or the formmat of failuremsg
2063                                                                                 // does not coform to the spec.
2064                                                                                 // Remove it from the network map and don't may retry payment
2065                                                                                 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2066                                                                                         node_id: route_hop.pubkey,
2067                                                                                         is_permanent: true,
2068                                                                                 }), false));
2069                                                                                 return;
2070                                                                         }
2071                                                                 };
2072                                                                 res = Some((None, payment_retryable));
2073                                                                 return;
2074                                                         }
2075
2076                                                         // now, error_code should be only from the intermediate nodes
2077                                                         match error_code {
2078                                                                 _c if error_code & PERM == PERM => {
2079                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
2080                                                                                 short_channel_id: route_hop.short_channel_id,
2081                                                                                 is_permanent: true,
2082                                                                         }), false));
2083                                                                 },
2084                                                                 _c if error_code & UPDATE == UPDATE => {
2085                                                                         let offset = match error_code {
2086                                                                                 c if c == UPDATE|7  => 0, // temporary_channel_failure
2087                                                                                 c if c == UPDATE|11 => 8, // amount_below_minimum
2088                                                                                 c if c == UPDATE|12 => 8, // fee_insufficient
2089                                                                                 c if c == UPDATE|13 => 4, // incorrect_cltv_expiry
2090                                                                                 c if c == UPDATE|14 => 0, // expiry_too_soon
2091                                                                                 c if c == UPDATE|20 => 2, // channel_disabled
2092                                                                                 _ =>  {
2093                                                                                         // node sending unknown code
2094                                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2095                                                                                                 node_id: route_hop.pubkey,
2096                                                                                                 is_permanent: true,
2097                                                                                         }), false));
2098                                                                                         return;
2099                                                                                 }
2100                                                                         };
2101
2102                                                                         if err_packet.failuremsg.len() >= offset + 2 {
2103                                                                                 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[offset+2..offset+4]) as usize;
2104                                                                                 if err_packet.failuremsg.len() >= offset + 4 + update_len {
2105                                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&err_packet.failuremsg[offset + 4..offset + 4 + update_len])) {
2106                                                                                                 // if channel_update should NOT have caused the failure:
2107                                                                                                 // MAY treat the channel_update as invalid.
2108                                                                                                 let is_chan_update_invalid = match error_code {
2109                                                                                                         c if c == UPDATE|7 => { // temporary_channel_failure
2110                                                                                                                 false
2111                                                                                                         },
2112                                                                                                         c if c == UPDATE|11 => { // amount_below_minimum
2113                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2114                                                                                                                 onion_failure_log!("amount_below_minimum", UPDATE|11, "htlc_msat", reported_htlc_msat);
2115                                                                                                                 incoming_htlc_msat > chan_update.contents.htlc_minimum_msat
2116                                                                                                         },
2117                                                                                                         c if c == UPDATE|12 => { // fee_insufficient
2118                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2119                                                                                                                 let new_fee =  amt_to_forward.checked_mul(chan_update.contents.fee_proportional_millionths as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan_update.contents.fee_base_msat as u64) });
2120                                                                                                                 onion_failure_log!("fee_insufficient", UPDATE|12, "htlc_msat", reported_htlc_msat);
2121                                                                                                                 new_fee.is_none() || incoming_htlc_msat >= new_fee.unwrap() && incoming_htlc_msat >= amt_to_forward + new_fee.unwrap()
2122                                                                                                         }
2123                                                                                                         c if c == UPDATE|13 => { // incorrect_cltv_expiry
2124                                                                                                                 let reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2125                                                                                                                 onion_failure_log!("incorrect_cltv_expiry", UPDATE|13, "cltv_expiry", reported_cltv_expiry);
2126                                                                                                                 route_hop.cltv_expiry_delta as u16 >= chan_update.contents.cltv_expiry_delta
2127                                                                                                         },
2128                                                                                                         c if c == UPDATE|20 => { // channel_disabled
2129                                                                                                                 let reported_flags = byte_utils::slice_to_be16(&err_packet.failuremsg[2..2+2]);
2130                                                                                                                 onion_failure_log!("channel_disabled", UPDATE|20, "flags", reported_flags);
2131                                                                                                                 chan_update.contents.flags & 0x01 == 0x01
2132                                                                                                         },
2133                                                                                                         c if c == UPDATE|21 => true, // expiry_too_far
2134                                                                                                         _ => { unreachable!(); },
2135                                                                                                 };
2136
2137                                                                                                 let msg = if is_chan_update_invalid { None } else {
2138                                                                                                         Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
2139                                                                                                                 msg: chan_update,
2140                                                                                                         })
2141                                                                                                 };
2142                                                                                                 res = Some((msg, true));
2143                                                                                                 return;
2144                                                                                         }
2145                                                                                 }
2146                                                                         }
2147                                                                 },
2148                                                                 _c if error_code & BADONION == BADONION => {
2149                                                                         //TODO
2150                                                                 },
2151                                                                 14 => { // expiry_too_soon
2152                                                                         res = Some((None, true));
2153                                                                         return;
2154                                                                 }
2155                                                                 _ => {
2156                                                                         // node sending unknown code
2157                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2158                                                                                 node_id: route_hop.pubkey,
2159                                                                                 is_permanent: true,
2160                                                                         }), false));
2161                                                                         return;
2162                                                                 }
2163                                                         }
2164                                                 }
2165                                         }
2166                                 }
2167                         }).expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
2168                         res.unwrap_or((None, true))
2169                 } else { ((None, true)) }
2170         }
2171
2172         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2173                 let mut channel_state = self.channel_state.lock().unwrap();
2174                 match channel_state.by_id.get_mut(&msg.channel_id) {
2175                         Some(chan) => {
2176                                 if chan.get_their_node_id() != *their_node_id {
2177                                         //TODO: here and below MsgHandleErrInternal, #153 case
2178                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2179                                 }
2180                                 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
2181                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2182                         },
2183                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2184                 }?;
2185                 Ok(())
2186         }
2187
2188         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2189                 let mut channel_state = self.channel_state.lock().unwrap();
2190                 match channel_state.by_id.get_mut(&msg.channel_id) {
2191                         Some(chan) => {
2192                                 if chan.get_their_node_id() != *their_node_id {
2193                                         //TODO: here and below MsgHandleErrInternal, #153 case
2194                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2195                                 }
2196                                 if (msg.failure_code & 0x8000) == 0 {
2197                                         return Err(MsgHandleErrInternal::send_err_msg_close_chan("Got update_fail_malformed_htlc with BADONION not set", msg.channel_id));
2198                                 }
2199                                 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
2200                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2201                                 Ok(())
2202                         },
2203                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2204                 }
2205         }
2206
2207         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2208                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2209                 let channel_state = channel_state_lock.borrow_parts();
2210                 match channel_state.by_id.get_mut(&msg.channel_id) {
2211                         Some(chan) => {
2212                                 if chan.get_their_node_id() != *their_node_id {
2213                                         //TODO: here and below MsgHandleErrInternal, #153 case
2214                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2215                                 }
2216                                 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) = chan.commitment_signed(&msg, &*self.fee_estimator).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
2217                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2218                                         unimplemented!();
2219                                 }
2220                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2221                                         node_id: their_node_id.clone(),
2222                                         msg: revoke_and_ack,
2223                                 });
2224                                 if let Some(msg) = commitment_signed {
2225                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2226                                                 node_id: their_node_id.clone(),
2227                                                 updates: msgs::CommitmentUpdate {
2228                                                         update_add_htlcs: Vec::new(),
2229                                                         update_fulfill_htlcs: Vec::new(),
2230                                                         update_fail_htlcs: Vec::new(),
2231                                                         update_fail_malformed_htlcs: Vec::new(),
2232                                                         update_fee: None,
2233                                                         commitment_signed: msg,
2234                                                 },
2235                                         });
2236                                 }
2237                                 if let Some(msg) = closing_signed {
2238                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2239                                                 node_id: their_node_id.clone(),
2240                                                 msg,
2241                                         });
2242                                 }
2243                                 Ok(())
2244                         },
2245                         None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2246                 }
2247         }
2248
2249         #[inline]
2250         fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2251                 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2252                         let mut forward_event = None;
2253                         if !pending_forwards.is_empty() {
2254                                 let mut channel_state = self.channel_state.lock().unwrap();
2255                                 if channel_state.forward_htlcs.is_empty() {
2256                                         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));
2257                                         channel_state.next_forward = forward_event.unwrap();
2258                                 }
2259                                 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2260                                         match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2261                                                 hash_map::Entry::Occupied(mut entry) => {
2262                                                         entry.get_mut().push(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info });
2263                                                 },
2264                                                 hash_map::Entry::Vacant(entry) => {
2265                                                         entry.insert(vec!(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info }));
2266                                                 }
2267                                         }
2268                                 }
2269                         }
2270                         match forward_event {
2271                                 Some(time) => {
2272                                         let mut pending_events = self.pending_events.lock().unwrap();
2273                                         pending_events.push(events::Event::PendingHTLCsForwardable {
2274                                                 time_forwardable: time
2275                                         });
2276                                 }
2277                                 None => {},
2278                         }
2279                 }
2280         }
2281
2282         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2283                 let (pending_forwards, mut pending_failures, short_channel_id) = {
2284                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2285                         let channel_state = channel_state_lock.borrow_parts();
2286                         match channel_state.by_id.get_mut(&msg.channel_id) {
2287                                 Some(chan) => {
2288                                         if chan.get_their_node_id() != *their_node_id {
2289                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2290                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2291                                         }
2292                                         let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) = chan.revoke_and_ack(&msg, &*self.fee_estimator).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
2293                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2294                                                 unimplemented!();
2295                                         }
2296                                         if let Some(updates) = commitment_update {
2297                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2298                                                         node_id: their_node_id.clone(),
2299                                                         updates,
2300                                                 });
2301                                         }
2302                                         if let Some(msg) = closing_signed {
2303                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2304                                                         node_id: their_node_id.clone(),
2305                                                         msg,
2306                                                 });
2307                                         }
2308                                         (pending_forwards, pending_failures, chan.get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2309                                 },
2310                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2311                         }
2312                 };
2313                 for failure in pending_failures.drain(..) {
2314                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2315                 }
2316                 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2317
2318                 Ok(())
2319         }
2320
2321         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2322                 let mut channel_state = self.channel_state.lock().unwrap();
2323                 match channel_state.by_id.get_mut(&msg.channel_id) {
2324                         Some(chan) => {
2325                                 if chan.get_their_node_id() != *their_node_id {
2326                                         //TODO: here and below MsgHandleErrInternal, #153 case
2327                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2328                                 }
2329                                 chan.update_fee(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2330                         },
2331                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2332                 }
2333         }
2334
2335         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2336                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2337                 let channel_state = channel_state_lock.borrow_parts();
2338
2339                 match channel_state.by_id.get_mut(&msg.channel_id) {
2340                         Some(chan) => {
2341                                 if chan.get_their_node_id() != *their_node_id {
2342                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2343                                 }
2344                                 if !chan.is_usable() {
2345                                         return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
2346                                 }
2347
2348                                 let our_node_id = self.get_our_node_id();
2349                                 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())
2350                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2351
2352                                 let were_node_one = announcement.node_id_1 == our_node_id;
2353                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2354                                 let bad_sig_action = MsgHandleErrInternal::send_err_msg_close_chan("Bad announcement_signatures node_signature", msg.channel_id);
2355                                 secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }), bad_sig_action);
2356                                 secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }), bad_sig_action);
2357
2358                                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2359
2360                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2361                                         msg: msgs::ChannelAnnouncement {
2362                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2363                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2364                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2365                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2366                                                 contents: announcement,
2367                                         },
2368                                         update_msg: self.get_channel_update(chan).unwrap(), // can only fail if we're not in a ready state
2369                                 });
2370                         },
2371                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2372                 }
2373                 Ok(())
2374         }
2375
2376         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2377                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2378                 let channel_state = channel_state_lock.borrow_parts();
2379
2380                 match channel_state.by_id.get_mut(&msg.channel_id) {
2381                         Some(chan) => {
2382                                 if chan.get_their_node_id() != *their_node_id {
2383                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2384                                 }
2385                                 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, order, shutdown) = chan.channel_reestablish(msg)
2386                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2387                                 if let Some(monitor) = channel_monitor {
2388                                         if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2389                                                 unimplemented!();
2390                                         }
2391                                 }
2392                                 if let Some(msg) = funding_locked {
2393                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2394                                                 node_id: their_node_id.clone(),
2395                                                 msg
2396                                         });
2397                                 }
2398                                 macro_rules! send_raa { () => {
2399                                         if let Some(msg) = revoke_and_ack {
2400                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2401                                                         node_id: their_node_id.clone(),
2402                                                         msg
2403                                                 });
2404                                         }
2405                                 } }
2406                                 macro_rules! send_cu { () => {
2407                                         if let Some(updates) = commitment_update {
2408                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2409                                                         node_id: their_node_id.clone(),
2410                                                         updates
2411                                                 });
2412                                         }
2413                                 } }
2414                                 match order {
2415                                         RAACommitmentOrder::RevokeAndACKFirst => {
2416                                                 send_raa!();
2417                                                 send_cu!();
2418                                         },
2419                                         RAACommitmentOrder::CommitmentFirst => {
2420                                                 send_cu!();
2421                                                 send_raa!();
2422                                         },
2423                                 }
2424                                 if let Some(msg) = shutdown {
2425                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2426                                                 node_id: their_node_id.clone(),
2427                                                 msg,
2428                                         });
2429                                 }
2430                                 Ok(())
2431                         },
2432                         None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2433                 }
2434         }
2435
2436         /// Begin Update fee process. Allowed only on an outbound channel.
2437         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2438         /// PeerManager::process_events afterwards.
2439         /// Note: This API is likely to change!
2440         #[doc(hidden)]
2441         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2442                 let _ = self.total_consistency_lock.read().unwrap();
2443                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2444                 let channel_state = channel_state_lock.borrow_parts();
2445
2446                 match channel_state.by_id.get_mut(&channel_id) {
2447                         None => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2448                         Some(chan) => {
2449                                 if !chan.is_outbound() {
2450                                         return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2451                                 }
2452                                 if chan.is_awaiting_monitor_update() {
2453                                         return Err(APIError::MonitorUpdateFailed);
2454                                 }
2455                                 if !chan.is_live() {
2456                                         return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2457                                 }
2458                                 if let Some((update_fee, commitment_signed, chan_monitor)) = chan.send_update_fee_and_commit(feerate_per_kw).map_err(|e| APIError::APIMisuseError{err: e.err})? {
2459                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2460                                                 unimplemented!();
2461                                         }
2462                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2463                                                 node_id: chan.get_their_node_id(),
2464                                                 updates: msgs::CommitmentUpdate {
2465                                                         update_add_htlcs: Vec::new(),
2466                                                         update_fulfill_htlcs: Vec::new(),
2467                                                         update_fail_htlcs: Vec::new(),
2468                                                         update_fail_malformed_htlcs: Vec::new(),
2469                                                         update_fee: Some(update_fee),
2470                                                         commitment_signed,
2471                                                 },
2472                                         });
2473                                 }
2474                         },
2475                 }
2476                 Ok(())
2477         }
2478 }
2479
2480 impl events::MessageSendEventsProvider for ChannelManager {
2481         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2482                 let mut ret = Vec::new();
2483                 let mut channel_state = self.channel_state.lock().unwrap();
2484                 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2485                 ret
2486         }
2487 }
2488
2489 impl events::EventsProvider for ChannelManager {
2490         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2491                 let mut ret = Vec::new();
2492                 let mut pending_events = self.pending_events.lock().unwrap();
2493                 mem::swap(&mut ret, &mut *pending_events);
2494                 ret
2495         }
2496 }
2497
2498 impl ChainListener for ChannelManager {
2499         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2500                 let _ = self.total_consistency_lock.read().unwrap();
2501                 let mut failed_channels = Vec::new();
2502                 {
2503                         let mut channel_lock = self.channel_state.lock().unwrap();
2504                         let channel_state = channel_lock.borrow_parts();
2505                         let short_to_id = channel_state.short_to_id;
2506                         let pending_msg_events = channel_state.pending_msg_events;
2507                         channel_state.by_id.retain(|_, channel| {
2508                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2509                                 if let Ok(Some(funding_locked)) = chan_res {
2510                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2511                                                 node_id: channel.get_their_node_id(),
2512                                                 msg: funding_locked,
2513                                         });
2514                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2515                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2516                                                         node_id: channel.get_their_node_id(),
2517                                                         msg: announcement_sigs,
2518                                                 });
2519                                         }
2520                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2521                                 } else if let Err(e) = chan_res {
2522                                         pending_msg_events.push(events::MessageSendEvent::HandleError {
2523                                                 node_id: channel.get_their_node_id(),
2524                                                 action: e.action,
2525                                         });
2526                                         if channel.is_shutdown() {
2527                                                 return false;
2528                                         }
2529                                 }
2530                                 if let Some(funding_txo) = channel.get_funding_txo() {
2531                                         for tx in txn_matched {
2532                                                 for inp in tx.input.iter() {
2533                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2534                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2535                                                                         short_to_id.remove(&short_id);
2536                                                                 }
2537                                                                 // It looks like our counterparty went on-chain. We go ahead and
2538                                                                 // broadcast our latest local state as well here, just in case its
2539                                                                 // some kind of SPV attack, though we expect these to be dropped.
2540                                                                 failed_channels.push(channel.force_shutdown());
2541                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2542                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2543                                                                                 msg: update
2544                                                                         });
2545                                                                 }
2546                                                                 return false;
2547                                                         }
2548                                                 }
2549                                         }
2550                                 }
2551                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2552                                         if let Some(short_id) = channel.get_short_channel_id() {
2553                                                 short_to_id.remove(&short_id);
2554                                         }
2555                                         failed_channels.push(channel.force_shutdown());
2556                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2557                                         // the latest local tx for us, so we should skip that here (it doesn't really
2558                                         // hurt anything, but does make tests a bit simpler).
2559                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2560                                         if let Ok(update) = self.get_channel_update(&channel) {
2561                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2562                                                         msg: update
2563                                                 });
2564                                         }
2565                                         return false;
2566                                 }
2567                                 true
2568                         });
2569                 }
2570                 for failure in failed_channels.drain(..) {
2571                         self.finish_force_close_channel(failure);
2572                 }
2573                 self.latest_block_height.store(height as usize, Ordering::Release);
2574                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2575         }
2576
2577         /// We force-close the channel without letting our counterparty participate in the shutdown
2578         fn block_disconnected(&self, header: &BlockHeader) {
2579                 let _ = self.total_consistency_lock.read().unwrap();
2580                 let mut failed_channels = Vec::new();
2581                 {
2582                         let mut channel_lock = self.channel_state.lock().unwrap();
2583                         let channel_state = channel_lock.borrow_parts();
2584                         let short_to_id = channel_state.short_to_id;
2585                         let pending_msg_events = channel_state.pending_msg_events;
2586                         channel_state.by_id.retain(|_,  v| {
2587                                 if v.block_disconnected(header) {
2588                                         if let Some(short_id) = v.get_short_channel_id() {
2589                                                 short_to_id.remove(&short_id);
2590                                         }
2591                                         failed_channels.push(v.force_shutdown());
2592                                         if let Ok(update) = self.get_channel_update(&v) {
2593                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2594                                                         msg: update
2595                                                 });
2596                                         }
2597                                         false
2598                                 } else {
2599                                         true
2600                                 }
2601                         });
2602                 }
2603                 for failure in failed_channels.drain(..) {
2604                         self.finish_force_close_channel(failure);
2605                 }
2606                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2607                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2608         }
2609 }
2610
2611 macro_rules! handle_error {
2612         ($self: ident, $internal: expr, $their_node_id: expr) => {
2613                 match $internal {
2614                         Ok(msg) => Ok(msg),
2615                         Err(MsgHandleErrInternal { err, needs_channel_force_close }) => {
2616                                 if needs_channel_force_close {
2617                                         match &err.action {
2618                                                 &Some(msgs::ErrorAction::DisconnectPeer { msg: Some(ref msg) }) => {
2619                                                         if msg.channel_id == [0; 32] {
2620                                                                 $self.peer_disconnected(&$their_node_id, true);
2621                                                         } else {
2622                                                                 $self.force_close_channel(&msg.channel_id);
2623                                                         }
2624                                                 },
2625                                                 &Some(msgs::ErrorAction::DisconnectPeer { msg: None }) => {},
2626                                                 &Some(msgs::ErrorAction::IgnoreError) => {},
2627                                                 &Some(msgs::ErrorAction::SendErrorMessage { ref msg }) => {
2628                                                         if msg.channel_id == [0; 32] {
2629                                                                 $self.peer_disconnected(&$their_node_id, true);
2630                                                         } else {
2631                                                                 $self.force_close_channel(&msg.channel_id);
2632                                                         }
2633                                                 },
2634                                                 &None => {},
2635                                         }
2636                                 }
2637                                 Err(err)
2638                         },
2639                 }
2640         }
2641 }
2642
2643 impl ChannelMessageHandler for ChannelManager {
2644         //TODO: Handle errors and close channel (or so)
2645         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), HandleError> {
2646                 let _ = self.total_consistency_lock.read().unwrap();
2647                 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
2648         }
2649
2650         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2651                 let _ = self.total_consistency_lock.read().unwrap();
2652                 handle_error!(self, self.internal_accept_channel(their_node_id, msg), their_node_id)
2653         }
2654
2655         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), HandleError> {
2656                 let _ = self.total_consistency_lock.read().unwrap();
2657                 handle_error!(self, self.internal_funding_created(their_node_id, msg), their_node_id)
2658         }
2659
2660         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2661                 let _ = self.total_consistency_lock.read().unwrap();
2662                 handle_error!(self, self.internal_funding_signed(their_node_id, msg), their_node_id)
2663         }
2664
2665         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
2666                 let _ = self.total_consistency_lock.read().unwrap();
2667                 handle_error!(self, self.internal_funding_locked(their_node_id, msg), their_node_id)
2668         }
2669
2670         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), HandleError> {
2671                 let _ = self.total_consistency_lock.read().unwrap();
2672                 handle_error!(self, self.internal_shutdown(their_node_id, msg), their_node_id)
2673         }
2674
2675         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), HandleError> {
2676                 let _ = self.total_consistency_lock.read().unwrap();
2677                 handle_error!(self, self.internal_closing_signed(their_node_id, msg), their_node_id)
2678         }
2679
2680         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2681                 let _ = self.total_consistency_lock.read().unwrap();
2682                 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), their_node_id)
2683         }
2684
2685         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2686                 let _ = self.total_consistency_lock.read().unwrap();
2687                 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), their_node_id)
2688         }
2689
2690         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
2691                 let _ = self.total_consistency_lock.read().unwrap();
2692                 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), their_node_id)
2693         }
2694
2695         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2696                 let _ = self.total_consistency_lock.read().unwrap();
2697                 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), their_node_id)
2698         }
2699
2700         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), HandleError> {
2701                 let _ = self.total_consistency_lock.read().unwrap();
2702                 handle_error!(self, self.internal_commitment_signed(their_node_id, msg), their_node_id)
2703         }
2704
2705         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), HandleError> {
2706                 let _ = self.total_consistency_lock.read().unwrap();
2707                 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), their_node_id)
2708         }
2709
2710         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2711                 let _ = self.total_consistency_lock.read().unwrap();
2712                 handle_error!(self, self.internal_update_fee(their_node_id, msg), their_node_id)
2713         }
2714
2715         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2716                 let _ = self.total_consistency_lock.read().unwrap();
2717                 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2718         }
2719
2720         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), HandleError> {
2721                 let _ = self.total_consistency_lock.read().unwrap();
2722                 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), their_node_id)
2723         }
2724
2725         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2726                 let _ = self.total_consistency_lock.read().unwrap();
2727                 let mut failed_channels = Vec::new();
2728                 let mut failed_payments = Vec::new();
2729                 {
2730                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2731                         let channel_state = channel_state_lock.borrow_parts();
2732                         let short_to_id = channel_state.short_to_id;
2733                         let pending_msg_events = channel_state.pending_msg_events;
2734                         if no_connection_possible {
2735                                 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2736                                 channel_state.by_id.retain(|_, chan| {
2737                                         if chan.get_their_node_id() == *their_node_id {
2738                                                 if let Some(short_id) = chan.get_short_channel_id() {
2739                                                         short_to_id.remove(&short_id);
2740                                                 }
2741                                                 failed_channels.push(chan.force_shutdown());
2742                                                 if let Ok(update) = self.get_channel_update(&chan) {
2743                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2744                                                                 msg: update
2745                                                         });
2746                                                 }
2747                                                 false
2748                                         } else {
2749                                                 true
2750                                         }
2751                                 });
2752                         } else {
2753                                 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2754                                 channel_state.by_id.retain(|_, chan| {
2755                                         if chan.get_their_node_id() == *their_node_id {
2756                                                 //TODO: mark channel disabled (and maybe announce such after a timeout).
2757                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2758                                                 if !failed_adds.is_empty() {
2759                                                         let chan_update = self.get_channel_update(&chan).map(|u| u.encode_with_len()).unwrap(); // Cannot add/recv HTLCs before we have a short_id so unwrap is safe
2760                                                         failed_payments.push((chan_update, failed_adds));
2761                                                 }
2762                                                 if chan.is_shutdown() {
2763                                                         if let Some(short_id) = chan.get_short_channel_id() {
2764                                                                 short_to_id.remove(&short_id);
2765                                                         }
2766                                                         return false;
2767                                                 }
2768                                         }
2769                                         true
2770                                 })
2771                         }
2772                 }
2773                 for failure in failed_channels.drain(..) {
2774                         self.finish_force_close_channel(failure);
2775                 }
2776                 for (chan_update, mut htlc_sources) in failed_payments {
2777                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2778                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2779                         }
2780                 }
2781         }
2782
2783         fn peer_connected(&self, their_node_id: &PublicKey) {
2784                 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2785
2786                 let _ = self.total_consistency_lock.read().unwrap();
2787                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2788                 let channel_state = channel_state_lock.borrow_parts();
2789                 let pending_msg_events = channel_state.pending_msg_events;
2790                 channel_state.by_id.retain(|_, chan| {
2791                         if chan.get_their_node_id() == *their_node_id {
2792                                 if !chan.have_received_message() {
2793                                         // If we created this (outbound) channel while we were disconnected from the
2794                                         // peer we probably failed to send the open_channel message, which is now
2795                                         // lost. We can't have had anything pending related to this channel, so we just
2796                                         // drop it.
2797                                         false
2798                                 } else {
2799                                         pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2800                                                 node_id: chan.get_their_node_id(),
2801                                                 msg: chan.get_channel_reestablish(),
2802                                         });
2803                                         true
2804                                 }
2805                         } else { true }
2806                 });
2807                 //TODO: Also re-broadcast announcement_signatures
2808         }
2809
2810         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2811                 let _ = self.total_consistency_lock.read().unwrap();
2812
2813                 if msg.channel_id == [0; 32] {
2814                         for chan in self.list_channels() {
2815                                 if chan.remote_network_id == *their_node_id {
2816                                         self.force_close_channel(&chan.channel_id);
2817                                 }
2818                         }
2819                 } else {
2820                         self.force_close_channel(&msg.channel_id);
2821                 }
2822         }
2823 }
2824
2825 const SERIALIZATION_VERSION: u8 = 1;
2826 const MIN_SERIALIZATION_VERSION: u8 = 1;
2827
2828 impl Writeable for PendingForwardHTLCInfo {
2829         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2830                 if let &Some(ref onion) = &self.onion_packet {
2831                         1u8.write(writer)?;
2832                         onion.write(writer)?;
2833                 } else {
2834                         0u8.write(writer)?;
2835                 }
2836                 self.incoming_shared_secret.write(writer)?;
2837                 self.payment_hash.write(writer)?;
2838                 self.short_channel_id.write(writer)?;
2839                 self.amt_to_forward.write(writer)?;
2840                 self.outgoing_cltv_value.write(writer)?;
2841                 Ok(())
2842         }
2843 }
2844
2845 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
2846         fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
2847                 let onion_packet = match <u8 as Readable<R>>::read(reader)? {
2848                         0 => None,
2849                         1 => Some(msgs::OnionPacket::read(reader)?),
2850                         _ => return Err(DecodeError::InvalidValue),
2851                 };
2852                 Ok(PendingForwardHTLCInfo {
2853                         onion_packet,
2854                         incoming_shared_secret: Readable::read(reader)?,
2855                         payment_hash: Readable::read(reader)?,
2856                         short_channel_id: Readable::read(reader)?,
2857                         amt_to_forward: Readable::read(reader)?,
2858                         outgoing_cltv_value: Readable::read(reader)?,
2859                 })
2860         }
2861 }
2862
2863 impl Writeable for HTLCFailureMsg {
2864         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2865                 match self {
2866                         &HTLCFailureMsg::Relay(ref fail_msg) => {
2867                                 0u8.write(writer)?;
2868                                 fail_msg.write(writer)?;
2869                         },
2870                         &HTLCFailureMsg::Malformed(ref fail_msg) => {
2871                                 1u8.write(writer)?;
2872                                 fail_msg.write(writer)?;
2873                         }
2874                 }
2875                 Ok(())
2876         }
2877 }
2878
2879 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
2880         fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
2881                 match <u8 as Readable<R>>::read(reader)? {
2882                         0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
2883                         1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
2884                         _ => Err(DecodeError::InvalidValue),
2885                 }
2886         }
2887 }
2888
2889 impl Writeable for PendingHTLCStatus {
2890         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2891                 match self {
2892                         &PendingHTLCStatus::Forward(ref forward_info) => {
2893                                 0u8.write(writer)?;
2894                                 forward_info.write(writer)?;
2895                         },
2896                         &PendingHTLCStatus::Fail(ref fail_msg) => {
2897                                 1u8.write(writer)?;
2898                                 fail_msg.write(writer)?;
2899                         }
2900                 }
2901                 Ok(())
2902         }
2903 }
2904
2905 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
2906         fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
2907                 match <u8 as Readable<R>>::read(reader)? {
2908                         0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
2909                         1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
2910                         _ => Err(DecodeError::InvalidValue),
2911                 }
2912         }
2913 }
2914
2915 impl_writeable!(HTLCPreviousHopData, 0, {
2916         short_channel_id,
2917         htlc_id,
2918         incoming_packet_shared_secret
2919 });
2920
2921 impl Writeable for HTLCSource {
2922         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2923                 match self {
2924                         &HTLCSource::PreviousHopData(ref hop_data) => {
2925                                 0u8.write(writer)?;
2926                                 hop_data.write(writer)?;
2927                         },
2928                         &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
2929                                 1u8.write(writer)?;
2930                                 route.write(writer)?;
2931                                 session_priv.write(writer)?;
2932                                 first_hop_htlc_msat.write(writer)?;
2933                         }
2934                 }
2935                 Ok(())
2936         }
2937 }
2938
2939 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
2940         fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
2941                 match <u8 as Readable<R>>::read(reader)? {
2942                         0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
2943                         1 => Ok(HTLCSource::OutboundRoute {
2944                                 route: Readable::read(reader)?,
2945                                 session_priv: Readable::read(reader)?,
2946                                 first_hop_htlc_msat: Readable::read(reader)?,
2947                         }),
2948                         _ => Err(DecodeError::InvalidValue),
2949                 }
2950         }
2951 }
2952
2953 impl Writeable for HTLCFailReason {
2954         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2955                 match self {
2956                         &HTLCFailReason::ErrorPacket { ref err } => {
2957                                 0u8.write(writer)?;
2958                                 err.write(writer)?;
2959                         },
2960                         &HTLCFailReason::Reason { ref failure_code, ref data } => {
2961                                 1u8.write(writer)?;
2962                                 failure_code.write(writer)?;
2963                                 data.write(writer)?;
2964                         }
2965                 }
2966                 Ok(())
2967         }
2968 }
2969
2970 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
2971         fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
2972                 match <u8 as Readable<R>>::read(reader)? {
2973                         0 => Ok(HTLCFailReason::ErrorPacket { err: Readable::read(reader)? }),
2974                         1 => Ok(HTLCFailReason::Reason {
2975                                 failure_code: Readable::read(reader)?,
2976                                 data: Readable::read(reader)?,
2977                         }),
2978                         _ => Err(DecodeError::InvalidValue),
2979                 }
2980         }
2981 }
2982
2983 impl_writeable!(HTLCForwardInfo, 0, {
2984         prev_short_channel_id,
2985         prev_htlc_id,
2986         forward_info
2987 });
2988
2989 impl Writeable for ChannelManager {
2990         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2991                 let _ = self.total_consistency_lock.write().unwrap();
2992
2993                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
2994                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
2995
2996                 self.genesis_hash.write(writer)?;
2997                 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
2998                 self.last_block_hash.lock().unwrap().write(writer)?;
2999
3000                 let channel_state = self.channel_state.lock().unwrap();
3001                 let mut unfunded_channels = 0;
3002                 for (_, channel) in channel_state.by_id.iter() {
3003                         if !channel.is_funding_initiated() {
3004                                 unfunded_channels += 1;
3005                         }
3006                 }
3007                 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3008                 for (_, channel) in channel_state.by_id.iter() {
3009                         if channel.is_funding_initiated() {
3010                                 channel.write(writer)?;
3011                         }
3012                 }
3013
3014                 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3015                 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3016                         short_channel_id.write(writer)?;
3017                         (pending_forwards.len() as u64).write(writer)?;
3018                         for forward in pending_forwards {
3019                                 forward.write(writer)?;
3020                         }
3021                 }
3022
3023                 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3024                 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3025                         payment_hash.write(writer)?;
3026                         (previous_hops.len() as u64).write(writer)?;
3027                         for previous_hop in previous_hops {
3028                                 previous_hop.write(writer)?;
3029                         }
3030                 }
3031
3032                 Ok(())
3033         }
3034 }
3035
3036 /// Arguments for the creation of a ChannelManager that are not deserialized.
3037 ///
3038 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3039 /// is:
3040 /// 1) Deserialize all stored ChannelMonitors.
3041 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3042 ///    ChannelManager)>::read(reader, args).
3043 ///    This may result in closing some Channels if the ChannelMonitor is newer than the stored
3044 ///    ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3045 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3046 ///    ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3047 /// 4) Reconnect blocks on your ChannelMonitors.
3048 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3049 /// 6) Disconnect/connect blocks on the ChannelManager.
3050 /// 7) Register the new ChannelManager with your ChainWatchInterface (this does not happen
3051 ///    automatically as it does in ChannelManager::new()).
3052 pub struct ChannelManagerReadArgs<'a> {
3053         /// The keys provider which will give us relevant keys. Some keys will be loaded during
3054         /// deserialization.
3055         pub keys_manager: Arc<KeysInterface>,
3056
3057         /// The fee_estimator for use in the ChannelManager in the future.
3058         ///
3059         /// No calls to the FeeEstimator will be made during deserialization.
3060         pub fee_estimator: Arc<FeeEstimator>,
3061         /// The ManyChannelMonitor for use in the ChannelManager in the future.
3062         ///
3063         /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3064         /// you have deserialized ChannelMonitors separately and will add them to your
3065         /// ManyChannelMonitor after deserializing this ChannelManager.
3066         pub monitor: Arc<ManyChannelMonitor>,
3067         /// The ChainWatchInterface for use in the ChannelManager in the future.
3068         ///
3069         /// No calls to the ChainWatchInterface will be made during deserialization.
3070         pub chain_monitor: Arc<ChainWatchInterface>,
3071         /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3072         /// used to broadcast the latest local commitment transactions of channels which must be
3073         /// force-closed during deserialization.
3074         pub tx_broadcaster: Arc<BroadcasterInterface>,
3075         /// The Logger for use in the ChannelManager and which may be used to log information during
3076         /// deserialization.
3077         pub logger: Arc<Logger>,
3078         /// Default settings used for new channels. Any existing channels will continue to use the
3079         /// runtime settings which were stored when the ChannelManager was serialized.
3080         pub default_config: UserConfig,
3081
3082         /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3083         /// value.get_funding_txo() should be the key).
3084         ///
3085         /// If a monitor is inconsistent with the channel state during deserialization the channel will
3086         /// be force-closed using the data in the channelmonitor and the Channel will be dropped. This
3087         /// is true for missing channels as well. If there is a monitor missing for which we find
3088         /// channel data Err(DecodeError::InvalidValue) will be returned.
3089         ///
3090         /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3091         /// this struct.
3092         pub channel_monitors: &'a HashMap<OutPoint, &'a ChannelMonitor>,
3093 }
3094
3095 impl<'a, R : ::std::io::Read> ReadableArgs<R, ChannelManagerReadArgs<'a>> for (Sha256dHash, ChannelManager) {
3096         fn read(reader: &mut R, args: ChannelManagerReadArgs<'a>) -> Result<Self, DecodeError> {
3097                 let _ver: u8 = Readable::read(reader)?;
3098                 let min_ver: u8 = Readable::read(reader)?;
3099                 if min_ver > SERIALIZATION_VERSION {
3100                         return Err(DecodeError::UnknownVersion);
3101                 }
3102
3103                 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3104                 let latest_block_height: u32 = Readable::read(reader)?;
3105                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3106
3107                 let mut closed_channels = Vec::new();
3108
3109                 let channel_count: u64 = Readable::read(reader)?;
3110                 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3111                 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3112                 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3113                 for _ in 0..channel_count {
3114                         let mut channel: Channel = ReadableArgs::read(reader, args.logger.clone())?;
3115                         if channel.last_block_connected != last_block_hash {
3116                                 return Err(DecodeError::InvalidValue);
3117                         }
3118
3119                         let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3120                         funding_txo_set.insert(funding_txo.clone());
3121                         if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
3122                                 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3123                                                 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3124                                                 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3125                                         let mut force_close_res = channel.force_shutdown();
3126                                         force_close_res.0 = monitor.get_latest_local_commitment_txn();
3127                                         closed_channels.push(force_close_res);
3128                                 } else {
3129                                         if let Some(short_channel_id) = channel.get_short_channel_id() {
3130                                                 short_to_id.insert(short_channel_id, channel.channel_id());
3131                                         }
3132                                         by_id.insert(channel.channel_id(), channel);
3133                                 }
3134                         } else {
3135                                 return Err(DecodeError::InvalidValue);
3136                         }
3137                 }
3138
3139                 for (ref funding_txo, ref monitor) in args.channel_monitors.iter() {
3140                         if !funding_txo_set.contains(funding_txo) {
3141                                 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3142                         }
3143                 }
3144
3145                 let forward_htlcs_count: u64 = Readable::read(reader)?;
3146                 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3147                 for _ in 0..forward_htlcs_count {
3148                         let short_channel_id = Readable::read(reader)?;
3149                         let pending_forwards_count: u64 = Readable::read(reader)?;
3150                         let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3151                         for _ in 0..pending_forwards_count {
3152                                 pending_forwards.push(Readable::read(reader)?);
3153                         }
3154                         forward_htlcs.insert(short_channel_id, pending_forwards);
3155                 }
3156
3157                 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3158                 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3159                 for _ in 0..claimable_htlcs_count {
3160                         let payment_hash = Readable::read(reader)?;
3161                         let previous_hops_len: u64 = Readable::read(reader)?;
3162                         let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3163                         for _ in 0..previous_hops_len {
3164                                 previous_hops.push(Readable::read(reader)?);
3165                         }
3166                         claimable_htlcs.insert(payment_hash, previous_hops);
3167                 }
3168
3169                 let channel_manager = ChannelManager {
3170                         genesis_hash,
3171                         fee_estimator: args.fee_estimator,
3172                         monitor: args.monitor,
3173                         chain_monitor: args.chain_monitor,
3174                         tx_broadcaster: args.tx_broadcaster,
3175
3176                         latest_block_height: AtomicUsize::new(latest_block_height as usize),
3177                         last_block_hash: Mutex::new(last_block_hash),
3178                         secp_ctx: Secp256k1::new(),
3179
3180                         channel_state: Mutex::new(ChannelHolder {
3181                                 by_id,
3182                                 short_to_id,
3183                                 next_forward: Instant::now(),
3184                                 forward_htlcs,
3185                                 claimable_htlcs,
3186                                 pending_msg_events: Vec::new(),
3187                         }),
3188                         our_network_key: args.keys_manager.get_node_secret(),
3189
3190                         pending_events: Mutex::new(Vec::new()),
3191                         total_consistency_lock: RwLock::new(()),
3192                         keys_manager: args.keys_manager,
3193                         logger: args.logger,
3194                         default_configuration: args.default_config,
3195                 };
3196
3197                 for close_res in closed_channels.drain(..) {
3198                         channel_manager.finish_force_close_channel(close_res);
3199                         //TODO: Broadcast channel update for closed channels, but only after we've made a
3200                         //connection or two.
3201                 }
3202
3203                 Ok((last_block_hash.clone(), channel_manager))
3204         }
3205 }
3206
3207 #[cfg(test)]
3208 mod tests {
3209         use chain::chaininterface;
3210         use chain::transaction::OutPoint;
3211         use chain::chaininterface::{ChainListener, ChainWatchInterface};
3212         use chain::keysinterface::{KeysInterface, SpendableOutputDescriptor};
3213         use chain::keysinterface;
3214         use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
3215         use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,OnionKeys,PaymentFailReason,RAACommitmentOrder};
3216         use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS, ManyChannelMonitor};
3217         use ln::router::{Route, RouteHop, Router};
3218         use ln::msgs;
3219         use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
3220         use util::test_utils;
3221         use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
3222         use util::errors::APIError;
3223         use util::logger::Logger;
3224         use util::ser::{Writeable, Writer, ReadableArgs};
3225         use util::config::UserConfig;
3226
3227         use bitcoin::util::hash::{BitcoinHash, Sha256dHash};
3228         use bitcoin::util::bip143;
3229         use bitcoin::util::address::Address;
3230         use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
3231         use bitcoin::blockdata::block::{Block, BlockHeader};
3232         use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
3233         use bitcoin::blockdata::script::{Builder, Script};
3234         use bitcoin::blockdata::opcodes;
3235         use bitcoin::blockdata::constants::genesis_block;
3236         use bitcoin::network::constants::Network;
3237
3238         use hex;
3239
3240         use secp256k1::{Secp256k1, Message};
3241         use secp256k1::key::{PublicKey,SecretKey};
3242
3243         use crypto::sha2::Sha256;
3244         use crypto::digest::Digest;
3245
3246         use rand::{thread_rng,Rng};
3247
3248         use std::cell::RefCell;
3249         use std::collections::{BTreeSet, HashMap};
3250         use std::default::Default;
3251         use std::rc::Rc;
3252         use std::sync::{Arc, Mutex};
3253         use std::sync::atomic::Ordering;
3254         use std::time::Instant;
3255         use std::mem;
3256
3257         fn build_test_onion_keys() -> Vec<OnionKeys> {
3258                 // Keys from BOLT 4, used in both test vector tests
3259                 let secp_ctx = Secp256k1::new();
3260
3261                 let route = Route {
3262                         hops: vec!(
3263                                         RouteHop {
3264                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
3265                                                 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
3266                                         },
3267                                         RouteHop {
3268                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
3269                                                 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
3270                                         },
3271                                         RouteHop {
3272                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
3273                                                 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
3274                                         },
3275                                         RouteHop {
3276                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
3277                                                 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
3278                                         },
3279                                         RouteHop {
3280                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
3281                                                 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
3282                                         },
3283                         ),
3284                 };
3285
3286                 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
3287
3288                 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
3289                 assert_eq!(onion_keys.len(), route.hops.len());
3290                 onion_keys
3291         }
3292
3293         #[test]
3294         fn onion_vectors() {
3295                 // Packet creation test vectors from BOLT 4
3296                 let onion_keys = build_test_onion_keys();
3297
3298                 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
3299                 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
3300                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
3301                 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
3302                 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
3303
3304                 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
3305                 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
3306                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
3307                 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
3308                 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
3309
3310                 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
3311                 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
3312                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
3313                 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
3314                 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
3315
3316                 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
3317                 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
3318                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
3319                 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
3320                 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
3321
3322                 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
3323                 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
3324                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
3325                 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
3326                 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
3327
3328                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
3329                 let payloads = vec!(
3330                         msgs::OnionHopData {
3331                                 realm: 0,
3332                                 data: msgs::OnionRealm0HopData {
3333                                         short_channel_id: 0,
3334                                         amt_to_forward: 0,
3335                                         outgoing_cltv_value: 0,
3336                                 },
3337                                 hmac: [0; 32],
3338                         },
3339                         msgs::OnionHopData {
3340                                 realm: 0,
3341                                 data: msgs::OnionRealm0HopData {
3342                                         short_channel_id: 0x0101010101010101,
3343                                         amt_to_forward: 0x0100000001,
3344                                         outgoing_cltv_value: 0,
3345                                 },
3346                                 hmac: [0; 32],
3347                         },
3348                         msgs::OnionHopData {
3349                                 realm: 0,
3350                                 data: msgs::OnionRealm0HopData {
3351                                         short_channel_id: 0x0202020202020202,
3352                                         amt_to_forward: 0x0200000002,
3353                                         outgoing_cltv_value: 0,
3354                                 },
3355                                 hmac: [0; 32],
3356                         },
3357                         msgs::OnionHopData {
3358                                 realm: 0,
3359                                 data: msgs::OnionRealm0HopData {
3360                                         short_channel_id: 0x0303030303030303,
3361                                         amt_to_forward: 0x0300000003,
3362                                         outgoing_cltv_value: 0,
3363                                 },
3364                                 hmac: [0; 32],
3365                         },
3366                         msgs::OnionHopData {
3367                                 realm: 0,
3368                                 data: msgs::OnionRealm0HopData {
3369                                         short_channel_id: 0x0404040404040404,
3370                                         amt_to_forward: 0x0400000004,
3371                                         outgoing_cltv_value: 0,
3372                                 },
3373                                 hmac: [0; 32],
3374                         },
3375                 );
3376
3377                 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]);
3378                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
3379                 // anyway...
3380                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
3381         }
3382
3383         #[test]
3384         fn test_failure_packet_onion() {
3385                 // Returning Errors test vectors from BOLT 4
3386
3387                 let onion_keys = build_test_onion_keys();
3388                 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret[..], 0x2002, &[0; 0]);
3389                 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
3390
3391                 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret[..], &onion_error.encode()[..]);
3392                 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
3393
3394                 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret[..], &onion_packet_1.data[..]);
3395                 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
3396
3397                 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret[..], &onion_packet_2.data[..]);
3398                 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
3399
3400                 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret[..], &onion_packet_3.data[..]);
3401                 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
3402
3403                 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret[..], &onion_packet_4.data[..]);
3404                 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
3405         }
3406
3407         fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
3408                 assert!(chain.does_match_tx(tx));
3409                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3410                 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
3411                 for i in 2..100 {
3412                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3413                         chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
3414                 }
3415         }
3416
3417         struct Node {
3418                 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
3419                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
3420                 chan_monitor: Arc<test_utils::TestChannelMonitor>,
3421                 node: Arc<ChannelManager>,
3422                 router: Router,
3423                 node_seed: [u8; 32],
3424                 network_payment_count: Rc<RefCell<u8>>,
3425                 network_chan_count: Rc<RefCell<u32>>,
3426         }
3427         impl Drop for Node {
3428                 fn drop(&mut self) {
3429                         if !::std::thread::panicking() {
3430                                 // Check that we processed all pending events
3431                                 assert_eq!(self.node.get_and_clear_pending_msg_events().len(), 0);
3432                                 assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
3433                                 assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3434                         }
3435                 }
3436         }
3437
3438         fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3439                 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
3440         }
3441
3442         fn create_chan_between_nodes_with_value(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3443                 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
3444                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
3445                 (announcement, as_update, bs_update, channel_id, tx)
3446         }
3447
3448         macro_rules! get_revoke_commit_msgs {
3449                 ($node: expr, $node_id: expr) => {
3450                         {
3451                                 let events = $node.node.get_and_clear_pending_msg_events();
3452                                 assert_eq!(events.len(), 2);
3453                                 (match events[0] {
3454                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3455                                                 assert_eq!(*node_id, $node_id);
3456                                                 (*msg).clone()
3457                                         },
3458                                         _ => panic!("Unexpected event"),
3459                                 }, match events[1] {
3460                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3461                                                 assert_eq!(*node_id, $node_id);
3462                                                 assert!(updates.update_add_htlcs.is_empty());
3463                                                 assert!(updates.update_fulfill_htlcs.is_empty());
3464                                                 assert!(updates.update_fail_htlcs.is_empty());
3465                                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
3466                                                 assert!(updates.update_fee.is_none());
3467                                                 updates.commitment_signed.clone()
3468                                         },
3469                                         _ => panic!("Unexpected event"),
3470                                 })
3471                         }
3472                 }
3473         }
3474
3475         macro_rules! get_event_msg {
3476                 ($node: expr, $event_type: path, $node_id: expr) => {
3477                         {
3478                                 let events = $node.node.get_and_clear_pending_msg_events();
3479                                 assert_eq!(events.len(), 1);
3480                                 match events[0] {
3481                                         $event_type { ref node_id, ref msg } => {
3482                                                 assert_eq!(*node_id, $node_id);
3483                                                 (*msg).clone()
3484                                         },
3485                                         _ => panic!("Unexpected event"),
3486                                 }
3487                         }
3488                 }
3489         }
3490
3491         macro_rules! get_htlc_update_msgs {
3492                 ($node: expr, $node_id: expr) => {
3493                         {
3494                                 let events = $node.node.get_and_clear_pending_msg_events();
3495                                 assert_eq!(events.len(), 1);
3496                                 match events[0] {
3497                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3498                                                 assert_eq!(*node_id, $node_id);
3499                                                 (*updates).clone()
3500                                         },
3501                                         _ => panic!("Unexpected event"),
3502                                 }
3503                         }
3504                 }
3505         }
3506
3507         macro_rules! get_feerate {
3508                 ($node: expr, $channel_id: expr) => {
3509                         {
3510                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3511                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
3512                                 chan.get_feerate()
3513                         }
3514                 }
3515         }
3516
3517
3518         fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
3519                 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
3520                 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id())).unwrap();
3521                 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id())).unwrap();
3522
3523                 let chan_id = *node_a.network_chan_count.borrow();
3524                 let tx;
3525                 let funding_output;
3526
3527                 let events_2 = node_a.node.get_and_clear_pending_events();
3528                 assert_eq!(events_2.len(), 1);
3529                 match events_2[0] {
3530                         Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
3531                                 assert_eq!(*channel_value_satoshis, channel_value);
3532                                 assert_eq!(user_channel_id, 42);
3533
3534                                 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
3535                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3536                                 }]};
3537                                 funding_output = OutPoint::new(tx.txid(), 0);
3538
3539                                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
3540                                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3541                                 assert_eq!(added_monitors.len(), 1);
3542                                 assert_eq!(added_monitors[0].0, funding_output);
3543                                 added_monitors.clear();
3544                         },
3545                         _ => panic!("Unexpected event"),
3546                 }
3547
3548                 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id())).unwrap();
3549                 {
3550                         let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
3551                         assert_eq!(added_monitors.len(), 1);
3552                         assert_eq!(added_monitors[0].0, funding_output);
3553                         added_monitors.clear();
3554                 }
3555
3556                 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id())).unwrap();
3557                 {
3558                         let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3559                         assert_eq!(added_monitors.len(), 1);
3560                         assert_eq!(added_monitors[0].0, funding_output);
3561                         added_monitors.clear();
3562                 }
3563
3564                 let events_4 = node_a.node.get_and_clear_pending_events();
3565                 assert_eq!(events_4.len(), 1);
3566                 match events_4[0] {
3567                         Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
3568                                 assert_eq!(user_channel_id, 42);
3569                                 assert_eq!(*funding_txo, funding_output);
3570                         },
3571                         _ => panic!("Unexpected event"),
3572                 };
3573
3574                 tx
3575         }
3576
3577         fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
3578                 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
3579                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingLocked, node_a.node.get_our_node_id())).unwrap();
3580
3581                 let channel_id;
3582
3583                 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
3584                 let events_6 = node_a.node.get_and_clear_pending_msg_events();
3585                 assert_eq!(events_6.len(), 2);
3586                 ((match events_6[0] {
3587                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3588                                 channel_id = msg.channel_id.clone();
3589                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3590                                 msg.clone()
3591                         },
3592                         _ => panic!("Unexpected event"),
3593                 }, match events_6[1] {
3594                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3595                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3596                                 msg.clone()
3597                         },
3598                         _ => panic!("Unexpected event"),
3599                 }), channel_id)
3600         }
3601
3602         fn create_chan_between_nodes_with_value_a(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
3603                 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
3604                 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
3605                 (msgs, chan_id, tx)
3606         }
3607
3608         fn create_chan_between_nodes_with_value_b(node_a: &Node, node_b: &Node, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
3609                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap();
3610                 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
3611                 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
3612
3613                 let events_7 = node_b.node.get_and_clear_pending_msg_events();
3614                 assert_eq!(events_7.len(), 1);
3615                 let (announcement, bs_update) = match events_7[0] {
3616                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3617                                 (msg, update_msg)
3618                         },
3619                         _ => panic!("Unexpected event"),
3620                 };
3621
3622                 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
3623                 let events_8 = node_a.node.get_and_clear_pending_msg_events();
3624                 assert_eq!(events_8.len(), 1);
3625                 let as_update = match events_8[0] {
3626                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3627                                 assert!(*announcement == *msg);
3628                                 update_msg
3629                         },
3630                         _ => panic!("Unexpected event"),
3631                 };
3632
3633                 *node_a.network_chan_count.borrow_mut() += 1;
3634
3635                 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
3636         }
3637
3638         fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3639                 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
3640         }
3641
3642         fn create_announced_chan_between_nodes_with_value(nodes: &Vec<Node>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3643                 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
3644                 for node in nodes {
3645                         assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
3646                         node.router.handle_channel_update(&chan_announcement.1).unwrap();
3647                         node.router.handle_channel_update(&chan_announcement.2).unwrap();
3648                 }
3649                 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
3650         }
3651
3652         macro_rules! check_spends {
3653                 ($tx: expr, $spends_tx: expr) => {
3654                         {
3655                                 let mut funding_tx_map = HashMap::new();
3656                                 let spends_tx = $spends_tx;
3657                                 funding_tx_map.insert(spends_tx.txid(), spends_tx);
3658                                 $tx.verify(&funding_tx_map).unwrap();
3659                         }
3660                 }
3661         }
3662
3663         macro_rules! get_closing_signed_broadcast {
3664                 ($node: expr, $dest_pubkey: expr) => {
3665                         {
3666                                 let events = $node.get_and_clear_pending_msg_events();
3667                                 assert!(events.len() == 1 || events.len() == 2);
3668                                 (match events[events.len() - 1] {
3669                                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3670                                                 assert_eq!(msg.contents.flags & 2, 2);
3671                                                 msg.clone()
3672                                         },
3673                                         _ => panic!("Unexpected event"),
3674                                 }, if events.len() == 2 {
3675                                         match events[0] {
3676                                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3677                                                         assert_eq!(*node_id, $dest_pubkey);
3678                                                         Some(msg.clone())
3679                                                 },
3680                                                 _ => panic!("Unexpected event"),
3681                                         }
3682                                 } else { None })
3683                         }
3684                 }
3685         }
3686
3687         fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
3688                 let (node_a, broadcaster_a, struct_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) } else { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) };
3689                 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
3690                 let (tx_a, tx_b);
3691
3692                 node_a.close_channel(channel_id).unwrap();
3693                 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
3694
3695                 let events_1 = node_b.get_and_clear_pending_msg_events();
3696                 assert!(events_1.len() >= 1);
3697                 let shutdown_b = match events_1[0] {
3698                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
3699                                 assert_eq!(node_id, &node_a.get_our_node_id());
3700                                 msg.clone()
3701                         },
3702                         _ => panic!("Unexpected event"),
3703                 };
3704
3705                 let closing_signed_b = if !close_inbound_first {
3706                         assert_eq!(events_1.len(), 1);
3707                         None
3708                 } else {
3709                         Some(match events_1[1] {
3710                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3711                                         assert_eq!(node_id, &node_a.get_our_node_id());
3712                                         msg.clone()
3713                                 },
3714                                 _ => panic!("Unexpected event"),
3715                         })
3716                 };
3717
3718                 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
3719                 let (as_update, bs_update) = if close_inbound_first {
3720                         assert!(node_a.get_and_clear_pending_msg_events().is_empty());
3721                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3722                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3723                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3724                         let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3725
3726                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
3727                         let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3728                         assert!(none_b.is_none());
3729                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3730                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3731                         (as_update, bs_update)
3732                 } else {
3733                         let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
3734
3735                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
3736                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3737                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3738                         let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3739
3740                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3741                         let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3742                         assert!(none_a.is_none());
3743                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3744                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3745                         (as_update, bs_update)
3746                 };
3747                 assert_eq!(tx_a, tx_b);
3748                 check_spends!(tx_a, funding_tx);
3749
3750                 (as_update, bs_update, tx_a)
3751         }
3752
3753         struct SendEvent {
3754                 node_id: PublicKey,
3755                 msgs: Vec<msgs::UpdateAddHTLC>,
3756                 commitment_msg: msgs::CommitmentSigned,
3757         }
3758         impl SendEvent {
3759                 fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
3760                         assert!(updates.update_fulfill_htlcs.is_empty());
3761                         assert!(updates.update_fail_htlcs.is_empty());
3762                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3763                         assert!(updates.update_fee.is_none());
3764                         SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
3765                 }
3766
3767                 fn from_event(event: MessageSendEvent) -> SendEvent {
3768                         match event {
3769                                 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
3770                                 _ => panic!("Unexpected event type!"),
3771                         }
3772                 }
3773         }
3774
3775         macro_rules! check_added_monitors {
3776                 ($node: expr, $count: expr) => {
3777                         {
3778                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3779                                 assert_eq!(added_monitors.len(), $count);
3780                                 added_monitors.clear();
3781                         }
3782                 }
3783         }
3784
3785         macro_rules! commitment_signed_dance {
3786                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
3787                         {
3788                                 check_added_monitors!($node_a, 0);
3789                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3790                                 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3791                                 check_added_monitors!($node_a, 1);
3792                                 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
3793                         }
3794                 };
3795                 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
3796                         {
3797                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
3798                                 check_added_monitors!($node_b, 0);
3799                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3800                                 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3801                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3802                                 check_added_monitors!($node_b, 1);
3803                                 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
3804                                 let (bs_revoke_and_ack, extra_msg_option) = {
3805                                         let events = $node_b.node.get_and_clear_pending_msg_events();
3806                                         assert!(events.len() <= 2);
3807                                         (match events[0] {
3808                                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3809                                                         assert_eq!(*node_id, $node_a.node.get_our_node_id());
3810                                                         (*msg).clone()
3811                                                 },
3812                                                 _ => panic!("Unexpected event"),
3813                                         }, events.get(1).map(|e| e.clone()))
3814                                 };
3815                                 check_added_monitors!($node_b, 1);
3816                                 if $fail_backwards {
3817                                         assert!($node_a.node.get_and_clear_pending_events().is_empty());
3818                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3819                                 }
3820                                 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3821                                 {
3822                                         let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
3823                                         if $fail_backwards {
3824                                                 assert_eq!(added_monitors.len(), 2);
3825                                                 assert!(added_monitors[0].0 != added_monitors[1].0);
3826                                         } else {
3827                                                 assert_eq!(added_monitors.len(), 1);
3828                                         }
3829                                         added_monitors.clear();
3830                                 }
3831                                 extra_msg_option
3832                         }
3833                 };
3834                 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
3835                         {
3836                                 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
3837                         }
3838                 };
3839                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
3840                         {
3841                                 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
3842                                 if $fail_backwards {
3843                                         let channel_state = $node_a.node.channel_state.lock().unwrap();
3844                                         assert_eq!(channel_state.pending_msg_events.len(), 1);
3845                                         if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
3846                                                 assert_ne!(*node_id, $node_b.node.get_our_node_id());
3847                                         } else { panic!("Unexpected event"); }
3848                                 } else {
3849                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3850                                 }
3851                         }
3852                 }
3853         }
3854
3855         macro_rules! get_payment_preimage_hash {
3856                 ($node: expr) => {
3857                         {
3858                                 let payment_preimage = [*$node.network_payment_count.borrow(); 32];
3859                                 *$node.network_payment_count.borrow_mut() += 1;
3860                                 let mut payment_hash = [0; 32];
3861                                 let mut sha = Sha256::new();
3862                                 sha.input(&payment_preimage[..]);
3863                                 sha.result(&mut payment_hash);
3864                                 (payment_preimage, payment_hash)
3865                         }
3866                 }
3867         }
3868
3869         fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3870                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3871
3872                 let mut payment_event = {
3873                         origin_node.node.send_payment(route, our_payment_hash).unwrap();
3874                         check_added_monitors!(origin_node, 1);
3875
3876                         let mut events = origin_node.node.get_and_clear_pending_msg_events();
3877                         assert_eq!(events.len(), 1);
3878                         SendEvent::from_event(events.remove(0))
3879                 };
3880                 let mut prev_node = origin_node;
3881
3882                 for (idx, &node) in expected_route.iter().enumerate() {
3883                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
3884
3885                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3886                         check_added_monitors!(node, 0);
3887                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
3888
3889                         let events_1 = node.node.get_and_clear_pending_events();
3890                         assert_eq!(events_1.len(), 1);
3891                         match events_1[0] {
3892                                 Event::PendingHTLCsForwardable { .. } => { },
3893                                 _ => panic!("Unexpected event"),
3894                         };
3895
3896                         node.node.channel_state.lock().unwrap().next_forward = Instant::now();
3897                         node.node.process_pending_htlc_forwards();
3898
3899                         if idx == expected_route.len() - 1 {
3900                                 let events_2 = node.node.get_and_clear_pending_events();
3901                                 assert_eq!(events_2.len(), 1);
3902                                 match events_2[0] {
3903                                         Event::PaymentReceived { ref payment_hash, amt } => {
3904                                                 assert_eq!(our_payment_hash, *payment_hash);
3905                                                 assert_eq!(amt, recv_value);
3906                                         },
3907                                         _ => panic!("Unexpected event"),
3908                                 }
3909                         } else {
3910                                 let mut events_2 = node.node.get_and_clear_pending_msg_events();
3911                                 assert_eq!(events_2.len(), 1);
3912                                 check_added_monitors!(node, 1);
3913                                 payment_event = SendEvent::from_event(events_2.remove(0));
3914                                 assert_eq!(payment_event.msgs.len(), 1);
3915                         }
3916
3917                         prev_node = node;
3918                 }
3919
3920                 (our_payment_preimage, our_payment_hash)
3921         }
3922
3923         fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: [u8; 32]) {
3924                 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
3925                 check_added_monitors!(expected_route.last().unwrap(), 1);
3926
3927                 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
3928                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3929                 macro_rules! get_next_msgs {
3930                         ($node: expr) => {
3931                                 {
3932                                         let events = $node.node.get_and_clear_pending_msg_events();
3933                                         assert_eq!(events.len(), 1);
3934                                         match events[0] {
3935                                                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
3936                                                         assert!(update_add_htlcs.is_empty());
3937                                                         assert_eq!(update_fulfill_htlcs.len(), 1);
3938                                                         assert!(update_fail_htlcs.is_empty());
3939                                                         assert!(update_fail_malformed_htlcs.is_empty());
3940                                                         assert!(update_fee.is_none());
3941                                                         expected_next_node = node_id.clone();
3942                                                         Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
3943                                                 },
3944                                                 _ => panic!("Unexpected event"),
3945                                         }
3946                                 }
3947                         }
3948                 }
3949
3950                 macro_rules! last_update_fulfill_dance {
3951                         ($node: expr, $prev_node: expr) => {
3952                                 {
3953                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3954                                         check_added_monitors!($node, 0);
3955                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
3956                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3957                                 }
3958                         }
3959                 }
3960                 macro_rules! mid_update_fulfill_dance {
3961                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
3962                                 {
3963                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3964                                         check_added_monitors!($node, 1);
3965                                         let new_next_msgs = if $new_msgs {
3966                                                 get_next_msgs!($node)
3967                                         } else {
3968                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
3969                                                 None
3970                                         };
3971                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3972                                         next_msgs = new_next_msgs;
3973                                 }
3974                         }
3975                 }
3976
3977                 let mut prev_node = expected_route.last().unwrap();
3978                 for (idx, node) in expected_route.iter().rev().enumerate() {
3979                         assert_eq!(expected_next_node, node.node.get_our_node_id());
3980                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
3981                         if next_msgs.is_some() {
3982                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
3983                         } else if update_next_msgs {
3984                                 next_msgs = get_next_msgs!(node);
3985                         } else {
3986                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
3987                         }
3988                         if !skip_last && idx == expected_route.len() - 1 {
3989                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3990                         }
3991
3992                         prev_node = node;
3993                 }
3994
3995                 if !skip_last {
3996                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
3997                         let events = origin_node.node.get_and_clear_pending_events();
3998                         assert_eq!(events.len(), 1);
3999                         match events[0] {
4000                                 Event::PaymentSent { payment_preimage } => {
4001                                         assert_eq!(payment_preimage, our_payment_preimage);
4002                                 },
4003                                 _ => panic!("Unexpected event"),
4004                         }
4005                 }
4006         }
4007
4008         fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
4009                 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
4010         }
4011
4012         const TEST_FINAL_CLTV: u32 = 32;
4013
4014         fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
4015                 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();
4016                 assert_eq!(route.hops.len(), expected_route.len());
4017                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
4018                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
4019                 }
4020
4021                 send_along_route(origin_node, route, expected_route, recv_value)
4022         }
4023
4024         fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
4025                 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();
4026                 assert_eq!(route.hops.len(), expected_route.len());
4027                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
4028                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
4029                 }
4030
4031                 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
4032
4033                 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
4034                 match err {
4035                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
4036                         _ => panic!("Unknown error variants"),
4037                 };
4038         }
4039
4040         fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
4041                 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
4042                 claim_payment(&origin, expected_route, our_payment_preimage);
4043         }
4044
4045         fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: [u8; 32]) {
4046                 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, PaymentFailReason::PreimageUnknown));
4047                 check_added_monitors!(expected_route.last().unwrap(), 1);
4048
4049                 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
4050                 macro_rules! update_fail_dance {
4051                         ($node: expr, $prev_node: expr, $last_node: expr) => {
4052                                 {
4053                                         $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
4054                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
4055                                 }
4056                         }
4057                 }
4058
4059                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
4060                 let mut prev_node = expected_route.last().unwrap();
4061                 for (idx, node) in expected_route.iter().rev().enumerate() {
4062                         assert_eq!(expected_next_node, node.node.get_our_node_id());
4063                         if next_msgs.is_some() {
4064                                 // We may be the "last node" for the purpose of the commitment dance if we're
4065                                 // skipping the last node (implying it is disconnected) and we're the
4066                                 // second-to-last node!
4067                                 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
4068                         }
4069
4070                         let events = node.node.get_and_clear_pending_msg_events();
4071                         if !skip_last || idx != expected_route.len() - 1 {
4072                                 assert_eq!(events.len(), 1);
4073                                 match events[0] {
4074                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
4075                                                 assert!(update_add_htlcs.is_empty());
4076                                                 assert!(update_fulfill_htlcs.is_empty());
4077                                                 assert_eq!(update_fail_htlcs.len(), 1);
4078                                                 assert!(update_fail_malformed_htlcs.is_empty());
4079                                                 assert!(update_fee.is_none());
4080                                                 expected_next_node = node_id.clone();
4081                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
4082                                         },
4083                                         _ => panic!("Unexpected event"),
4084                                 }
4085                         } else {
4086                                 assert!(events.is_empty());
4087                         }
4088                         if !skip_last && idx == expected_route.len() - 1 {
4089                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
4090                         }
4091
4092                         prev_node = node;
4093                 }
4094
4095                 if !skip_last {
4096                         update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
4097
4098                         let events = origin_node.node.get_and_clear_pending_events();
4099                         assert_eq!(events.len(), 1);
4100                         match events[0] {
4101                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
4102                                         assert_eq!(payment_hash, our_payment_hash);
4103                                         assert!(rejected_by_dest);
4104                                 },
4105                                 _ => panic!("Unexpected event"),
4106                         }
4107                 }
4108         }
4109
4110         fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
4111                 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
4112         }
4113
4114         fn create_network(node_count: usize) -> Vec<Node> {
4115                 let mut nodes = Vec::new();
4116                 let mut rng = thread_rng();
4117                 let secp_ctx = Secp256k1::new();
4118                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4119
4120                 let chan_count = Rc::new(RefCell::new(0));
4121                 let payment_count = Rc::new(RefCell::new(0));
4122
4123                 for _ in 0..node_count {
4124                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
4125                         let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
4126                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
4127                         let mut seed = [0; 32];
4128                         rng.fill_bytes(&mut seed);
4129                         let keys_manager = Arc::new(keysinterface::KeysManager::new(&seed, Network::Testnet, Arc::clone(&logger)));
4130                         let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone()));
4131                         let mut config = UserConfig::new();
4132                         config.channel_options.announced_channel = true;
4133                         config.channel_limits.force_announced_channel_preference = false;
4134                         let node = ChannelManager::new(Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger), keys_manager.clone(), config).unwrap();
4135                         let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
4136                         nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, node_seed: seed,
4137                                 network_payment_count: payment_count.clone(),
4138                                 network_chan_count: chan_count.clone(),
4139                         });
4140                 }
4141
4142                 nodes
4143         }
4144
4145         #[test]
4146         fn test_async_inbound_update_fee() {
4147                 let mut nodes = create_network(2);
4148                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4149                 let channel_id = chan.2;
4150
4151                 // balancing
4152                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4153
4154                 // A                                        B
4155                 // update_fee                            ->
4156                 // send (1) commitment_signed            -.
4157                 //                                       <- update_add_htlc/commitment_signed
4158                 // send (2) RAA (awaiting remote revoke) -.
4159                 // (1) commitment_signed is delivered    ->
4160                 //                                       .- send (3) RAA (awaiting remote revoke)
4161                 // (2) RAA is delivered                  ->
4162                 //                                       .- send (4) commitment_signed
4163                 //                                       <- (3) RAA is delivered
4164                 // send (5) commitment_signed            -.
4165                 //                                       <- (4) commitment_signed is delivered
4166                 // send (6) RAA                          -.
4167                 // (5) commitment_signed is delivered    ->
4168                 //                                       <- RAA
4169                 // (6) RAA is delivered                  ->
4170
4171                 // First nodes[0] generates an update_fee
4172                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
4173                 check_added_monitors!(nodes[0], 1);
4174
4175                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4176                 assert_eq!(events_0.len(), 1);
4177                 let (update_msg, commitment_signed) = match events_0[0] { // (1)
4178                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4179                                 (update_fee.as_ref(), commitment_signed)
4180                         },
4181                         _ => panic!("Unexpected event"),
4182                 };
4183
4184                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4185
4186                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4187                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4188                 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
4189                 check_added_monitors!(nodes[1], 1);
4190
4191                 let payment_event = {
4192                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4193                         assert_eq!(events_1.len(), 1);
4194                         SendEvent::from_event(events_1.remove(0))
4195                 };
4196                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4197                 assert_eq!(payment_event.msgs.len(), 1);
4198
4199                 // ...now when the messages get delivered everyone should be happy
4200                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4201                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4202                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4203                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4204                 check_added_monitors!(nodes[0], 1);
4205
4206                 // deliver(1), generate (3):
4207                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4208                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4209                 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
4210                 check_added_monitors!(nodes[1], 1);
4211
4212                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
4213                 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4214                 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
4215                 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
4216                 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
4217                 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
4218                 assert!(bs_update.update_fee.is_none()); // (4)
4219                 check_added_monitors!(nodes[1], 1);
4220
4221                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
4222                 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4223                 assert!(as_update.update_add_htlcs.is_empty()); // (5)
4224                 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
4225                 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
4226                 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
4227                 assert!(as_update.update_fee.is_none()); // (5)
4228                 check_added_monitors!(nodes[0], 1);
4229
4230                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
4231                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4232                 // only (6) so get_event_msg's assert(len == 1) passes
4233                 check_added_monitors!(nodes[0], 1);
4234
4235                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
4236                 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4237                 check_added_monitors!(nodes[1], 1);
4238
4239                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4240                 check_added_monitors!(nodes[0], 1);
4241
4242                 let events_2 = nodes[0].node.get_and_clear_pending_events();
4243                 assert_eq!(events_2.len(), 1);
4244                 match events_2[0] {
4245                         Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
4246                         _ => panic!("Unexpected event"),
4247                 }
4248
4249                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
4250                 check_added_monitors!(nodes[1], 1);
4251         }
4252
4253         #[test]
4254         fn test_update_fee_unordered_raa() {
4255                 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
4256                 // crash in an earlier version of the update_fee patch)
4257                 let mut nodes = create_network(2);
4258                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4259                 let channel_id = chan.2;
4260
4261                 // balancing
4262                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4263
4264                 // First nodes[0] generates an update_fee
4265                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
4266                 check_added_monitors!(nodes[0], 1);
4267
4268                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4269                 assert_eq!(events_0.len(), 1);
4270                 let update_msg = match events_0[0] { // (1)
4271                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
4272                                 update_fee.as_ref()
4273                         },
4274                         _ => panic!("Unexpected event"),
4275                 };
4276
4277                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4278
4279                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4280                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4281                 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
4282                 check_added_monitors!(nodes[1], 1);
4283
4284                 let payment_event = {
4285                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4286                         assert_eq!(events_1.len(), 1);
4287                         SendEvent::from_event(events_1.remove(0))
4288                 };
4289                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4290                 assert_eq!(payment_event.msgs.len(), 1);
4291
4292                 // ...now when the messages get delivered everyone should be happy
4293                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4294                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4295                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4296                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4297                 check_added_monitors!(nodes[0], 1);
4298
4299                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
4300                 check_added_monitors!(nodes[1], 1);
4301
4302                 // We can't continue, sadly, because our (1) now has a bogus signature
4303         }
4304
4305         #[test]
4306         fn test_multi_flight_update_fee() {
4307                 let nodes = create_network(2);
4308                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4309                 let channel_id = chan.2;
4310
4311                 // A                                        B
4312                 // update_fee/commitment_signed          ->
4313                 //                                       .- send (1) RAA and (2) commitment_signed
4314                 // update_fee (never committed)          ->
4315                 // (3) update_fee                        ->
4316                 // We have to manually generate the above update_fee, it is allowed by the protocol but we
4317                 // don't track which updates correspond to which revoke_and_ack responses so we're in
4318                 // AwaitingRAA mode and will not generate the update_fee yet.
4319                 //                                       <- (1) RAA delivered
4320                 // (3) is generated and send (4) CS      -.
4321                 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
4322                 // know the per_commitment_point to use for it.
4323                 //                                       <- (2) commitment_signed delivered
4324                 // revoke_and_ack                        ->
4325                 //                                          B should send no response here
4326                 // (4) commitment_signed delivered       ->
4327                 //                                       <- RAA/commitment_signed delivered
4328                 // revoke_and_ack                        ->
4329
4330                 // First nodes[0] generates an update_fee
4331                 let initial_feerate = get_feerate!(nodes[0], channel_id);
4332                 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
4333                 check_added_monitors!(nodes[0], 1);
4334
4335                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4336                 assert_eq!(events_0.len(), 1);
4337                 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
4338                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4339                                 (update_fee.as_ref().unwrap(), commitment_signed)
4340                         },
4341                         _ => panic!("Unexpected event"),
4342                 };
4343
4344                 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
4345                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
4346                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
4347                 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4348                 check_added_monitors!(nodes[1], 1);
4349
4350                 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
4351                 // transaction:
4352                 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
4353                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4354                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4355
4356                 // Create the (3) update_fee message that nodes[0] will generate before it does...
4357                 let mut update_msg_2 = msgs::UpdateFee {
4358                         channel_id: update_msg_1.channel_id.clone(),
4359                         feerate_per_kw: (initial_feerate + 30) as u32,
4360                 };
4361
4362                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4363
4364                 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
4365                 // Deliver (3)
4366                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4367
4368                 // Deliver (1), generating (3) and (4)
4369                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
4370                 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4371                 check_added_monitors!(nodes[0], 1);
4372                 assert!(as_second_update.update_add_htlcs.is_empty());
4373                 assert!(as_second_update.update_fulfill_htlcs.is_empty());
4374                 assert!(as_second_update.update_fail_htlcs.is_empty());
4375                 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
4376                 // Check that the update_fee newly generated matches what we delivered:
4377                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
4378                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
4379
4380                 // Deliver (2) commitment_signed
4381                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
4382                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4383                 check_added_monitors!(nodes[0], 1);
4384                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4385
4386                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
4387                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4388                 check_added_monitors!(nodes[1], 1);
4389
4390                 // Delever (4)
4391                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
4392                 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4393                 check_added_monitors!(nodes[1], 1);
4394
4395                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4396                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4397                 check_added_monitors!(nodes[0], 1);
4398
4399                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
4400                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4401                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4402                 check_added_monitors!(nodes[0], 1);
4403
4404                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
4405                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4406                 check_added_monitors!(nodes[1], 1);
4407         }
4408
4409         #[test]
4410         fn test_update_fee_vanilla() {
4411                 let nodes = create_network(2);
4412                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4413                 let channel_id = chan.2;
4414
4415                 let feerate = get_feerate!(nodes[0], channel_id);
4416                 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
4417                 check_added_monitors!(nodes[0], 1);
4418
4419                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4420                 assert_eq!(events_0.len(), 1);
4421                 let (update_msg, commitment_signed) = match events_0[0] {
4422                                 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
4423                                 (update_fee.as_ref(), commitment_signed)
4424                         },
4425                         _ => panic!("Unexpected event"),
4426                 };
4427                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4428
4429                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4430                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4431                 check_added_monitors!(nodes[1], 1);
4432
4433                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4434                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4435                 check_added_monitors!(nodes[0], 1);
4436
4437                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4438                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4439                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4440                 check_added_monitors!(nodes[0], 1);
4441
4442                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4443                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4444                 check_added_monitors!(nodes[1], 1);
4445         }
4446
4447         #[test]
4448         fn test_update_fee_that_funder_cannot_afford() {
4449                 let mut nodes = create_network(2);
4450                 let channel_value = 1888;
4451                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000);
4452                 let channel_id = chan.2;
4453
4454                 let feerate = 260;
4455                 nodes[0].node.update_fee(channel_id, feerate).unwrap();
4456                 check_added_monitors!(nodes[0], 1);
4457                 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4458
4459                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
4460
4461                 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
4462
4463                 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
4464                 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
4465                 {
4466                         let chan_lock = nodes[1].node.channel_state.lock().unwrap();
4467                         let chan = chan_lock.by_id.get(&channel_id).unwrap();
4468
4469                         //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
4470                         let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
4471                         let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
4472                         let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
4473                         actual_fee = channel_value - actual_fee;
4474                         assert_eq!(total_fee, actual_fee);
4475                 } //drop the mutex
4476
4477                 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
4478                 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
4479                 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
4480                 check_added_monitors!(nodes[0], 1);
4481
4482                 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4483
4484                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
4485
4486                 //While producing the commitment_signed response after handling a received update_fee request the
4487                 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
4488                 //Should produce and error.
4489                 let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
4490
4491                 assert!(match err.err {
4492                         "Funding remote cannot afford proposed new fee" => true,
4493                         _ => false,
4494                 });
4495
4496                 //clear the message we could not handle
4497                 nodes[1].node.get_and_clear_pending_msg_events();
4498         }
4499
4500         #[test]
4501         fn test_update_fee_with_fundee_update_add_htlc() {
4502                 let mut nodes = create_network(2);
4503                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4504                 let channel_id = chan.2;
4505
4506                 // balancing
4507                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4508
4509                 let feerate = get_feerate!(nodes[0], channel_id);
4510                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4511                 check_added_monitors!(nodes[0], 1);
4512
4513                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4514                 assert_eq!(events_0.len(), 1);
4515                 let (update_msg, commitment_signed) = match events_0[0] {
4516                                 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
4517                                 (update_fee.as_ref(), commitment_signed)
4518                         },
4519                         _ => panic!("Unexpected event"),
4520                 };
4521                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4522                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4523                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4524                 check_added_monitors!(nodes[1], 1);
4525
4526                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
4527
4528                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
4529
4530                 // nothing happens since node[1] is in AwaitingRemoteRevoke
4531                 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
4532                 {
4533                         let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
4534                         assert_eq!(added_monitors.len(), 0);
4535                         added_monitors.clear();
4536                 }
4537                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4538                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4539                 // node[1] has nothing to do
4540
4541                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4542                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4543                 check_added_monitors!(nodes[0], 1);
4544
4545                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4546                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4547                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4548                 check_added_monitors!(nodes[0], 1);
4549                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4550                 check_added_monitors!(nodes[1], 1);
4551                 // AwaitingRemoteRevoke ends here
4552
4553                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4554                 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
4555                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
4556                 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
4557                 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
4558                 assert_eq!(commitment_update.update_fee.is_none(), true);
4559
4560                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
4561                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4562                 check_added_monitors!(nodes[0], 1);
4563                 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4564
4565                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
4566                 check_added_monitors!(nodes[1], 1);
4567                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4568
4569                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
4570                 check_added_monitors!(nodes[1], 1);
4571                 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4572                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4573
4574                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
4575                 check_added_monitors!(nodes[0], 1);
4576                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4577
4578                 let events = nodes[0].node.get_and_clear_pending_events();
4579                 assert_eq!(events.len(), 1);
4580                 match events[0] {
4581                         Event::PendingHTLCsForwardable { .. } => { },
4582                         _ => panic!("Unexpected event"),
4583                 };
4584                 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
4585                 nodes[0].node.process_pending_htlc_forwards();
4586
4587                 let events = nodes[0].node.get_and_clear_pending_events();
4588                 assert_eq!(events.len(), 1);
4589                 match events[0] {
4590                         Event::PaymentReceived { .. } => { },
4591                         _ => panic!("Unexpected event"),
4592                 };
4593
4594                 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
4595
4596                 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
4597                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
4598                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4599         }
4600
4601         #[test]
4602         fn test_update_fee() {
4603                 let nodes = create_network(2);
4604                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4605                 let channel_id = chan.2;
4606
4607                 // A                                        B
4608                 // (1) update_fee/commitment_signed      ->
4609                 //                                       <- (2) revoke_and_ack
4610                 //                                       .- send (3) commitment_signed
4611                 // (4) update_fee/commitment_signed      ->
4612                 //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
4613                 //                                       <- (3) commitment_signed delivered
4614                 // send (6) revoke_and_ack               -.
4615                 //                                       <- (5) deliver revoke_and_ack
4616                 // (6) deliver revoke_and_ack            ->
4617                 //                                       .- send (7) commitment_signed in response to (4)
4618                 //                                       <- (7) deliver commitment_signed
4619                 // revoke_and_ack                        ->
4620
4621                 // Create and deliver (1)...
4622                 let feerate = get_feerate!(nodes[0], channel_id);
4623                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4624                 check_added_monitors!(nodes[0], 1);
4625
4626                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4627                 assert_eq!(events_0.len(), 1);
4628                 let (update_msg, commitment_signed) = match events_0[0] {
4629                                 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
4630                                 (update_fee.as_ref(), commitment_signed)
4631                         },
4632                         _ => panic!("Unexpected event"),
4633                 };
4634                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4635
4636                 // Generate (2) and (3):
4637                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4638                 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4639                 check_added_monitors!(nodes[1], 1);
4640
4641                 // Deliver (2):
4642                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4643                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4644                 check_added_monitors!(nodes[0], 1);
4645
4646                 // Create and deliver (4)...
4647                 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
4648                 check_added_monitors!(nodes[0], 1);
4649                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4650                 assert_eq!(events_0.len(), 1);
4651                 let (update_msg, commitment_signed) = match events_0[0] {
4652                                 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
4653                                 (update_fee.as_ref(), commitment_signed)
4654                         },
4655                         _ => panic!("Unexpected event"),
4656                 };
4657
4658                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4659                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4660                 check_added_monitors!(nodes[1], 1);
4661                 // ... creating (5)
4662                 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4663                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4664
4665                 // Handle (3), creating (6):
4666                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
4667                 check_added_monitors!(nodes[0], 1);
4668                 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4669                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4670
4671                 // Deliver (5):
4672                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4673                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4674                 check_added_monitors!(nodes[0], 1);
4675
4676                 // Deliver (6), creating (7):
4677                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
4678                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4679                 assert!(commitment_update.update_add_htlcs.is_empty());
4680                 assert!(commitment_update.update_fulfill_htlcs.is_empty());
4681                 assert!(commitment_update.update_fail_htlcs.is_empty());
4682                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4683                 assert!(commitment_update.update_fee.is_none());
4684                 check_added_monitors!(nodes[1], 1);
4685
4686                 // Deliver (7)
4687                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4688                 check_added_monitors!(nodes[0], 1);
4689                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4690                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4691
4692                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4693                 check_added_monitors!(nodes[1], 1);
4694                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4695
4696                 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
4697                 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
4698                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4699         }
4700
4701         #[test]
4702         fn pre_funding_lock_shutdown_test() {
4703                 // Test sending a shutdown prior to funding_locked after funding generation
4704                 let nodes = create_network(2);
4705                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
4706                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4707                 nodes[0].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
4708                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
4709
4710                 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
4711                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4712                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4713                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4714                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4715
4716                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4717                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4718                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4719                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4720                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4721                 assert!(node_0_none.is_none());
4722
4723                 assert!(nodes[0].node.list_channels().is_empty());
4724                 assert!(nodes[1].node.list_channels().is_empty());
4725         }
4726
4727         #[test]
4728         fn updates_shutdown_wait() {
4729                 // Test sending a shutdown with outstanding updates pending
4730                 let mut nodes = create_network(3);
4731                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4732                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4733                 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4734                 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4735
4736                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
4737
4738                 nodes[0].node.close_channel(&chan_1.2).unwrap();
4739                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4740                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4741                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4742                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4743
4744                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4745                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4746
4747                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4748                 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
4749                 else { panic!("New sends should fail!") };
4750                 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
4751                 else { panic!("New sends should fail!") };
4752
4753                 assert!(nodes[2].node.claim_funds(our_payment_preimage));
4754                 check_added_monitors!(nodes[2], 1);
4755                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4756                 assert!(updates.update_add_htlcs.is_empty());
4757                 assert!(updates.update_fail_htlcs.is_empty());
4758                 assert!(updates.update_fail_malformed_htlcs.is_empty());
4759                 assert!(updates.update_fee.is_none());
4760                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4761                 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4762                 check_added_monitors!(nodes[1], 1);
4763                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4764                 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4765
4766                 assert!(updates_2.update_add_htlcs.is_empty());
4767                 assert!(updates_2.update_fail_htlcs.is_empty());
4768                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4769                 assert!(updates_2.update_fee.is_none());
4770                 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
4771                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
4772                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
4773
4774                 let events = nodes[0].node.get_and_clear_pending_events();
4775                 assert_eq!(events.len(), 1);
4776                 match events[0] {
4777                         Event::PaymentSent { ref payment_preimage } => {
4778                                 assert_eq!(our_payment_preimage, *payment_preimage);
4779                         },
4780                         _ => panic!("Unexpected event"),
4781                 }
4782
4783                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4784                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4785                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4786                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4787                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4788                 assert!(node_0_none.is_none());
4789
4790                 assert!(nodes[0].node.list_channels().is_empty());
4791
4792                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4793                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
4794                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
4795                 assert!(nodes[1].node.list_channels().is_empty());
4796                 assert!(nodes[2].node.list_channels().is_empty());
4797         }
4798
4799         #[test]
4800         fn htlc_fail_async_shutdown() {
4801                 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
4802                 let mut nodes = create_network(3);
4803                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4804                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4805
4806                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4807                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4808                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4809                 check_added_monitors!(nodes[0], 1);
4810                 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4811                 assert_eq!(updates.update_add_htlcs.len(), 1);
4812                 assert!(updates.update_fulfill_htlcs.is_empty());
4813                 assert!(updates.update_fail_htlcs.is_empty());
4814                 assert!(updates.update_fail_malformed_htlcs.is_empty());
4815                 assert!(updates.update_fee.is_none());
4816
4817                 nodes[1].node.close_channel(&chan_1.2).unwrap();
4818                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4819                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4820                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4821
4822                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
4823                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
4824                 check_added_monitors!(nodes[1], 1);
4825                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4826                 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
4827
4828                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4829                 assert!(updates_2.update_add_htlcs.is_empty());
4830                 assert!(updates_2.update_fulfill_htlcs.is_empty());
4831                 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
4832                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4833                 assert!(updates_2.update_fee.is_none());
4834
4835                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
4836                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
4837
4838                 let events = nodes[0].node.get_and_clear_pending_events();
4839                 assert_eq!(events.len(), 1);
4840                 match events[0] {
4841                         Event::PaymentFailed { ref payment_hash, ref rejected_by_dest } => {
4842                                 assert_eq!(our_payment_hash, *payment_hash);
4843                                 assert!(!rejected_by_dest);
4844                         },
4845                         _ => panic!("Unexpected event"),
4846                 }
4847
4848                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4849                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4850                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4851                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4852                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4853                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4854                 assert!(node_0_none.is_none());
4855
4856                 assert!(nodes[0].node.list_channels().is_empty());
4857
4858                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4859                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
4860                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
4861                 assert!(nodes[1].node.list_channels().is_empty());
4862                 assert!(nodes[2].node.list_channels().is_empty());
4863         }
4864
4865         #[test]
4866         fn update_fee_async_shutdown() {
4867                 // Test update_fee works after shutdown start if messages are delivered out-of-order
4868                 let nodes = create_network(2);
4869                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4870
4871                 let starting_feerate = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().get_feerate();
4872                 nodes[0].node.update_fee(chan_1.2.clone(), starting_feerate + 20).unwrap();
4873                 check_added_monitors!(nodes[0], 1);
4874                 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4875                 assert!(updates.update_add_htlcs.is_empty());
4876                 assert!(updates.update_fulfill_htlcs.is_empty());
4877                 assert!(updates.update_fail_htlcs.is_empty());
4878                 assert!(updates.update_fail_malformed_htlcs.is_empty());
4879                 assert!(updates.update_fee.is_some());
4880
4881                 nodes[1].node.close_channel(&chan_1.2).unwrap();
4882                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4883                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4884                 // Note that we don't actually test normative behavior here. The spec indicates we could
4885                 // actually send a closing_signed here, but is kinda unclear and could possibly be amended
4886                 // to require waiting on the full commitment dance before doing so (see
4887                 // https://github.com/lightningnetwork/lightning-rfc/issues/499). In any case, to avoid
4888                 // ambiguity, we should wait until after the full commitment dance to send closing_signed.
4889                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4890
4891                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap()).unwrap();
4892                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
4893                 check_added_monitors!(nodes[1], 1);
4894                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4895                 let node_0_closing_signed = commitment_signed_dance!(nodes[1], nodes[0], (), false, true, true);
4896
4897                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4898                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), match node_0_closing_signed.unwrap() {
4899                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
4900                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4901                                 msg
4902                         },
4903                         _ => panic!("Unexpected event"),
4904                 }).unwrap();
4905                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4906                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4907                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4908                 assert!(node_0_none.is_none());
4909         }
4910
4911         fn do_test_shutdown_rebroadcast(recv_count: u8) {
4912                 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
4913                 // messages delivered prior to disconnect
4914                 let nodes = create_network(3);
4915                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4916                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4917
4918                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
4919
4920                 nodes[1].node.close_channel(&chan_1.2).unwrap();
4921                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4922                 if recv_count > 0 {
4923                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4924                         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4925                         if recv_count > 1 {
4926                                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4927                         }
4928                 }
4929
4930                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4931                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4932
4933                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4934                 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
4935                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4936                 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4937
4938                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
4939                 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4940                 assert!(node_1_shutdown == node_1_2nd_shutdown);
4941
4942                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
4943                 let node_0_2nd_shutdown = if recv_count > 0 {
4944                         let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4945                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
4946                         node_0_2nd_shutdown
4947                 } else {
4948                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4949                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
4950                         get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
4951                 };
4952                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
4953
4954                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4955                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4956
4957                 assert!(nodes[2].node.claim_funds(our_payment_preimage));
4958                 check_added_monitors!(nodes[2], 1);
4959                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4960                 assert!(updates.update_add_htlcs.is_empty());
4961                 assert!(updates.update_fail_htlcs.is_empty());
4962                 assert!(updates.update_fail_malformed_htlcs.is_empty());
4963                 assert!(updates.update_fee.is_none());
4964                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4965                 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4966                 check_added_monitors!(nodes[1], 1);
4967                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4968                 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4969
4970                 assert!(updates_2.update_add_htlcs.is_empty());
4971                 assert!(updates_2.update_fail_htlcs.is_empty());
4972                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4973                 assert!(updates_2.update_fee.is_none());
4974                 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
4975                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
4976                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
4977
4978                 let events = nodes[0].node.get_and_clear_pending_events();
4979                 assert_eq!(events.len(), 1);
4980                 match events[0] {
4981                         Event::PaymentSent { ref payment_preimage } => {
4982                                 assert_eq!(our_payment_preimage, *payment_preimage);
4983                         },
4984                         _ => panic!("Unexpected event"),
4985                 }
4986
4987                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4988                 if recv_count > 0 {
4989                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4990                         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4991                         assert!(node_1_closing_signed.is_some());
4992                 }
4993
4994                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4995                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4996
4997                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4998                 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
4999                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5000                 if recv_count == 0 {
5001                         // If all closing_signeds weren't delivered we can just resume where we left off...
5002                         let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5003
5004                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
5005                         let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
5006                         assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
5007
5008                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
5009                         let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
5010                         assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
5011
5012                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
5013                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5014
5015                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
5016                         let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
5017                         assert!(node_0_closing_signed == node_0_2nd_closing_signed);
5018
5019                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
5020                         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
5021                         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
5022                         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
5023                         assert!(node_0_none.is_none());
5024                 } else {
5025                         // If one node, however, received + responded with an identical closing_signed we end
5026                         // up erroring and node[0] will try to broadcast its own latest commitment transaction.
5027                         // There isn't really anything better we can do simply, but in the future we might
5028                         // explore storing a set of recently-closed channels that got disconnected during
5029                         // closing_signed and avoiding broadcasting local commitment txn for some timeout to
5030                         // give our counterparty enough time to (potentially) broadcast a cooperative closing
5031                         // transaction.
5032                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5033
5034                         if let Err(msgs::HandleError{action: Some(msgs::ErrorAction::SendErrorMessage{msg}), ..}) =
5035                                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
5036                                 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
5037                                 let msgs::ErrorMessage {ref channel_id, ..} = msg;
5038                                 assert_eq!(*channel_id, chan_1.2);
5039                         } else { panic!("Needed SendErrorMessage close"); }
5040
5041                         // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
5042                         // checks it, but in this case nodes[0] didn't ever get a chance to receive a
5043                         // closing_signed so we do it ourselves
5044                         let events = nodes[0].node.get_and_clear_pending_msg_events();
5045                         assert_eq!(events.len(), 1);
5046                         match events[0] {
5047                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5048                                         assert_eq!(msg.contents.flags & 2, 2);
5049                                 },
5050                                 _ => panic!("Unexpected event"),
5051                         }
5052                 }
5053
5054                 assert!(nodes[0].node.list_channels().is_empty());
5055
5056                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
5057                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
5058                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
5059                 assert!(nodes[1].node.list_channels().is_empty());
5060                 assert!(nodes[2].node.list_channels().is_empty());
5061         }
5062
5063         #[test]
5064         fn test_shutdown_rebroadcast() {
5065                 do_test_shutdown_rebroadcast(0);
5066                 do_test_shutdown_rebroadcast(1);
5067                 do_test_shutdown_rebroadcast(2);
5068         }
5069
5070         #[test]
5071         fn fake_network_test() {
5072                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5073                 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
5074                 let nodes = create_network(4);
5075
5076                 // Create some initial channels
5077                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5078                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5079                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5080
5081                 // Rebalance the network a bit by relaying one payment through all the channels...
5082                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5083                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5084                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5085                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5086
5087                 // Send some more payments
5088                 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
5089                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
5090                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
5091
5092                 // Test failure packets
5093                 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
5094                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
5095
5096                 // Add a new channel that skips 3
5097                 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
5098
5099                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
5100                 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
5101                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5102                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5103                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5104                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5105                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5106
5107                 // Do some rebalance loop payments, simultaneously
5108                 let mut hops = Vec::with_capacity(3);
5109                 hops.push(RouteHop {
5110                         pubkey: nodes[2].node.get_our_node_id(),
5111                         short_channel_id: chan_2.0.contents.short_channel_id,
5112                         fee_msat: 0,
5113                         cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
5114                 });
5115                 hops.push(RouteHop {
5116                         pubkey: nodes[3].node.get_our_node_id(),
5117                         short_channel_id: chan_3.0.contents.short_channel_id,
5118                         fee_msat: 0,
5119                         cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
5120                 });
5121                 hops.push(RouteHop {
5122                         pubkey: nodes[1].node.get_our_node_id(),
5123                         short_channel_id: chan_4.0.contents.short_channel_id,
5124                         fee_msat: 1000000,
5125                         cltv_expiry_delta: TEST_FINAL_CLTV,
5126                 });
5127                 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;
5128                 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;
5129                 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
5130
5131                 let mut hops = Vec::with_capacity(3);
5132                 hops.push(RouteHop {
5133                         pubkey: nodes[3].node.get_our_node_id(),
5134                         short_channel_id: chan_4.0.contents.short_channel_id,
5135                         fee_msat: 0,
5136                         cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
5137                 });
5138                 hops.push(RouteHop {
5139                         pubkey: nodes[2].node.get_our_node_id(),
5140                         short_channel_id: chan_3.0.contents.short_channel_id,
5141                         fee_msat: 0,
5142                         cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
5143                 });
5144                 hops.push(RouteHop {
5145                         pubkey: nodes[1].node.get_our_node_id(),
5146                         short_channel_id: chan_2.0.contents.short_channel_id,
5147                         fee_msat: 1000000,
5148                         cltv_expiry_delta: TEST_FINAL_CLTV,
5149                 });
5150                 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;
5151                 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;
5152                 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
5153
5154                 // Claim the rebalances...
5155                 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
5156                 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
5157
5158                 // Add a duplicate new channel from 2 to 4
5159                 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
5160
5161                 // Send some payments across both channels
5162                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5163                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5164                 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5165
5166                 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
5167
5168                 //TODO: Test that routes work again here as we've been notified that the channel is full
5169
5170                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
5171                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
5172                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
5173
5174                 // Close down the channels...
5175                 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
5176                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
5177                 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
5178                 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
5179                 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
5180         }
5181
5182         #[test]
5183         fn duplicate_htlc_test() {
5184                 // Test that we accept duplicate payment_hash HTLCs across the network and that
5185                 // claiming/failing them are all separate and don't effect each other
5186                 let mut nodes = create_network(6);
5187
5188                 // Create some initial channels to route via 3 to 4/5 from 0/1/2
5189                 create_announced_chan_between_nodes(&nodes, 0, 3);
5190                 create_announced_chan_between_nodes(&nodes, 1, 3);
5191                 create_announced_chan_between_nodes(&nodes, 2, 3);
5192                 create_announced_chan_between_nodes(&nodes, 3, 4);
5193                 create_announced_chan_between_nodes(&nodes, 3, 5);
5194
5195                 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
5196
5197                 *nodes[0].network_payment_count.borrow_mut() -= 1;
5198                 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
5199
5200                 *nodes[0].network_payment_count.borrow_mut() -= 1;
5201                 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
5202
5203                 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
5204                 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
5205                 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
5206         }
5207
5208         #[derive(PartialEq)]
5209         enum HTLCType { NONE, TIMEOUT, SUCCESS }
5210         /// Tests that the given node has broadcast transactions for the given Channel
5211         ///
5212         /// First checks that the latest local commitment tx has been broadcast, unless an explicit
5213         /// commitment_tx is provided, which may be used to test that a remote commitment tx was
5214         /// broadcast and the revoked outputs were claimed.
5215         ///
5216         /// Next tests that there is (or is not) a transaction that spends the commitment transaction
5217         /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
5218         ///
5219         /// All broadcast transactions must be accounted for in one of the above three types of we'll
5220         /// also fail.
5221         fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
5222                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5223                 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
5224
5225                 let mut res = Vec::with_capacity(2);
5226                 node_txn.retain(|tx| {
5227                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
5228                                 check_spends!(tx, chan.3.clone());
5229                                 if commitment_tx.is_none() {
5230                                         res.push(tx.clone());
5231                                 }
5232                                 false
5233                         } else { true }
5234                 });
5235                 if let Some(explicit_tx) = commitment_tx {
5236                         res.push(explicit_tx.clone());
5237                 }
5238
5239                 assert_eq!(res.len(), 1);
5240
5241                 if has_htlc_tx != HTLCType::NONE {
5242                         node_txn.retain(|tx| {
5243                                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
5244                                         check_spends!(tx, res[0].clone());
5245                                         if has_htlc_tx == HTLCType::TIMEOUT {
5246                                                 assert!(tx.lock_time != 0);
5247                                         } else {
5248                                                 assert!(tx.lock_time == 0);
5249                                         }
5250                                         res.push(tx.clone());
5251                                         false
5252                                 } else { true }
5253                         });
5254                         assert_eq!(res.len(), 2);
5255                 }
5256
5257                 assert!(node_txn.is_empty());
5258                 res
5259         }
5260
5261         /// Tests that the given node has broadcast a claim transaction against the provided revoked
5262         /// HTLC transaction.
5263         fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
5264                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5265                 assert_eq!(node_txn.len(), 1);
5266                 node_txn.retain(|tx| {
5267                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
5268                                 check_spends!(tx, revoked_tx.clone());
5269                                 false
5270                         } else { true }
5271                 });
5272                 assert!(node_txn.is_empty());
5273         }
5274
5275         fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
5276                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5277
5278                 assert!(node_txn.len() >= 1);
5279                 assert_eq!(node_txn[0].input.len(), 1);
5280                 let mut found_prev = false;
5281
5282                 for tx in prev_txn {
5283                         if node_txn[0].input[0].previous_output.txid == tx.txid() {
5284                                 check_spends!(node_txn[0], tx.clone());
5285                                 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
5286                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
5287
5288                                 found_prev = true;
5289                                 break;
5290                         }
5291                 }
5292                 assert!(found_prev);
5293
5294                 let mut res = Vec::new();
5295                 mem::swap(&mut *node_txn, &mut res);
5296                 res
5297         }
5298
5299         fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
5300                 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
5301                 assert_eq!(events_1.len(), 1);
5302                 let as_update = match events_1[0] {
5303                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5304                                 msg.clone()
5305                         },
5306                         _ => panic!("Unexpected event"),
5307                 };
5308
5309                 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
5310                 assert_eq!(events_2.len(), 1);
5311                 let bs_update = match events_2[0] {
5312                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5313                                 msg.clone()
5314                         },
5315                         _ => panic!("Unexpected event"),
5316                 };
5317
5318                 for node in nodes {
5319                         node.router.handle_channel_update(&as_update).unwrap();
5320                         node.router.handle_channel_update(&bs_update).unwrap();
5321                 }
5322         }
5323
5324         macro_rules! expect_pending_htlcs_forwardable {
5325                 ($node: expr) => {{
5326                         let events = $node.node.get_and_clear_pending_events();
5327                         assert_eq!(events.len(), 1);
5328                         match events[0] {
5329                                 Event::PendingHTLCsForwardable { .. } => { },
5330                                 _ => panic!("Unexpected event"),
5331                         };
5332                         $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
5333                         $node.node.process_pending_htlc_forwards();
5334                 }}
5335         }
5336
5337         #[test]
5338         fn channel_reserve_test() {
5339                 use util::rng;
5340                 use std::sync::atomic::Ordering;
5341                 use ln::msgs::HandleError;
5342
5343                 macro_rules! get_channel_value_stat {
5344                         ($node: expr, $channel_id: expr) => {{
5345                                 let chan_lock = $node.node.channel_state.lock().unwrap();
5346                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
5347                                 chan.get_value_stat()
5348                         }}
5349                 }
5350
5351                 let mut nodes = create_network(3);
5352                 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
5353                 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
5354
5355                 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
5356                 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
5357
5358                 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
5359                 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
5360
5361                 macro_rules! get_route_and_payment_hash {
5362                         ($recv_value: expr) => {{
5363                                 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
5364                                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5365                                 (route, payment_hash, payment_preimage)
5366                         }}
5367                 };
5368
5369                 macro_rules! expect_forward {
5370                         ($node: expr) => {{
5371                                 let mut events = $node.node.get_and_clear_pending_msg_events();
5372                                 assert_eq!(events.len(), 1);
5373                                 check_added_monitors!($node, 1);
5374                                 let payment_event = SendEvent::from_event(events.remove(0));
5375                                 payment_event
5376                         }}
5377                 }
5378
5379                 macro_rules! expect_payment_received {
5380                         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
5381                                 let events = $node.node.get_and_clear_pending_events();
5382                                 assert_eq!(events.len(), 1);
5383                                 match events[0] {
5384                                         Event::PaymentReceived { ref payment_hash, amt } => {
5385                                                 assert_eq!($expected_payment_hash, *payment_hash);
5386                                                 assert_eq!($expected_recv_value, amt);
5387                                         },
5388                                         _ => panic!("Unexpected event"),
5389                                 }
5390                         }
5391                 };
5392
5393                 let feemsat = 239; // somehow we know?
5394                 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
5395
5396                 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
5397
5398                 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
5399                 {
5400                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
5401                         assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
5402                         let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
5403                         match err {
5404                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
5405                                 _ => panic!("Unknown error variants"),
5406                         }
5407                 }
5408
5409                 let mut htlc_id = 0;
5410                 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
5411                 // nodes[0]'s wealth
5412                 loop {
5413                         let amt_msat = recv_value_0 + total_fee_msat;
5414                         if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
5415                                 break;
5416                         }
5417                         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
5418                         htlc_id += 1;
5419
5420                         let (stat01_, stat11_, stat12_, stat22_) = (
5421                                 get_channel_value_stat!(nodes[0], chan_1.2),
5422                                 get_channel_value_stat!(nodes[1], chan_1.2),
5423                                 get_channel_value_stat!(nodes[1], chan_2.2),
5424                                 get_channel_value_stat!(nodes[2], chan_2.2),
5425                         );
5426
5427                         assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
5428                         assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
5429                         assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
5430                         assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
5431                         stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
5432                 }
5433
5434                 {
5435                         let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
5436                         // attempt to get channel_reserve violation
5437                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
5438                         let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
5439                         match err {
5440                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5441                                 _ => panic!("Unknown error variants"),
5442                         }
5443                 }
5444
5445                 // adding pending output
5446                 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
5447                 let amt_msat_1 = recv_value_1 + total_fee_msat;
5448
5449                 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
5450                 let payment_event_1 = {
5451                         nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
5452                         check_added_monitors!(nodes[0], 1);
5453
5454                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5455                         assert_eq!(events.len(), 1);
5456                         SendEvent::from_event(events.remove(0))
5457                 };
5458                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
5459
5460                 // channel reserve test with htlc pending output > 0
5461                 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
5462                 {
5463                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5464                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5465                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5466                                 _ => panic!("Unknown error variants"),
5467                         }
5468                 }
5469
5470                 {
5471                         // test channel_reserve test on nodes[1] side
5472                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5473
5474                         // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
5475                         let secp_ctx = Secp256k1::new();
5476                         let session_priv = SecretKey::from_slice(&secp_ctx, &{
5477                                 let mut session_key = [0; 32];
5478                                 rng::fill_bytes(&mut session_key);
5479                                 session_key
5480                         }).expect("RNG is bad!");
5481
5482                         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5483                         let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
5484                         let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height).unwrap();
5485                         let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5486                         let msg = msgs::UpdateAddHTLC {
5487                                 channel_id: chan_1.2,
5488                                 htlc_id,
5489                                 amount_msat: htlc_msat,
5490                                 payment_hash: our_payment_hash,
5491                                 cltv_expiry: htlc_cltv,
5492                                 onion_routing_packet: onion_packet,
5493                         };
5494
5495                         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
5496                         match err {
5497                                 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
5498                         }
5499                 }
5500
5501                 // split the rest to test holding cell
5502                 let recv_value_21 = recv_value_2/2;
5503                 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
5504                 {
5505                         let stat = get_channel_value_stat!(nodes[0], chan_1.2);
5506                         assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat), stat.channel_reserve_msat);
5507                 }
5508
5509                 // now see if they go through on both sides
5510                 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
5511                 // but this will stuck in the holding cell
5512                 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
5513                 check_added_monitors!(nodes[0], 0);
5514                 let events = nodes[0].node.get_and_clear_pending_events();
5515                 assert_eq!(events.len(), 0);
5516
5517                 // test with outbound holding cell amount > 0
5518                 {
5519                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
5520                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5521                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5522                                 _ => panic!("Unknown error variants"),
5523                         }
5524                 }
5525
5526                 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
5527                 // this will also stuck in the holding cell
5528                 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
5529                 check_added_monitors!(nodes[0], 0);
5530                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5531                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5532
5533                 // flush the pending htlc
5534                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
5535                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5536                 check_added_monitors!(nodes[1], 1);
5537
5538                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5539                 check_added_monitors!(nodes[0], 1);
5540                 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5541
5542                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
5543                 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5544                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5545                 check_added_monitors!(nodes[0], 1);
5546
5547                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5548                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5549                 check_added_monitors!(nodes[1], 1);
5550
5551                 expect_pending_htlcs_forwardable!(nodes[1]);
5552
5553                 let ref payment_event_11 = expect_forward!(nodes[1]);
5554                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
5555                 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
5556
5557                 expect_pending_htlcs_forwardable!(nodes[2]);
5558                 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
5559
5560                 // flush the htlcs in the holding cell
5561                 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
5562                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
5563                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
5564                 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
5565                 expect_pending_htlcs_forwardable!(nodes[1]);
5566
5567                 let ref payment_event_3 = expect_forward!(nodes[1]);
5568                 assert_eq!(payment_event_3.msgs.len(), 2);
5569                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
5570                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
5571
5572                 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
5573                 expect_pending_htlcs_forwardable!(nodes[2]);
5574
5575                 let events = nodes[2].node.get_and_clear_pending_events();
5576                 assert_eq!(events.len(), 2);
5577                 match events[0] {
5578                         Event::PaymentReceived { ref payment_hash, amt } => {
5579                                 assert_eq!(our_payment_hash_21, *payment_hash);
5580                                 assert_eq!(recv_value_21, amt);
5581                         },
5582                         _ => panic!("Unexpected event"),
5583                 }
5584                 match events[1] {
5585                         Event::PaymentReceived { ref payment_hash, amt } => {
5586                                 assert_eq!(our_payment_hash_22, *payment_hash);
5587                                 assert_eq!(recv_value_22, amt);
5588                         },
5589                         _ => panic!("Unexpected event"),
5590                 }
5591
5592                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
5593                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
5594                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
5595
5596                 let expected_value_to_self = stat01.value_to_self_msat - (recv_value_1 + total_fee_msat) - (recv_value_21 + total_fee_msat) - (recv_value_22 + total_fee_msat);
5597                 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
5598                 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
5599                 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
5600
5601                 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
5602                 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
5603         }
5604
5605         #[test]
5606         fn channel_monitor_network_test() {
5607                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5608                 // tests that ChannelMonitor is able to recover from various states.
5609                 let nodes = create_network(5);
5610
5611                 // Create some initial channels
5612                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5613                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5614                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5615                 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
5616
5617                 // Rebalance the network a bit by relaying one payment through all the channels...
5618                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5619                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5620                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5621                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5622
5623                 // Simple case with no pending HTLCs:
5624                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
5625                 {
5626                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
5627                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5628                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5629                         test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
5630                 }
5631                 get_announce_close_broadcast_events(&nodes, 0, 1);
5632                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5633                 assert_eq!(nodes[1].node.list_channels().len(), 1);
5634
5635                 // One pending HTLC is discarded by the force-close:
5636                 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
5637
5638                 // Simple case of one pending HTLC to HTLC-Timeout
5639                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
5640                 {
5641                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
5642                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5643                         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5644                         test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
5645                 }
5646                 get_announce_close_broadcast_events(&nodes, 1, 2);
5647                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5648                 assert_eq!(nodes[2].node.list_channels().len(), 1);
5649
5650                 macro_rules! claim_funds {
5651                         ($node: expr, $prev_node: expr, $preimage: expr) => {
5652                                 {
5653                                         assert!($node.node.claim_funds($preimage));
5654                                         check_added_monitors!($node, 1);
5655
5656                                         let events = $node.node.get_and_clear_pending_msg_events();
5657                                         assert_eq!(events.len(), 1);
5658                                         match events[0] {
5659                                                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
5660                                                         assert!(update_add_htlcs.is_empty());
5661                                                         assert!(update_fail_htlcs.is_empty());
5662                                                         assert_eq!(*node_id, $prev_node.node.get_our_node_id());
5663                                                 },
5664                                                 _ => panic!("Unexpected event"),
5665                                         };
5666                                 }
5667                         }
5668                 }
5669
5670                 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
5671                 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
5672                 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
5673                 {
5674                         let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
5675
5676                         // Claim the payment on nodes[3], giving it knowledge of the preimage
5677                         claim_funds!(nodes[3], nodes[2], payment_preimage_1);
5678
5679                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5680                         nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
5681
5682                         check_preimage_claim(&nodes[3], &node_txn);
5683                 }
5684                 get_announce_close_broadcast_events(&nodes, 2, 3);
5685                 assert_eq!(nodes[2].node.list_channels().len(), 0);
5686                 assert_eq!(nodes[3].node.list_channels().len(), 1);
5687
5688                 { // Cheat and reset nodes[4]'s height to 1
5689                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5690                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
5691                 }
5692
5693                 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
5694                 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
5695                 // One pending HTLC to time out:
5696                 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
5697                 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
5698                 // buffer space).
5699
5700                 {
5701                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5702                         nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5703                         for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
5704                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5705                                 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5706                         }
5707
5708                         let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
5709
5710                         // Claim the payment on nodes[4], giving it knowledge of the preimage
5711                         claim_funds!(nodes[4], nodes[3], payment_preimage_2);
5712
5713                         header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5714                         nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5715                         for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
5716                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5717                                 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5718                         }
5719
5720                         test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
5721
5722                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5723                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
5724
5725                         check_preimage_claim(&nodes[4], &node_txn);
5726                 }
5727                 get_announce_close_broadcast_events(&nodes, 3, 4);
5728                 assert_eq!(nodes[3].node.list_channels().len(), 0);
5729                 assert_eq!(nodes[4].node.list_channels().len(), 0);
5730         }
5731
5732         #[test]
5733         fn test_justice_tx() {
5734                 // Test justice txn built on revoked HTLC-Success tx, against both sides
5735
5736                 let nodes = create_network(2);
5737                 // Create some new channels:
5738                 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
5739
5740                 // A pending HTLC which will be revoked:
5741                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5742                 // Get the will-be-revoked local txn from nodes[0]
5743                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5744                 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
5745                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5746                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
5747                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
5748                 assert_eq!(revoked_local_txn[1].input.len(), 1);
5749                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5750                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
5751                 // Revoke the old state
5752                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
5753
5754                 {
5755                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5756                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5757                         {
5758                                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5759                                 assert_eq!(node_txn.len(), 3);
5760                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5761                                 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
5762
5763                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5764                                 node_txn.swap_remove(0);
5765                         }
5766                         test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
5767
5768                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5769                         let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
5770                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5771                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5772                         test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
5773                 }
5774                 get_announce_close_broadcast_events(&nodes, 0, 1);
5775
5776                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5777                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5778
5779                 // We test justice_tx build by A on B's revoked HTLC-Success tx
5780                 // Create some new channels:
5781                 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
5782
5783                 // A pending HTLC which will be revoked:
5784                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5785                 // Get the will-be-revoked local txn from B
5786                 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5787                 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
5788                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5789                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
5790                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
5791                 // Revoke the old state
5792                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
5793                 {
5794                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5795                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5796                         {
5797                                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5798                                 assert_eq!(node_txn.len(), 3);
5799                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5800                                 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
5801
5802                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5803                                 node_txn.swap_remove(0);
5804                         }
5805                         test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
5806
5807                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5808                         let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
5809                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5810                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5811                         test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
5812                 }
5813                 get_announce_close_broadcast_events(&nodes, 0, 1);
5814                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5815                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5816         }
5817
5818         #[test]
5819         fn revoked_output_claim() {
5820                 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
5821                 // transaction is broadcast by its counterparty
5822                 let nodes = create_network(2);
5823                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5824                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
5825                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5826                 assert_eq!(revoked_local_txn.len(), 1);
5827                 // Only output is the full channel value back to nodes[0]:
5828                 assert_eq!(revoked_local_txn[0].output.len(), 1);
5829                 // Send a payment through, updating everyone's latest commitment txn
5830                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
5831
5832                 // Inform nodes[1] that nodes[0] broadcast a stale tx
5833                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5834                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5835                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5836                 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
5837
5838                 assert_eq!(node_txn[0], node_txn[2]);
5839
5840                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5841                 check_spends!(node_txn[1], chan_1.3.clone());
5842
5843                 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
5844                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5845                 get_announce_close_broadcast_events(&nodes, 0, 1);
5846         }
5847
5848         #[test]
5849         fn claim_htlc_outputs_shared_tx() {
5850                 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
5851                 let nodes = create_network(2);
5852
5853                 // Create some new channel:
5854                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5855
5856                 // Rebalance the network to generate htlc in the two directions
5857                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5858                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx
5859                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5860                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
5861
5862                 // Get the will-be-revoked local txn from node[0]
5863                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5864                 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
5865                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5866                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5867                 assert_eq!(revoked_local_txn[1].input.len(), 1);
5868                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5869                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
5870                 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
5871
5872                 //Revoke the old state
5873                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
5874
5875                 {
5876                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5877
5878                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5879
5880                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5881                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5882                         assert_eq!(node_txn.len(), 4);
5883
5884                         assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
5885                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
5886
5887                         assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
5888
5889                         let mut witness_lens = BTreeSet::new();
5890                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
5891                         witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
5892                         witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
5893                         assert_eq!(witness_lens.len(), 3);
5894                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
5895                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
5896                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
5897
5898                         // Next nodes[1] broadcasts its current local tx state:
5899                         assert_eq!(node_txn[1].input.len(), 1);
5900                         assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
5901
5902                         assert_eq!(node_txn[2].input.len(), 1);
5903                         let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
5904                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
5905                         assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
5906                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
5907                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
5908                 }
5909                 get_announce_close_broadcast_events(&nodes, 0, 1);
5910                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5911                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5912         }
5913
5914         #[test]
5915         fn claim_htlc_outputs_single_tx() {
5916                 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
5917                 let nodes = create_network(2);
5918
5919                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5920
5921                 // Rebalance the network to generate htlc in the two directions
5922                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5923                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx, but this
5924                 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
5925                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5926                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
5927
5928                 // Get the will-be-revoked local txn from node[0]
5929                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5930
5931                 //Revoke the old state
5932                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
5933
5934                 {
5935                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5936
5937                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
5938
5939                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
5940                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5941                         assert_eq!(node_txn.len(), 12); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan)
5942
5943                         assert_eq!(node_txn[0], node_txn[7]);
5944                         assert_eq!(node_txn[1], node_txn[8]);
5945                         assert_eq!(node_txn[2], node_txn[9]);
5946                         assert_eq!(node_txn[3], node_txn[10]);
5947                         assert_eq!(node_txn[4], node_txn[11]);
5948                         assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
5949                         assert_eq!(node_txn[4], node_txn[6]);
5950
5951                         assert_eq!(node_txn[0].input.len(), 1);
5952                         assert_eq!(node_txn[1].input.len(), 1);
5953                         assert_eq!(node_txn[2].input.len(), 1);
5954
5955                         let mut revoked_tx_map = HashMap::new();
5956                         revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
5957                         node_txn[0].verify(&revoked_tx_map).unwrap();
5958                         node_txn[1].verify(&revoked_tx_map).unwrap();
5959                         node_txn[2].verify(&revoked_tx_map).unwrap();
5960
5961                         let mut witness_lens = BTreeSet::new();
5962                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
5963                         witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
5964                         witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
5965                         assert_eq!(witness_lens.len(), 3);
5966                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
5967                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
5968                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
5969
5970                         assert_eq!(node_txn[3].input.len(), 1);
5971                         check_spends!(node_txn[3], chan_1.3.clone());
5972
5973                         assert_eq!(node_txn[4].input.len(), 1);
5974                         let witness_script = node_txn[4].input[0].witness.last().unwrap();
5975                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
5976                         assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
5977                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
5978                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
5979                 }
5980                 get_announce_close_broadcast_events(&nodes, 0, 1);
5981                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5982                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5983         }
5984
5985         #[test]
5986         fn test_htlc_ignore_latest_remote_commitment() {
5987                 // Test that HTLC transactions spending the latest remote commitment transaction are simply
5988                 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
5989                 let nodes = create_network(2);
5990                 create_announced_chan_between_nodes(&nodes, 0, 1);
5991
5992                 route_payment(&nodes[0], &[&nodes[1]], 10000000);
5993                 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
5994                 {
5995                         let events = nodes[0].node.get_and_clear_pending_msg_events();
5996                         assert_eq!(events.len(), 1);
5997                         match events[0] {
5998                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5999                                         assert_eq!(flags & 0b10, 0b10);
6000                                 },
6001                                 _ => panic!("Unexpected event"),
6002                         }
6003                 }
6004
6005                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6006                 assert_eq!(node_txn.len(), 2);
6007
6008                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6009                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
6010
6011                 {
6012                         let events = nodes[1].node.get_and_clear_pending_msg_events();
6013                         assert_eq!(events.len(), 1);
6014                         match events[0] {
6015                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6016                                         assert_eq!(flags & 0b10, 0b10);
6017                                 },
6018                                 _ => panic!("Unexpected event"),
6019                         }
6020                 }
6021
6022                 // Duplicate the block_connected call since this may happen due to other listeners
6023                 // registering new transactions
6024                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
6025         }
6026
6027         #[test]
6028         fn test_force_close_fail_back() {
6029                 // Check which HTLCs are failed-backwards on channel force-closure
6030                 let mut nodes = create_network(3);
6031                 create_announced_chan_between_nodes(&nodes, 0, 1);
6032                 create_announced_chan_between_nodes(&nodes, 1, 2);
6033
6034                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
6035
6036                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6037
6038                 let mut payment_event = {
6039                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6040                         check_added_monitors!(nodes[0], 1);
6041
6042                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6043                         assert_eq!(events.len(), 1);
6044                         SendEvent::from_event(events.remove(0))
6045                 };
6046
6047                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6048                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6049
6050                 let events_1 = nodes[1].node.get_and_clear_pending_events();
6051                 assert_eq!(events_1.len(), 1);
6052                 match events_1[0] {
6053                         Event::PendingHTLCsForwardable { .. } => { },
6054                         _ => panic!("Unexpected event"),
6055                 };
6056
6057                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6058                 nodes[1].node.process_pending_htlc_forwards();
6059
6060                 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6061                 assert_eq!(events_2.len(), 1);
6062                 payment_event = SendEvent::from_event(events_2.remove(0));
6063                 assert_eq!(payment_event.msgs.len(), 1);
6064
6065                 check_added_monitors!(nodes[1], 1);
6066                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6067                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6068                 check_added_monitors!(nodes[2], 1);
6069                 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6070
6071                 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
6072                 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
6073                 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
6074
6075                 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
6076                 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6077                 assert_eq!(events_3.len(), 1);
6078                 match events_3[0] {
6079                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6080                                 assert_eq!(flags & 0b10, 0b10);
6081                         },
6082                         _ => panic!("Unexpected event"),
6083                 }
6084
6085                 let tx = {
6086                         let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
6087                         // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
6088                         // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
6089                         // back to nodes[1] upon timeout otherwise.
6090                         assert_eq!(node_txn.len(), 1);
6091                         node_txn.remove(0)
6092                 };
6093
6094                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6095                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
6096
6097                 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6098                 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
6099                 assert_eq!(events_4.len(), 1);
6100                 match events_4[0] {
6101                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6102                                 assert_eq!(flags & 0b10, 0b10);
6103                         },
6104                         _ => panic!("Unexpected event"),
6105                 }
6106
6107                 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
6108                 {
6109                         let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
6110                         monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
6111                                 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
6112                 }
6113                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
6114                 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
6115                 assert_eq!(node_txn.len(), 1);
6116                 assert_eq!(node_txn[0].input.len(), 1);
6117                 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
6118                 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
6119                 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
6120
6121                 check_spends!(node_txn[0], tx);
6122         }
6123
6124         #[test]
6125         fn test_unconf_chan() {
6126                 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
6127                 let nodes = create_network(2);
6128                 create_announced_chan_between_nodes(&nodes, 0, 1);
6129
6130                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
6131                 assert_eq!(channel_state.by_id.len(), 1);
6132                 assert_eq!(channel_state.short_to_id.len(), 1);
6133                 mem::drop(channel_state);
6134
6135                 let mut headers = Vec::new();
6136                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6137                 headers.push(header.clone());
6138                 for _i in 2..100 {
6139                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6140                         headers.push(header.clone());
6141                 }
6142                 while !headers.is_empty() {
6143                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
6144                 }
6145                 {
6146                         let events = nodes[0].node.get_and_clear_pending_msg_events();
6147                         assert_eq!(events.len(), 1);
6148                         match events[0] {
6149                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6150                                         assert_eq!(flags & 0b10, 0b10);
6151                                 },
6152                                 _ => panic!("Unexpected event"),
6153                         }
6154                 }
6155                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
6156                 assert_eq!(channel_state.by_id.len(), 0);
6157                 assert_eq!(channel_state.short_to_id.len(), 0);
6158         }
6159
6160         macro_rules! get_chan_reestablish_msgs {
6161                 ($src_node: expr, $dst_node: expr) => {
6162                         {
6163                                 let mut res = Vec::with_capacity(1);
6164                                 for msg in $src_node.node.get_and_clear_pending_msg_events() {
6165                                         if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6166                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6167                                                 res.push(msg.clone());
6168                                         } else {
6169                                                 panic!("Unexpected event")
6170                                         }
6171                                 }
6172                                 res
6173                         }
6174                 }
6175         }
6176
6177         macro_rules! handle_chan_reestablish_msgs {
6178                 ($src_node: expr, $dst_node: expr) => {
6179                         {
6180                                 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
6181                                 let mut idx = 0;
6182                                 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
6183                                         idx += 1;
6184                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6185                                         Some(msg.clone())
6186                                 } else {
6187                                         None
6188                                 };
6189
6190                                 let mut revoke_and_ack = None;
6191                                 let mut commitment_update = None;
6192                                 let order = if let Some(ev) = msg_events.get(idx) {
6193                                         idx += 1;
6194                                         match ev {
6195                                                 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6196                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6197                                                         revoke_and_ack = Some(msg.clone());
6198                                                         RAACommitmentOrder::RevokeAndACKFirst
6199                                                 },
6200                                                 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6201                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6202                                                         commitment_update = Some(updates.clone());
6203                                                         RAACommitmentOrder::CommitmentFirst
6204                                                 },
6205                                                 _ => panic!("Unexpected event"),
6206                                         }
6207                                 } else {
6208                                         RAACommitmentOrder::CommitmentFirst
6209                                 };
6210
6211                                 if let Some(ev) = msg_events.get(idx) {
6212                                         match ev {
6213                                                 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6214                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6215                                                         assert!(revoke_and_ack.is_none());
6216                                                         revoke_and_ack = Some(msg.clone());
6217                                                 },
6218                                                 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6219                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6220                                                         assert!(commitment_update.is_none());
6221                                                         commitment_update = Some(updates.clone());
6222                                                 },
6223                                                 _ => panic!("Unexpected event"),
6224                                         }
6225                                 }
6226
6227                                 (funding_locked, revoke_and_ack, commitment_update, order)
6228                         }
6229                 }
6230         }
6231
6232         /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
6233         /// for claims/fails they are separated out.
6234         fn reconnect_nodes(node_a: &Node, node_b: &Node, send_funding_locked: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
6235                 node_a.node.peer_connected(&node_b.node.get_our_node_id());
6236                 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
6237                 node_b.node.peer_connected(&node_a.node.get_our_node_id());
6238                 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
6239
6240                 let mut resp_1 = Vec::new();
6241                 for msg in reestablish_1 {
6242                         node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
6243                         resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
6244                 }
6245                 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
6246                         check_added_monitors!(node_b, 1);
6247                 } else {
6248                         check_added_monitors!(node_b, 0);
6249                 }
6250
6251                 let mut resp_2 = Vec::new();
6252                 for msg in reestablish_2 {
6253                         node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
6254                         resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
6255                 }
6256                 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
6257                         check_added_monitors!(node_a, 1);
6258                 } else {
6259                         check_added_monitors!(node_a, 0);
6260                 }
6261
6262                 // We dont yet support both needing updates, as that would require a different commitment dance:
6263                 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
6264                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
6265
6266                 for chan_msgs in resp_1.drain(..) {
6267                         if send_funding_locked.0 {
6268                                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
6269                                 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
6270                                 if !announcement_event.is_empty() {
6271                                         assert_eq!(announcement_event.len(), 1);
6272                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
6273                                                 //TODO: Test announcement_sigs re-sending
6274                                         } else { panic!("Unexpected event!"); }
6275                                 }
6276                         } else {
6277                                 assert!(chan_msgs.0.is_none());
6278                         }
6279                         if pending_raa.0 {
6280                                 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
6281                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
6282                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
6283                                 check_added_monitors!(node_a, 1);
6284                         } else {
6285                                 assert!(chan_msgs.1.is_none());
6286                         }
6287                         if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
6288                                 let commitment_update = chan_msgs.2.unwrap();
6289                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
6290                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
6291                                 } else {
6292                                         assert!(commitment_update.update_add_htlcs.is_empty());
6293                                 }
6294                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
6295                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
6296                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
6297                                 for update_add in commitment_update.update_add_htlcs {
6298                                         node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
6299                                 }
6300                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
6301                                         node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
6302                                 }
6303                                 for update_fail in commitment_update.update_fail_htlcs {
6304                                         node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
6305                                 }
6306
6307                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
6308                                         commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
6309                                 } else {
6310                                         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
6311                                         check_added_monitors!(node_a, 1);
6312                                         let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
6313                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
6314                                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6315                                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
6316                                         check_added_monitors!(node_b, 1);
6317                                 }
6318                         } else {
6319                                 assert!(chan_msgs.2.is_none());
6320                         }
6321                 }
6322
6323                 for chan_msgs in resp_2.drain(..) {
6324                         if send_funding_locked.1 {
6325                                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
6326                                 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
6327                                 if !announcement_event.is_empty() {
6328                                         assert_eq!(announcement_event.len(), 1);
6329                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
6330                                                 //TODO: Test announcement_sigs re-sending
6331                                         } else { panic!("Unexpected event!"); }
6332                                 }
6333                         } else {
6334                                 assert!(chan_msgs.0.is_none());
6335                         }
6336                         if pending_raa.1 {
6337                                 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
6338                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
6339                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
6340                                 check_added_monitors!(node_b, 1);
6341                         } else {
6342                                 assert!(chan_msgs.1.is_none());
6343                         }
6344                         if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
6345                                 let commitment_update = chan_msgs.2.unwrap();
6346                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
6347                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
6348                                 }
6349                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
6350                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
6351                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
6352                                 for update_add in commitment_update.update_add_htlcs {
6353                                         node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
6354                                 }
6355                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
6356                                         node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
6357                                 }
6358                                 for update_fail in commitment_update.update_fail_htlcs {
6359                                         node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
6360                                 }
6361
6362                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
6363                                         commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
6364                                 } else {
6365                                         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
6366                                         check_added_monitors!(node_b, 1);
6367                                         let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
6368                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
6369                                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6370                                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
6371                                         check_added_monitors!(node_a, 1);
6372                                 }
6373                         } else {
6374                                 assert!(chan_msgs.2.is_none());
6375                         }
6376                 }
6377         }
6378
6379         #[test]
6380         fn test_simple_peer_disconnect() {
6381                 // Test that we can reconnect when there are no lost messages
6382                 let nodes = create_network(3);
6383                 create_announced_chan_between_nodes(&nodes, 0, 1);
6384                 create_announced_chan_between_nodes(&nodes, 1, 2);
6385
6386                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6387                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6388                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6389
6390                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6391                 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6392                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
6393                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
6394
6395                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6396                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6397                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6398
6399                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6400                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6401                 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6402                 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6403
6404                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6405                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6406
6407                 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
6408                 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
6409
6410                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
6411                 {
6412                         let events = nodes[0].node.get_and_clear_pending_events();
6413                         assert_eq!(events.len(), 2);
6414                         match events[0] {
6415                                 Event::PaymentSent { payment_preimage } => {
6416                                         assert_eq!(payment_preimage, payment_preimage_3);
6417                                 },
6418                                 _ => panic!("Unexpected event"),
6419                         }
6420                         match events[1] {
6421                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
6422                                         assert_eq!(payment_hash, payment_hash_5);
6423                                         assert!(rejected_by_dest);
6424                                 },
6425                                 _ => panic!("Unexpected event"),
6426                         }
6427                 }
6428
6429                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
6430                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
6431         }
6432
6433         fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
6434                 // Test that we can reconnect when in-flight HTLC updates get dropped
6435                 let mut nodes = create_network(2);
6436                 if messages_delivered == 0 {
6437                         create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
6438                         // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
6439                 } else {
6440                         create_announced_chan_between_nodes(&nodes, 0, 1);
6441                 }
6442
6443                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6444                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6445
6446                 let payment_event = {
6447                         nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
6448                         check_added_monitors!(nodes[0], 1);
6449
6450                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6451                         assert_eq!(events.len(), 1);
6452                         SendEvent::from_event(events.remove(0))
6453                 };
6454                 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
6455
6456                 if messages_delivered < 2 {
6457                         // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
6458                 } else {
6459                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6460                         if messages_delivered >= 3 {
6461                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6462                                 check_added_monitors!(nodes[1], 1);
6463                                 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6464
6465                                 if messages_delivered >= 4 {
6466                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6467                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6468                                         check_added_monitors!(nodes[0], 1);
6469
6470                                         if messages_delivered >= 5 {
6471                                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
6472                                                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6473                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6474                                                 check_added_monitors!(nodes[0], 1);
6475
6476                                                 if messages_delivered >= 6 {
6477                                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6478                                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6479                                                         check_added_monitors!(nodes[1], 1);
6480                                                 }
6481                                         }
6482                                 }
6483                         }
6484                 }
6485
6486                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6487                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6488                 if messages_delivered < 3 {
6489                         // Even if the funding_locked messages get exchanged, as long as nothing further was
6490                         // received on either side, both sides will need to resend them.
6491                         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
6492                 } else if messages_delivered == 3 {
6493                         // nodes[0] still wants its RAA + commitment_signed
6494                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
6495                 } else if messages_delivered == 4 {
6496                         // nodes[0] still wants its commitment_signed
6497                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
6498                 } else if messages_delivered == 5 {
6499                         // nodes[1] still wants its final RAA
6500                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
6501                 } else if messages_delivered == 6 {
6502                         // Everything was delivered...
6503                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6504                 }
6505
6506                 let events_1 = nodes[1].node.get_and_clear_pending_events();
6507                 assert_eq!(events_1.len(), 1);
6508                 match events_1[0] {
6509                         Event::PendingHTLCsForwardable { .. } => { },
6510                         _ => panic!("Unexpected event"),
6511                 };
6512
6513                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6514                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6515                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6516
6517                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6518                 nodes[1].node.process_pending_htlc_forwards();
6519
6520                 let events_2 = nodes[1].node.get_and_clear_pending_events();
6521                 assert_eq!(events_2.len(), 1);
6522                 match events_2[0] {
6523                         Event::PaymentReceived { ref payment_hash, amt } => {
6524                                 assert_eq!(payment_hash_1, *payment_hash);
6525                                 assert_eq!(amt, 1000000);
6526                         },
6527                         _ => panic!("Unexpected event"),
6528                 }
6529
6530                 nodes[1].node.claim_funds(payment_preimage_1);
6531                 check_added_monitors!(nodes[1], 1);
6532
6533                 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
6534                 assert_eq!(events_3.len(), 1);
6535                 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
6536                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6537                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6538                                 assert!(updates.update_add_htlcs.is_empty());
6539                                 assert!(updates.update_fail_htlcs.is_empty());
6540                                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
6541                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
6542                                 assert!(updates.update_fee.is_none());
6543                                 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
6544                         },
6545                         _ => panic!("Unexpected event"),
6546                 };
6547
6548                 if messages_delivered >= 1 {
6549                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
6550
6551                         let events_4 = nodes[0].node.get_and_clear_pending_events();
6552                         assert_eq!(events_4.len(), 1);
6553                         match events_4[0] {
6554                                 Event::PaymentSent { ref payment_preimage } => {
6555                                         assert_eq!(payment_preimage_1, *payment_preimage);
6556                                 },
6557                                 _ => panic!("Unexpected event"),
6558                         }
6559
6560                         if messages_delivered >= 2 {
6561                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
6562                                 check_added_monitors!(nodes[0], 1);
6563                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6564
6565                                 if messages_delivered >= 3 {
6566                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6567                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6568                                         check_added_monitors!(nodes[1], 1);
6569
6570                                         if messages_delivered >= 4 {
6571                                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
6572                                                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6573                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6574                                                 check_added_monitors!(nodes[1], 1);
6575
6576                                                 if messages_delivered >= 5 {
6577                                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6578                                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6579                                                         check_added_monitors!(nodes[0], 1);
6580                                                 }
6581                                         }
6582                                 }
6583                         }
6584                 }
6585
6586                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6587                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6588                 if messages_delivered < 2 {
6589                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
6590                         //TODO: Deduplicate PaymentSent events, then enable this if:
6591                         //if messages_delivered < 1 {
6592                                 let events_4 = nodes[0].node.get_and_clear_pending_events();
6593                                 assert_eq!(events_4.len(), 1);
6594                                 match events_4[0] {
6595                                         Event::PaymentSent { ref payment_preimage } => {
6596                                                 assert_eq!(payment_preimage_1, *payment_preimage);
6597                                         },
6598                                         _ => panic!("Unexpected event"),
6599                                 }
6600                         //}
6601                 } else if messages_delivered == 2 {
6602                         // nodes[0] still wants its RAA + commitment_signed
6603                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
6604                 } else if messages_delivered == 3 {
6605                         // nodes[0] still wants its commitment_signed
6606                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
6607                 } else if messages_delivered == 4 {
6608                         // nodes[1] still wants its final RAA
6609                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
6610                 } else if messages_delivered == 5 {
6611                         // Everything was delivered...
6612                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6613                 }
6614
6615                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6616                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6617                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6618
6619                 // Channel should still work fine...
6620                 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
6621                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6622         }
6623
6624         #[test]
6625         fn test_drop_messages_peer_disconnect_a() {
6626                 do_test_drop_messages_peer_disconnect(0);
6627                 do_test_drop_messages_peer_disconnect(1);
6628                 do_test_drop_messages_peer_disconnect(2);
6629                 do_test_drop_messages_peer_disconnect(3);
6630         }
6631
6632         #[test]
6633         fn test_drop_messages_peer_disconnect_b() {
6634                 do_test_drop_messages_peer_disconnect(4);
6635                 do_test_drop_messages_peer_disconnect(5);
6636                 do_test_drop_messages_peer_disconnect(6);
6637         }
6638
6639         #[test]
6640         fn test_funding_peer_disconnect() {
6641                 // Test that we can lock in our funding tx while disconnected
6642                 let nodes = create_network(2);
6643                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
6644
6645                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6646                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6647
6648                 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
6649                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6650                 assert_eq!(events_1.len(), 1);
6651                 match events_1[0] {
6652                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
6653                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6654                         },
6655                         _ => panic!("Unexpected event"),
6656                 }
6657
6658                 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6659
6660                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6661                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6662
6663                 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
6664                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6665                 assert_eq!(events_2.len(), 2);
6666                 match events_2[0] {
6667                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
6668                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6669                         },
6670                         _ => panic!("Unexpected event"),
6671                 }
6672                 match events_2[1] {
6673                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
6674                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6675                         },
6676                         _ => panic!("Unexpected event"),
6677                 }
6678
6679                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6680
6681                 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
6682                 // rebroadcasting announcement_signatures upon reconnect.
6683
6684                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6685                 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
6686                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
6687         }
6688
6689         #[test]
6690         fn test_drop_messages_peer_disconnect_dual_htlc() {
6691                 // Test that we can handle reconnecting when both sides of a channel have pending
6692                 // commitment_updates when we disconnect.
6693                 let mut nodes = create_network(2);
6694                 create_announced_chan_between_nodes(&nodes, 0, 1);
6695
6696                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6697
6698                 // Now try to send a second payment which will fail to send
6699                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6700                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6701
6702                 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
6703                 check_added_monitors!(nodes[0], 1);
6704
6705                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6706                 assert_eq!(events_1.len(), 1);
6707                 match events_1[0] {
6708                         MessageSendEvent::UpdateHTLCs { .. } => {},
6709                         _ => panic!("Unexpected event"),
6710                 }
6711
6712                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
6713                 check_added_monitors!(nodes[1], 1);
6714
6715                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6716                 assert_eq!(events_2.len(), 1);
6717                 match events_2[0] {
6718                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
6719                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6720                                 assert!(update_add_htlcs.is_empty());
6721                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6722                                 assert!(update_fail_htlcs.is_empty());
6723                                 assert!(update_fail_malformed_htlcs.is_empty());
6724                                 assert!(update_fee.is_none());
6725
6726                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
6727                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
6728                                 assert_eq!(events_3.len(), 1);
6729                                 match events_3[0] {
6730                                         Event::PaymentSent { ref payment_preimage } => {
6731                                                 assert_eq!(*payment_preimage, payment_preimage_1);
6732                                         },
6733                                         _ => panic!("Unexpected event"),
6734                                 }
6735
6736                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
6737                                 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6738                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6739                                 check_added_monitors!(nodes[0], 1);
6740                         },
6741                         _ => panic!("Unexpected event"),
6742                 }
6743
6744                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6745                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6746
6747                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6748                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6749                 assert_eq!(reestablish_1.len(), 1);
6750                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6751                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6752                 assert_eq!(reestablish_2.len(), 1);
6753
6754                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
6755                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6756                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
6757                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6758
6759                 assert!(as_resp.0.is_none());
6760                 assert!(bs_resp.0.is_none());
6761
6762                 assert!(bs_resp.1.is_none());
6763                 assert!(bs_resp.2.is_none());
6764
6765                 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
6766
6767                 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
6768                 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
6769                 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
6770                 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
6771                 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
6772                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]).unwrap();
6773                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
6774                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6775                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6776                 check_added_monitors!(nodes[1], 1);
6777
6778                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
6779                 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6780                 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
6781                 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
6782                 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
6783                 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
6784                 assert!(bs_second_commitment_signed.update_fee.is_none());
6785                 check_added_monitors!(nodes[1], 1);
6786
6787                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6788                 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6789                 assert!(as_commitment_signed.update_add_htlcs.is_empty());
6790                 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
6791                 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
6792                 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
6793                 assert!(as_commitment_signed.update_fee.is_none());
6794                 check_added_monitors!(nodes[0], 1);
6795
6796                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
6797                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6798                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6799                 check_added_monitors!(nodes[0], 1);
6800
6801                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
6802                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6803                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6804                 check_added_monitors!(nodes[1], 1);
6805
6806                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6807                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6808                 check_added_monitors!(nodes[1], 1);
6809
6810                 let events_4 = nodes[1].node.get_and_clear_pending_events();
6811                 assert_eq!(events_4.len(), 1);
6812                 match events_4[0] {
6813                         Event::PendingHTLCsForwardable { .. } => { },
6814                         _ => panic!("Unexpected event"),
6815                 };
6816
6817                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6818                 nodes[1].node.process_pending_htlc_forwards();
6819
6820                 let events_5 = nodes[1].node.get_and_clear_pending_events();
6821                 assert_eq!(events_5.len(), 1);
6822                 match events_5[0] {
6823                         Event::PaymentReceived { ref payment_hash, amt: _ } => {
6824                                 assert_eq!(payment_hash_2, *payment_hash);
6825                         },
6826                         _ => panic!("Unexpected event"),
6827                 }
6828
6829                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
6830                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6831                 check_added_monitors!(nodes[0], 1);
6832
6833                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6834         }
6835
6836         #[test]
6837         fn test_simple_monitor_permanent_update_fail() {
6838                 // Test that we handle a simple permanent monitor update failure
6839                 let mut nodes = create_network(2);
6840                 create_announced_chan_between_nodes(&nodes, 0, 1);
6841
6842                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6843                 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6844
6845                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
6846                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
6847                 check_added_monitors!(nodes[0], 1);
6848
6849                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6850                 assert_eq!(events_1.len(), 1);
6851                 match events_1[0] {
6852                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6853                         _ => panic!("Unexpected event"),
6854                 };
6855
6856                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
6857                 // PaymentFailed event
6858
6859                 assert_eq!(nodes[0].node.list_channels().len(), 0);
6860         }
6861
6862         fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
6863                 // Test that we can recover from a simple temporary monitor update failure optionally with
6864                 // a disconnect in between
6865                 let mut nodes = create_network(2);
6866                 create_announced_chan_between_nodes(&nodes, 0, 1);
6867
6868                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6869                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6870
6871                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
6872                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
6873                 check_added_monitors!(nodes[0], 1);
6874
6875                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6876                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6877                 assert_eq!(nodes[0].node.list_channels().len(), 1);
6878
6879                 if disconnect {
6880                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6881                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6882                         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6883                 }
6884
6885                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
6886                 nodes[0].node.test_restore_channel_monitor();
6887                 check_added_monitors!(nodes[0], 1);
6888
6889                 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
6890                 assert_eq!(events_2.len(), 1);
6891                 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
6892                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
6893                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6894                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6895
6896                 expect_pending_htlcs_forwardable!(nodes[1]);
6897
6898                 let events_3 = nodes[1].node.get_and_clear_pending_events();
6899                 assert_eq!(events_3.len(), 1);
6900                 match events_3[0] {
6901                         Event::PaymentReceived { ref payment_hash, amt } => {
6902                                 assert_eq!(payment_hash_1, *payment_hash);
6903                                 assert_eq!(amt, 1000000);
6904                         },
6905                         _ => panic!("Unexpected event"),
6906                 }
6907
6908                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
6909
6910                 // Now set it to failed again...
6911                 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6912                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
6913                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
6914                 check_added_monitors!(nodes[0], 1);
6915
6916                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6917                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6918                 assert_eq!(nodes[0].node.list_channels().len(), 1);
6919
6920                 if disconnect {
6921                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6922                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6923                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6924                 }
6925
6926                 // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
6927                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
6928                 nodes[0].node.test_restore_channel_monitor();
6929                 check_added_monitors!(nodes[0], 1);
6930
6931                 let events_5 = nodes[0].node.get_and_clear_pending_msg_events();
6932                 assert_eq!(events_5.len(), 1);
6933                 match events_5[0] {
6934                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6935                         _ => panic!("Unexpected event"),
6936                 }
6937
6938                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
6939                 // PaymentFailed event
6940
6941                 assert_eq!(nodes[0].node.list_channels().len(), 0);
6942         }
6943
6944         #[test]
6945         fn test_simple_monitor_temporary_update_fail() {
6946                 do_test_simple_monitor_temporary_update_fail(false);
6947                 do_test_simple_monitor_temporary_update_fail(true);
6948         }
6949
6950         fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
6951                 let disconnect_flags = 8 | 16;
6952
6953                 // Test that we can recover from a temporary monitor update failure with some in-flight
6954                 // HTLCs going on at the same time potentially with some disconnection thrown in.
6955                 // * First we route a payment, then get a temporary monitor update failure when trying to
6956                 //   route a second payment. We then claim the first payment.
6957                 // * If disconnect_count is set, we will disconnect at this point (which is likely as
6958                 //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
6959                 //   the ChannelMonitor on a watchtower).
6960                 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
6961                 //   immediately, otherwise we wait sconnect and deliver them via the reconnect
6962                 //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
6963                 //   disconnect_count & !disconnect_flags is 0).
6964                 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
6965                 //   through message sending, potentially disconnect/reconnecting multiple times based on
6966                 //   disconnect_count, to get the update_fulfill_htlc through.
6967                 // * We then walk through more message exchanges to get the original update_add_htlc
6968                 //   through, swapping message ordering based on disconnect_count & 8 and optionally
6969                 //   disconnect/reconnecting based on disconnect_count.
6970                 let mut nodes = create_network(2);
6971                 create_announced_chan_between_nodes(&nodes, 0, 1);
6972
6973                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6974
6975                 // Now try to send a second payment which will fail to send
6976                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6977                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6978
6979                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
6980                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
6981                 check_added_monitors!(nodes[0], 1);
6982
6983                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6984                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6985                 assert_eq!(nodes[0].node.list_channels().len(), 1);
6986
6987                 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
6988                 // but nodes[0] won't respond since it is frozen.
6989                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
6990                 check_added_monitors!(nodes[1], 1);
6991                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6992                 assert_eq!(events_2.len(), 1);
6993                 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
6994                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
6995                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6996                                 assert!(update_add_htlcs.is_empty());
6997                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6998                                 assert!(update_fail_htlcs.is_empty());
6999                                 assert!(update_fail_malformed_htlcs.is_empty());
7000                                 assert!(update_fee.is_none());
7001
7002                                 if (disconnect_count & 16) == 0 {
7003                                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
7004                                         let events_3 = nodes[0].node.get_and_clear_pending_events();
7005                                         assert_eq!(events_3.len(), 1);
7006                                         match events_3[0] {
7007                                                 Event::PaymentSent { ref payment_preimage } => {
7008                                                         assert_eq!(*payment_preimage, payment_preimage_1);
7009                                                 },
7010                                                 _ => panic!("Unexpected event"),
7011                                         }
7012
7013                                         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::IgnoreError) }) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed) {
7014                                                 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
7015                                         } else { panic!(); }
7016                                 }
7017
7018                                 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
7019                         },
7020                         _ => panic!("Unexpected event"),
7021                 };
7022
7023                 if disconnect_count & !disconnect_flags > 0 {
7024                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7025                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7026                 }
7027
7028                 // Now fix monitor updating...
7029                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
7030                 nodes[0].node.test_restore_channel_monitor();
7031                 check_added_monitors!(nodes[0], 1);
7032
7033                 macro_rules! disconnect_reconnect_peers { () => { {
7034                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7035                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7036
7037                         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7038                         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7039                         assert_eq!(reestablish_1.len(), 1);
7040                         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7041                         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7042                         assert_eq!(reestablish_2.len(), 1);
7043
7044                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7045                         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7046                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7047                         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7048
7049                         assert!(as_resp.0.is_none());
7050                         assert!(bs_resp.0.is_none());
7051
7052                         (reestablish_1, reestablish_2, as_resp, bs_resp)
7053                 } } }
7054
7055                 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
7056                         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7057                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7058
7059                         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7060                         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7061                         assert_eq!(reestablish_1.len(), 1);
7062                         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7063                         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7064                         assert_eq!(reestablish_2.len(), 1);
7065
7066                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7067                         check_added_monitors!(nodes[0], 0);
7068                         let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7069                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7070                         check_added_monitors!(nodes[1], 0);
7071                         let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7072
7073                         assert!(as_resp.0.is_none());
7074                         assert!(bs_resp.0.is_none());
7075
7076                         assert!(bs_resp.1.is_none());
7077                         if (disconnect_count & 16) == 0 {
7078                                 assert!(bs_resp.2.is_none());
7079
7080                                 assert!(as_resp.1.is_some());
7081                                 assert!(as_resp.2.is_some());
7082                                 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
7083                         } else {
7084                                 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
7085                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
7086                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
7087                                 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
7088                                 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
7089                                 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
7090
7091                                 assert!(as_resp.1.is_none());
7092
7093                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]).unwrap();
7094                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
7095                                 assert_eq!(events_3.len(), 1);
7096                                 match events_3[0] {
7097                                         Event::PaymentSent { ref payment_preimage } => {
7098                                                 assert_eq!(*payment_preimage, payment_preimage_1);
7099                                         },
7100                                         _ => panic!("Unexpected event"),
7101                                 }
7102
7103                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
7104                                 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7105                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7106                                 check_added_monitors!(nodes[0], 1);
7107
7108                                 as_resp.1 = Some(as_resp_raa);
7109                                 bs_resp.2 = None;
7110                         }
7111
7112                         if disconnect_count & !disconnect_flags > 1 {
7113                                 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
7114
7115                                 if (disconnect_count & 16) == 0 {
7116                                         assert!(reestablish_1 == second_reestablish_1);
7117                                         assert!(reestablish_2 == second_reestablish_2);
7118                                 }
7119                                 assert!(as_resp == second_as_resp);
7120                                 assert!(bs_resp == second_bs_resp);
7121                         }
7122
7123                         (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
7124                 } else {
7125                         let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
7126                         assert_eq!(events_4.len(), 2);
7127                         (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
7128                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
7129                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7130                                         msg.clone()
7131                                 },
7132                                 _ => panic!("Unexpected event"),
7133                         })
7134                 };
7135
7136                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
7137
7138                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
7139                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
7140                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7141                 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
7142                 check_added_monitors!(nodes[1], 1);
7143
7144                 if disconnect_count & !disconnect_flags > 2 {
7145                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7146
7147                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
7148                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
7149
7150                         assert!(as_resp.2.is_none());
7151                         assert!(bs_resp.2.is_none());
7152                 }
7153
7154                 let as_commitment_update;
7155                 let bs_second_commitment_update;
7156
7157                 macro_rules! handle_bs_raa { () => {
7158                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
7159                         as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7160                         assert!(as_commitment_update.update_add_htlcs.is_empty());
7161                         assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
7162                         assert!(as_commitment_update.update_fail_htlcs.is_empty());
7163                         assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
7164                         assert!(as_commitment_update.update_fee.is_none());
7165                         check_added_monitors!(nodes[0], 1);
7166                 } }
7167
7168                 macro_rules! handle_initial_raa { () => {
7169                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
7170                         bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7171                         assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
7172                         assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
7173                         assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
7174                         assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
7175                         assert!(bs_second_commitment_update.update_fee.is_none());
7176                         check_added_monitors!(nodes[1], 1);
7177                 } }
7178
7179                 if (disconnect_count & 8) == 0 {
7180                         handle_bs_raa!();
7181
7182                         if disconnect_count & !disconnect_flags > 3 {
7183                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7184
7185                                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
7186                                 assert!(bs_resp.1.is_none());
7187
7188                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7189                                 assert!(bs_resp.2.is_none());
7190
7191                                 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
7192                         }
7193
7194                         handle_initial_raa!();
7195
7196                         if disconnect_count & !disconnect_flags > 4 {
7197                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7198
7199                                 assert!(as_resp.1.is_none());
7200                                 assert!(bs_resp.1.is_none());
7201
7202                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7203                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7204                         }
7205                 } else {
7206                         handle_initial_raa!();
7207
7208                         if disconnect_count & !disconnect_flags > 3 {
7209                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7210
7211                                 assert!(as_resp.1.is_none());
7212                                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
7213
7214                                 assert!(as_resp.2.is_none());
7215                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7216
7217                                 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
7218                         }
7219
7220                         handle_bs_raa!();
7221
7222                         if disconnect_count & !disconnect_flags > 4 {
7223                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7224
7225                                 assert!(as_resp.1.is_none());
7226                                 assert!(bs_resp.1.is_none());
7227
7228                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7229                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7230                         }
7231                 }
7232
7233                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
7234                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7235                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7236                 check_added_monitors!(nodes[0], 1);
7237
7238                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
7239                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7240                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7241                 check_added_monitors!(nodes[1], 1);
7242
7243                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
7244                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7245                 check_added_monitors!(nodes[1], 1);
7246
7247                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
7248                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7249                 check_added_monitors!(nodes[0], 1);
7250
7251                 expect_pending_htlcs_forwardable!(nodes[1]);
7252
7253                 let events_5 = nodes[1].node.get_and_clear_pending_events();
7254                 assert_eq!(events_5.len(), 1);
7255                 match events_5[0] {
7256                         Event::PaymentReceived { ref payment_hash, amt } => {
7257                                 assert_eq!(payment_hash_2, *payment_hash);
7258                                 assert_eq!(amt, 1000000);
7259                         },
7260                         _ => panic!("Unexpected event"),
7261                 }
7262
7263                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
7264         }
7265
7266         #[test]
7267         fn test_monitor_temporary_update_fail_a() {
7268                 do_test_monitor_temporary_update_fail(0);
7269                 do_test_monitor_temporary_update_fail(1);
7270                 do_test_monitor_temporary_update_fail(2);
7271                 do_test_monitor_temporary_update_fail(3);
7272                 do_test_monitor_temporary_update_fail(4);
7273                 do_test_monitor_temporary_update_fail(5);
7274         }
7275
7276         #[test]
7277         fn test_monitor_temporary_update_fail_b() {
7278                 do_test_monitor_temporary_update_fail(2 | 8);
7279                 do_test_monitor_temporary_update_fail(3 | 8);
7280                 do_test_monitor_temporary_update_fail(4 | 8);
7281                 do_test_monitor_temporary_update_fail(5 | 8);
7282         }
7283
7284         #[test]
7285         fn test_monitor_temporary_update_fail_c() {
7286                 do_test_monitor_temporary_update_fail(1 | 16);
7287                 do_test_monitor_temporary_update_fail(2 | 16);
7288                 do_test_monitor_temporary_update_fail(3 | 16);
7289                 do_test_monitor_temporary_update_fail(2 | 8 | 16);
7290                 do_test_monitor_temporary_update_fail(3 | 8 | 16);
7291         }
7292
7293         #[test]
7294         fn test_invalid_channel_announcement() {
7295                 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
7296                 let secp_ctx = Secp256k1::new();
7297                 let nodes = create_network(2);
7298
7299                 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
7300
7301                 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
7302                 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
7303                 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
7304                 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
7305
7306                 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
7307
7308                 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
7309                 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
7310
7311                 let as_network_key = nodes[0].node.get_our_node_id();
7312                 let bs_network_key = nodes[1].node.get_our_node_id();
7313
7314                 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
7315
7316                 let mut chan_announcement;
7317
7318                 macro_rules! dummy_unsigned_msg {
7319                         () => {
7320                                 msgs::UnsignedChannelAnnouncement {
7321                                         features: msgs::GlobalFeatures::new(),
7322                                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
7323                                         short_channel_id: as_chan.get_short_channel_id().unwrap(),
7324                                         node_id_1: if were_node_one { as_network_key } else { bs_network_key },
7325                                         node_id_2: if were_node_one { bs_network_key } else { as_network_key },
7326                                         bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
7327                                         bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
7328                                         excess_data: Vec::new(),
7329                                 };
7330                         }
7331                 }
7332
7333                 macro_rules! sign_msg {
7334                         ($unsigned_msg: expr) => {
7335                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
7336                                 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
7337                                 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
7338                                 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
7339                                 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
7340                                 chan_announcement = msgs::ChannelAnnouncement {
7341                                         node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
7342                                         node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
7343                                         bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
7344                                         bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
7345                                         contents: $unsigned_msg
7346                                 }
7347                         }
7348                 }
7349
7350                 let unsigned_msg = dummy_unsigned_msg!();
7351                 sign_msg!(unsigned_msg);
7352                 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
7353                 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
7354
7355                 // Configured with Network::Testnet
7356                 let mut unsigned_msg = dummy_unsigned_msg!();
7357                 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
7358                 sign_msg!(unsigned_msg);
7359                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
7360
7361                 let mut unsigned_msg = dummy_unsigned_msg!();
7362                 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
7363                 sign_msg!(unsigned_msg);
7364                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
7365         }
7366
7367         struct VecWriter(Vec<u8>);
7368         impl Writer for VecWriter {
7369                 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
7370                         self.0.extend_from_slice(buf);
7371                         Ok(())
7372                 }
7373                 fn size_hint(&mut self, size: usize) {
7374                         self.0.reserve_exact(size);
7375                 }
7376         }
7377
7378         #[test]
7379         fn test_no_txn_manager_serialize_deserialize() {
7380                 let mut nodes = create_network(2);
7381
7382                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
7383
7384                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7385
7386                 let nodes_0_serialized = nodes[0].node.encode();
7387                 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
7388                 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
7389
7390                 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
7391                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
7392                 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
7393                 assert!(chan_0_monitor_read.is_empty());
7394
7395                 let mut nodes_0_read = &nodes_0_serialized[..];
7396                 let config = UserConfig::new();
7397                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
7398                 let (_, nodes_0_deserialized) = {
7399                         let mut channel_monitors = HashMap::new();
7400                         channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
7401                         <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
7402                                 default_config: config,
7403                                 keys_manager,
7404                                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
7405                                 monitor: nodes[0].chan_monitor.clone(),
7406                                 chain_monitor: nodes[0].chain_monitor.clone(),
7407                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
7408                                 logger: Arc::new(test_utils::TestLogger::new()),
7409                                 channel_monitors: &channel_monitors,
7410                         }).unwrap()
7411                 };
7412                 assert!(nodes_0_read.is_empty());
7413
7414                 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
7415                 nodes[0].node = Arc::new(nodes_0_deserialized);
7416                 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
7417                 nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
7418                 assert_eq!(nodes[0].node.list_channels().len(), 1);
7419                 check_added_monitors!(nodes[0], 1);
7420
7421                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7422                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7423                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7424                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7425
7426                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7427                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7428                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7429                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7430
7431                 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
7432                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
7433                 for node in nodes.iter() {
7434                         assert!(node.router.handle_channel_announcement(&announcement).unwrap());
7435                         node.router.handle_channel_update(&as_update).unwrap();
7436                         node.router.handle_channel_update(&bs_update).unwrap();
7437                 }
7438
7439                 send_payment(&nodes[0], &[&nodes[1]], 1000000);
7440         }
7441
7442         #[test]
7443         fn test_simple_manager_serialize_deserialize() {
7444                 let mut nodes = create_network(2);
7445                 create_announced_chan_between_nodes(&nodes, 0, 1);
7446
7447                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7448                 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7449
7450                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7451
7452                 let nodes_0_serialized = nodes[0].node.encode();
7453                 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
7454                 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
7455
7456                 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
7457                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
7458                 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
7459                 assert!(chan_0_monitor_read.is_empty());
7460
7461                 let mut nodes_0_read = &nodes_0_serialized[..];
7462                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
7463                 let (_, nodes_0_deserialized) = {
7464                         let mut channel_monitors = HashMap::new();
7465                         channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
7466                         <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
7467                                 default_config: UserConfig::new(),
7468                                 keys_manager,
7469                                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
7470                                 monitor: nodes[0].chan_monitor.clone(),
7471                                 chain_monitor: nodes[0].chain_monitor.clone(),
7472                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
7473                                 logger: Arc::new(test_utils::TestLogger::new()),
7474                                 channel_monitors: &channel_monitors,
7475                         }).unwrap()
7476                 };
7477                 assert!(nodes_0_read.is_empty());
7478
7479                 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
7480                 nodes[0].node = Arc::new(nodes_0_deserialized);
7481                 check_added_monitors!(nodes[0], 1);
7482
7483                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7484
7485                 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
7486                 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
7487         }
7488
7489         #[test]
7490         fn test_manager_serialize_deserialize_inconsistent_monitor() {
7491                 // Test deserializing a ChannelManager with a out-of-date ChannelMonitor
7492                 let mut nodes = create_network(4);
7493                 create_announced_chan_between_nodes(&nodes, 0, 1);
7494                 create_announced_chan_between_nodes(&nodes, 2, 0);
7495                 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
7496
7497                 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
7498
7499                 // Serialize the ChannelManager here, but the monitor we keep up-to-date
7500                 let nodes_0_serialized = nodes[0].node.encode();
7501
7502                 route_payment(&nodes[0], &[&nodes[3]], 1000000);
7503                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7504                 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7505                 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7506
7507                 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
7508                 // nodes[3])
7509                 let mut node_0_monitors_serialized = Vec::new();
7510                 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
7511                         let mut writer = VecWriter(Vec::new());
7512                         monitor.1.write_for_disk(&mut writer).unwrap();
7513                         node_0_monitors_serialized.push(writer.0);
7514                 }
7515
7516                 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
7517                 let mut node_0_monitors = Vec::new();
7518                 for serialized in node_0_monitors_serialized.iter() {
7519                         let mut read = &serialized[..];
7520                         let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
7521                         assert!(read.is_empty());
7522                         node_0_monitors.push(monitor);
7523                 }
7524
7525                 let mut nodes_0_read = &nodes_0_serialized[..];
7526                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
7527                 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
7528                         default_config: UserConfig::new(),
7529                         keys_manager,
7530                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
7531                         monitor: nodes[0].chan_monitor.clone(),
7532                         chain_monitor: nodes[0].chain_monitor.clone(),
7533                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
7534                         logger: Arc::new(test_utils::TestLogger::new()),
7535                         channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
7536                 }).unwrap();
7537                 assert!(nodes_0_read.is_empty());
7538
7539                 { // Channel close should result in a commitment tx and an HTLC tx
7540                         let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7541                         assert_eq!(txn.len(), 2);
7542                         assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
7543                         assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
7544                 }
7545
7546                 for monitor in node_0_monitors.drain(..) {
7547                         assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
7548                         check_added_monitors!(nodes[0], 1);
7549                 }
7550                 nodes[0].node = Arc::new(nodes_0_deserialized);
7551
7552                 // nodes[1] and nodes[2] have no lost state with nodes[0]...
7553                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7554                 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7555                 //... and we can even still claim the payment!
7556                 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
7557
7558                 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
7559                 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7560                 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
7561                 if let Err(msgs::HandleError { action: Some(msgs::ErrorAction::SendErrorMessage { msg }), .. }) = nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish) {
7562                         assert_eq!(msg.channel_id, channel_id);
7563                 } else { panic!("Unexpected result"); }
7564         }
7565
7566         macro_rules! check_dynamic_output_p2wsh {
7567                 ($node: expr) => {
7568                         {
7569                                 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
7570                                 let mut txn = Vec::new();
7571                                 for event in events {
7572                                         match event {
7573                                                 Event::SpendableOutputs { ref outputs } => {
7574                                                         for outp in outputs {
7575                                                                 match *outp {
7576                                                                         SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
7577                                                                                 let input = TxIn {
7578                                                                                         previous_output: outpoint.clone(),
7579                                                                                         script_sig: Script::new(),
7580                                                                                         sequence: *to_self_delay as u32,
7581                                                                                         witness: Vec::new(),
7582                                                                                 };
7583                                                                                 let outp = TxOut {
7584                                                                                         script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
7585                                                                                         value: output.value,
7586                                                                                 };
7587                                                                                 let mut spend_tx = Transaction {
7588                                                                                         version: 2,
7589                                                                                         lock_time: 0,
7590                                                                                         input: vec![input],
7591                                                                                         output: vec![outp],
7592                                                                                 };
7593                                                                                 let secp_ctx = Secp256k1::new();
7594                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
7595                                                                                 let local_delaysig = secp_ctx.sign(&sighash, key);
7596                                                                                 spend_tx.input[0].witness.push(local_delaysig.serialize_der(&secp_ctx).to_vec());
7597                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
7598                                                                                 spend_tx.input[0].witness.push(vec!(0));
7599                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
7600                                                                                 txn.push(spend_tx);
7601                                                                         },
7602                                                                         _ => panic!("Unexpected event"),
7603                                                                 }
7604                                                         }
7605                                                 },
7606                                                 _ => panic!("Unexpected event"),
7607                                         };
7608                                 }
7609                                 txn
7610                         }
7611                 }
7612         }
7613
7614         macro_rules! check_dynamic_output_p2wpkh {
7615                 ($node: expr) => {
7616                         {
7617                                 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
7618                                 let mut txn = Vec::new();
7619                                 for event in events {
7620                                         match event {
7621                                                 Event::SpendableOutputs { ref outputs } => {
7622                                                         for outp in outputs {
7623                                                                 match *outp {
7624                                                                         SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
7625                                                                                 let input = TxIn {
7626                                                                                         previous_output: outpoint.clone(),
7627                                                                                         script_sig: Script::new(),
7628                                                                                         sequence: 0,
7629                                                                                         witness: Vec::new(),
7630                                                                                 };
7631                                                                                 let outp = TxOut {
7632                                                                                         script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
7633                                                                                         value: output.value,
7634                                                                                 };
7635                                                                                 let mut spend_tx = Transaction {
7636                                                                                         version: 2,
7637                                                                                         lock_time: 0,
7638                                                                                         input: vec![input],
7639                                                                                         output: vec![outp],
7640                                                                                 };
7641                                                                                 let secp_ctx = Secp256k1::new();
7642                                                                                 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
7643                                                                                 let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
7644                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
7645                                                                                 let remotesig = secp_ctx.sign(&sighash, key);
7646                                                                                 spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
7647                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
7648                                                                                 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
7649                                                                                 txn.push(spend_tx);
7650                                                                         },
7651                                                                         _ => panic!("Unexpected event"),
7652                                                                 }
7653                                                         }
7654                                                 },
7655                                                 _ => panic!("Unexpected event"),
7656                                         };
7657                                 }
7658                                 txn
7659                         }
7660                 }
7661         }
7662
7663         macro_rules! check_static_output {
7664                 ($event: expr, $node: expr, $event_idx: expr, $output_idx: expr, $der_idx: expr, $idx_node: expr) => {
7665                         match $event[$event_idx] {
7666                                 Event::SpendableOutputs { ref outputs } => {
7667                                         match outputs[$output_idx] {
7668                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
7669                                                         let secp_ctx = Secp256k1::new();
7670                                                         let input = TxIn {
7671                                                                 previous_output: outpoint.clone(),
7672                                                                 script_sig: Script::new(),
7673                                                                 sequence: 0,
7674                                                                 witness: Vec::new(),
7675                                                         };
7676                                                         let outp = TxOut {
7677                                                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
7678                                                                 value: output.value,
7679                                                         };
7680                                                         let mut spend_tx = Transaction {
7681                                                                 version: 2,
7682                                                                 lock_time: 0,
7683                                                                 input: vec![input],
7684                                                                 output: vec![outp.clone()],
7685                                                         };
7686                                                         let secret = {
7687                                                                 match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node[$idx_node].node_seed) {
7688                                                                         Ok(master_key) => {
7689                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
7690                                                                                         Ok(key) => key,
7691                                                                                         Err(_) => panic!("Your RNG is busted"),
7692                                                                                 }
7693                                                                         }
7694                                                                         Err(_) => panic!("Your rng is busted"),
7695                                                                 }
7696                                                         };
7697                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
7698                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
7699                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
7700                                                         let sig = secp_ctx.sign(&sighash, &secret.secret_key);
7701                                                         spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
7702                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
7703                                                         spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
7704                                                         spend_tx
7705                                                 },
7706                                                 _ => panic!("Unexpected event !"),
7707                                         }
7708                                 },
7709                                 _ => panic!("Unexpected event !"),
7710                         };
7711                 }
7712         }
7713
7714         #[test]
7715         fn test_claim_sizeable_push_msat() {
7716                 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
7717                 let nodes = create_network(2);
7718
7719                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
7720                 nodes[1].node.force_close_channel(&chan.2);
7721                 let events = nodes[1].node.get_and_clear_pending_msg_events();
7722                 match events[0] {
7723                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7724                         _ => panic!("Unexpected event"),
7725                 }
7726                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7727                 assert_eq!(node_txn.len(), 1);
7728                 check_spends!(node_txn[0], chan.3.clone());
7729                 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
7730
7731                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7732                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
7733                 let spend_txn = check_dynamic_output_p2wsh!(nodes[1]);
7734                 assert_eq!(spend_txn.len(), 1);
7735                 check_spends!(spend_txn[0], node_txn[0].clone());
7736         }
7737
7738         #[test]
7739         fn test_claim_on_remote_sizeable_push_msat() {
7740                 // Same test as precedent, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
7741                 // to_remote output is encumbered by a P2WPKH
7742
7743                 let nodes = create_network(2);
7744
7745                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
7746                 nodes[0].node.force_close_channel(&chan.2);
7747                 let events = nodes[0].node.get_and_clear_pending_msg_events();
7748                 match events[0] {
7749                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7750                         _ => panic!("Unexpected event"),
7751                 }
7752                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7753                 assert_eq!(node_txn.len(), 1);
7754                 check_spends!(node_txn[0], chan.3.clone());
7755                 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
7756
7757                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7758                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
7759                 let events = nodes[1].node.get_and_clear_pending_msg_events();
7760                 match events[0] {
7761                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7762                         _ => panic!("Unexpected event"),
7763                 }
7764                 let spend_txn = check_dynamic_output_p2wpkh!(nodes[1]);
7765                 assert_eq!(spend_txn.len(), 2);
7766                 assert_eq!(spend_txn[0], spend_txn[1]);
7767                 check_spends!(spend_txn[0], node_txn[0].clone());
7768         }
7769
7770         #[test]
7771         fn test_static_spendable_outputs_preimage_tx() {
7772                 let nodes = create_network(2);
7773
7774                 // Create some initial channels
7775                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7776
7777                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7778
7779                 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7780                 assert_eq!(commitment_tx[0].input.len(), 1);
7781                 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
7782
7783                 // Settle A's commitment tx on B's chain
7784                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7785                 assert!(nodes[1].node.claim_funds(payment_preimage));
7786                 check_added_monitors!(nodes[1], 1);
7787                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
7788                 let events = nodes[1].node.get_and_clear_pending_msg_events();
7789                 match events[0] {
7790                         MessageSendEvent::UpdateHTLCs { .. } => {},
7791                         _ => panic!("Unexpected event"),
7792                 }
7793                 match events[1] {
7794                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7795                         _ => panic!("Unexepected event"),
7796                 }
7797
7798                 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
7799                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
7800                 check_spends!(node_txn[0], commitment_tx[0].clone());
7801                 assert_eq!(node_txn[0], node_txn[2]);
7802                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 133);
7803                 check_spends!(node_txn[1], chan_1.3.clone());
7804
7805                 let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
7806                 let spend_tx = check_static_output!(events, nodes, 0, 0, 1, 1);
7807                 check_spends!(spend_tx, node_txn[0].clone());
7808         }
7809
7810         #[test]
7811         fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
7812                 let nodes = create_network(2);
7813
7814                 // Create some initial channels
7815                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7816
7817                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7818                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
7819                 assert_eq!(revoked_local_txn[0].input.len(), 1);
7820                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
7821
7822                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7823
7824                 let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7825                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7826                 let events = nodes[1].node.get_and_clear_pending_msg_events();
7827                 match events[0] {
7828                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7829                         _ => panic!("Unexpected event"),
7830                 }
7831                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7832                 assert_eq!(node_txn.len(), 3);
7833                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
7834                 assert_eq!(node_txn[0].input.len(), 2);
7835                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7836
7837                 let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
7838                 let spend_tx = check_static_output!(events, nodes, 0, 0, 1, 1);
7839                 check_spends!(spend_tx, node_txn[0].clone());
7840         }
7841
7842         #[test]
7843         fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
7844                 let nodes = create_network(2);
7845
7846                 // Create some initial channels
7847                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7848
7849                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7850                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7851                 assert_eq!(revoked_local_txn[0].input.len(), 1);
7852                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
7853
7854                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7855
7856                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7857                 // A will generate HTLC-Timeout from revoked commitment tx
7858                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7859                 let events = nodes[0].node.get_and_clear_pending_msg_events();
7860                 match events[0] {
7861                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7862                         _ => panic!("Unexpected event"),
7863                 }
7864                 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7865                 assert_eq!(revoked_htlc_txn.len(), 2);
7866                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7867                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), 133);
7868                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
7869
7870                 // B will generate justice tx from A's revoked commitment/HTLC tx
7871                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
7872                 let events = nodes[1].node.get_and_clear_pending_msg_events();
7873                 match events[0] {
7874                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7875                         _ => panic!("Unexpected event"),
7876                 }
7877
7878                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7879                 assert_eq!(node_txn.len(), 4);
7880                 assert_eq!(node_txn[3].input.len(), 1);
7881                 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
7882
7883                 let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
7884                 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
7885                 let spend_tx = check_static_output!(events, nodes, 1, 1, 1, 1);
7886                 check_spends!(spend_tx, node_txn[3].clone());
7887         }
7888
7889         #[test]
7890         fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
7891                 let nodes = create_network(2);
7892
7893                 // Create some initial channels
7894                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7895
7896                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7897                 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7898                 assert_eq!(revoked_local_txn[0].input.len(), 1);
7899                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
7900
7901                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7902
7903                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7904                 // B will generate HTLC-Success from revoked commitment tx
7905                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7906                 let events = nodes[1].node.get_and_clear_pending_msg_events();
7907                 match events[0] {
7908                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7909                         _ => panic!("Unexpected event"),
7910                 }
7911                 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7912
7913                 assert_eq!(revoked_htlc_txn.len(), 2);
7914                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7915                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), 138);
7916                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
7917
7918                 // A will generate justice tx from B's revoked commitment/HTLC tx
7919                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
7920                 let events = nodes[0].node.get_and_clear_pending_msg_events();
7921                 match events[0] {
7922                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7923                         _ => panic!("Unexpected event"),
7924                 }
7925
7926                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7927                 assert_eq!(node_txn.len(), 4);
7928                 assert_eq!(node_txn[3].input.len(), 1);
7929                 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
7930
7931                 let events = nodes[0].chan_monitor.simple_monitor.get_and_clear_pending_events();
7932                 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
7933                 let spend_tx = check_static_output!(events, nodes, 1, 2, 1, 0);
7934                 check_spends!(spend_tx, node_txn[3].clone());
7935         }
7936
7937         #[test]
7938         fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
7939                 let nodes = create_network(2);
7940
7941                 // Create some initial channels
7942                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7943
7944                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
7945                 let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7946                 assert_eq!(local_txn[0].input.len(), 1);
7947                 check_spends!(local_txn[0], chan_1.3.clone());
7948
7949                 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
7950                 nodes[1].node.claim_funds(payment_preimage);
7951                 check_added_monitors!(nodes[1], 1);
7952                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7953                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
7954                 let events = nodes[1].node.get_and_clear_pending_msg_events();
7955                 match events[0] {
7956                         MessageSendEvent::UpdateHTLCs { .. } => {},
7957                         _ => panic!("Unexpected event"),
7958                 }
7959                 match events[1] {
7960                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7961                         _ => panic!("Unexepected event"),
7962                 }
7963                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7964                 assert_eq!(node_txn[0].input.len(), 1);
7965                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 138);
7966                 check_spends!(node_txn[0], local_txn[0].clone());
7967
7968                 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
7969                 let spend_txn = check_dynamic_output_p2wsh!(nodes[1]);
7970                 assert_eq!(spend_txn.len(), 1);
7971                 check_spends!(spend_txn[0], node_txn[0].clone());
7972         }
7973
7974         #[test]
7975         fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
7976                 let nodes = create_network(2);
7977
7978                 // Create some initial channels
7979                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7980
7981                 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
7982                 let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7983                 assert_eq!(local_txn[0].input.len(), 1);
7984                 check_spends!(local_txn[0], chan_1.3.clone());
7985
7986                 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
7987                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7988                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
7989                 let events = nodes[0].node.get_and_clear_pending_msg_events();
7990                 match events[0] {
7991                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7992                         _ => panic!("Unexepected event"),
7993                 }
7994                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7995                 assert_eq!(node_txn[0].input.len(), 1);
7996                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 133);
7997                 check_spends!(node_txn[0], local_txn[0].clone());
7998
7999                 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
8000                 let spend_txn = check_dynamic_output_p2wsh!(nodes[0]);
8001                 assert_eq!(spend_txn.len(), 4);
8002                 assert_eq!(spend_txn[0], spend_txn[2]);
8003                 assert_eq!(spend_txn[1], spend_txn[3]);
8004                 check_spends!(spend_txn[0], local_txn[0].clone());
8005                 check_spends!(spend_txn[1], node_txn[0].clone());
8006         }
8007
8008         #[test]
8009         fn test_static_output_closing_tx() {
8010                 let nodes = create_network(2);
8011
8012                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
8013
8014                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
8015                 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
8016
8017                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8018                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
8019                 let events = nodes[0].chan_monitor.simple_monitor.get_and_clear_pending_events();
8020                 let spend_tx = check_static_output!(events, nodes, 0, 0, 2, 0);
8021                 check_spends!(spend_tx, closing_tx.clone());
8022
8023                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
8024                 let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
8025                 let spend_tx = check_static_output!(events, nodes, 0, 0, 2, 1);
8026                 check_spends!(spend_tx, closing_tx);
8027         }
8028 }