Add test for failing/fulfilling HTLCs from on-chain actions
[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, PartialEq)]
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, PartialEq)]
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 type ShutdownResult = (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>);
137
138 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
139 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
140 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
141 /// channel_state lock. We then return the set of things that need to be done outside the lock in
142 /// this struct and call handle_error!() on it.
143 struct MsgHandleErrInternal {
144         err: msgs::HandleError,
145         shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
146 }
147 impl MsgHandleErrInternal {
148         #[inline]
149         fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
150                 Self {
151                         err: HandleError {
152                                 err,
153                                 action: Some(msgs::ErrorAction::SendErrorMessage {
154                                         msg: msgs::ErrorMessage {
155                                                 channel_id,
156                                                 data: err.to_string()
157                                         },
158                                 }),
159                         },
160                         shutdown_finish: None,
161                 }
162         }
163         #[inline]
164         fn from_no_close(err: msgs::HandleError) -> Self {
165                 Self { err, shutdown_finish: None }
166         }
167         #[inline]
168         fn from_finish_shutdown(err: &'static str, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
169                 Self {
170                         err: HandleError {
171                                 err,
172                                 action: Some(msgs::ErrorAction::SendErrorMessage {
173                                         msg: msgs::ErrorMessage {
174                                                 channel_id,
175                                                 data: err.to_string()
176                                         },
177                                 }),
178                         },
179                         shutdown_finish: Some((shutdown_res, channel_update)),
180                 }
181         }
182         #[inline]
183         fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
184                 Self {
185                         err: match err {
186                                 ChannelError::Ignore(msg) => HandleError {
187                                         err: msg,
188                                         action: Some(msgs::ErrorAction::IgnoreError),
189                                 },
190                                 ChannelError::Close(msg) => HandleError {
191                                         err: msg,
192                                         action: Some(msgs::ErrorAction::SendErrorMessage {
193                                                 msg: msgs::ErrorMessage {
194                                                         channel_id,
195                                                         data: msg.to_string()
196                                                 },
197                                         }),
198                                 },
199                         },
200                         shutdown_finish: None,
201                 }
202         }
203 }
204
205 /// Pass to fail_htlc_backwwards to indicate the reason to fail the payment
206 /// after a PaymentReceived event.
207 #[derive(PartialEq)]
208 pub enum PaymentFailReason {
209         /// Indicate the preimage for payment_hash is not known after a PaymentReceived event
210         PreimageUnknown,
211         /// Indicate the payment amount is incorrect ( received is < expected or > 2*expected ) after a PaymentReceived event
212         AmountMismatch,
213 }
214
215 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
216 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
217 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
218 /// probably increase this significantly.
219 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
220
221 struct HTLCForwardInfo {
222         prev_short_channel_id: u64,
223         prev_htlc_id: u64,
224         forward_info: PendingForwardHTLCInfo,
225 }
226
227 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
228 /// be sent in the order they appear in the return value, however sometimes the order needs to be
229 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
230 /// they were originally sent). In those cases, this enum is also returned.
231 #[derive(Clone, PartialEq)]
232 pub(super) enum RAACommitmentOrder {
233         /// Send the CommitmentUpdate messages first
234         CommitmentFirst,
235         /// Send the RevokeAndACK message first
236         RevokeAndACKFirst,
237 }
238
239 struct ChannelHolder {
240         by_id: HashMap<[u8; 32], Channel>,
241         short_to_id: HashMap<u64, [u8; 32]>,
242         next_forward: Instant,
243         /// short channel id -> forward infos. Key of 0 means payments received
244         /// Note that while this is held in the same mutex as the channels themselves, no consistency
245         /// guarantees are made about there existing a channel with the short id here, nor the short
246         /// ids in the PendingForwardHTLCInfo!
247         forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
248         /// Note that while this is held in the same mutex as the channels themselves, no consistency
249         /// guarantees are made about the channels given here actually existing anymore by the time you
250         /// go to read them!
251         claimable_htlcs: HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
252         /// Messages to send to peers - pushed to in the same lock that they are generated in (except
253         /// for broadcast messages, where ordering isn't as strict).
254         pending_msg_events: Vec<events::MessageSendEvent>,
255 }
256 struct MutChannelHolder<'a> {
257         by_id: &'a mut HashMap<[u8; 32], Channel>,
258         short_to_id: &'a mut HashMap<u64, [u8; 32]>,
259         next_forward: &'a mut Instant,
260         forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
261         claimable_htlcs: &'a mut HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
262         pending_msg_events: &'a mut Vec<events::MessageSendEvent>,
263 }
264 impl ChannelHolder {
265         fn borrow_parts(&mut self) -> MutChannelHolder {
266                 MutChannelHolder {
267                         by_id: &mut self.by_id,
268                         short_to_id: &mut self.short_to_id,
269                         next_forward: &mut self.next_forward,
270                         forward_htlcs: &mut self.forward_htlcs,
271                         claimable_htlcs: &mut self.claimable_htlcs,
272                         pending_msg_events: &mut self.pending_msg_events,
273                 }
274         }
275 }
276
277 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
278 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
279
280 /// Manager which keeps track of a number of channels and sends messages to the appropriate
281 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
282 ///
283 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
284 /// to individual Channels.
285 ///
286 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
287 /// all peers during write/read (though does not modify this instance, only the instance being
288 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
289 /// called funding_transaction_generated for outbound channels).
290 ///
291 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
292 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
293 /// returning from ManyChannelMonitor::add_update_monitor, with ChannelManagers, writing updates
294 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
295 /// the serialization process). If the deserialized version is out-of-date compared to the
296 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
297 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
298 ///
299 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
300 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
301 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
302 /// block_connected() to step towards your best block) upon deserialization before using the
303 /// object!
304 pub struct ChannelManager {
305         default_configuration: UserConfig,
306         genesis_hash: Sha256dHash,
307         fee_estimator: Arc<FeeEstimator>,
308         monitor: Arc<ManyChannelMonitor>,
309         chain_monitor: Arc<ChainWatchInterface>,
310         tx_broadcaster: Arc<BroadcasterInterface>,
311
312         latest_block_height: AtomicUsize,
313         last_block_hash: Mutex<Sha256dHash>,
314         secp_ctx: Secp256k1<secp256k1::All>,
315
316         channel_state: Mutex<ChannelHolder>,
317         our_network_key: SecretKey,
318
319         pending_events: Mutex<Vec<events::Event>>,
320         /// Used when we have to take a BIG lock to make sure everything is self-consistent.
321         /// Essentially just when we're serializing ourselves out.
322         /// Taken first everywhere where we are making changes before any other locks.
323         total_consistency_lock: RwLock<()>,
324
325         keys_manager: Arc<KeysInterface>,
326
327         logger: Arc<Logger>,
328 }
329
330 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
331 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
332 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
333 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
334 /// CLTV_CLAIM_BUFFER point (we static assert that its at least 3 blocks more).
335 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
336 const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
337
338 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + 2*HTLC_FAIL_TIMEOUT_BLOCKS, ie that
339 // if the next-hop peer fails the HTLC within HTLC_FAIL_TIMEOUT_BLOCKS then we'll still have
340 // HTLC_FAIL_TIMEOUT_BLOCKS left to fail it backwards ourselves before hitting the
341 // CLTV_CLAIM_BUFFER point and failing the channel on-chain to time out the HTLC.
342 #[deny(const_err)]
343 #[allow(dead_code)]
344 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - 2*HTLC_FAIL_TIMEOUT_BLOCKS - CLTV_CLAIM_BUFFER;
345
346 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
347 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
348 #[deny(const_err)]
349 #[allow(dead_code)]
350 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - HTLC_FAIL_TIMEOUT_BLOCKS - 2*CLTV_CLAIM_BUFFER;
351
352 macro_rules! secp_call {
353         ( $res: expr, $err: expr ) => {
354                 match $res {
355                         Ok(key) => key,
356                         Err(_) => return Err($err),
357                 }
358         };
359 }
360
361 struct OnionKeys {
362         #[cfg(test)]
363         shared_secret: SharedSecret,
364         #[cfg(test)]
365         blinding_factor: [u8; 32],
366         ephemeral_pubkey: PublicKey,
367         rho: [u8; 32],
368         mu: [u8; 32],
369 }
370
371 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
372 pub struct ChannelDetails {
373         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
374         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
375         /// Note that this means this value is *not* persistent - it can change once during the
376         /// lifetime of the channel.
377         pub channel_id: [u8; 32],
378         /// The position of the funding transaction in the chain. None if the funding transaction has
379         /// not yet been confirmed and the channel fully opened.
380         pub short_channel_id: Option<u64>,
381         /// The node_id of our counterparty
382         pub remote_network_id: PublicKey,
383         /// The value, in satoshis, of this channel as appears in the funding output
384         pub channel_value_satoshis: u64,
385         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
386         pub user_id: u64,
387 }
388
389 macro_rules! handle_error {
390         ($self: ident, $internal: expr, $their_node_id: expr) => {
391                 match $internal {
392                         Ok(msg) => Ok(msg),
393                         Err(MsgHandleErrInternal { err, shutdown_finish }) => {
394                                 if let Some((shutdown_res, update_option)) = shutdown_finish {
395                                         $self.finish_force_close_channel(shutdown_res);
396                                         if let Some(update) = update_option {
397                                                 let mut channel_state = $self.channel_state.lock().unwrap();
398                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
399                                                         msg: update
400                                                 });
401                                         }
402                                 }
403                                 Err(err)
404                         },
405                 }
406         }
407 }
408
409 macro_rules! break_chan_entry {
410         ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
411                 match $res {
412                         Ok(res) => res,
413                         Err(ChannelError::Ignore(msg)) => {
414                                 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
415                         },
416                         Err(ChannelError::Close(msg)) => {
417                                 let (channel_id, mut chan) = $entry.remove_entry();
418                                 if let Some(short_id) = chan.get_short_channel_id() {
419                                         $channel_state.short_to_id.remove(&short_id);
420                                 }
421                                 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
422                         },
423                 }
424         }
425 }
426
427 macro_rules! try_chan_entry {
428         ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
429                 match $res {
430                         Ok(res) => res,
431                         Err(ChannelError::Ignore(msg)) => {
432                                 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
433                         },
434                         Err(ChannelError::Close(msg)) => {
435                                 let (channel_id, mut chan) = $entry.remove_entry();
436                                 if let Some(short_id) = chan.get_short_channel_id() {
437                                         $channel_state.short_to_id.remove(&short_id);
438                                 }
439                                 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
440                         },
441                 }
442         }
443 }
444
445 macro_rules! return_monitor_err {
446         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path) => {
447                 return_monitor_err!($self, $err, $channel_state, $entry, $action_type, Vec::new(), Vec::new())
448         };
449         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $raa_first_dropped_cs: expr) => {
450                 if $action_type != RAACommitmentOrder::RevokeAndACKFirst { panic!("Bad return_monitor_err call!"); }
451                 return_monitor_err!($self, $err, $channel_state, $entry, $action_type, Vec::new(), Vec::new(), $raa_first_dropped_cs)
452         };
453         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $failed_forwards: expr, $failed_fails: expr) => {
454                 return_monitor_err!($self, $err, $channel_state, $entry, $action_type, $failed_forwards, $failed_fails, false)
455         };
456         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $failed_forwards: expr, $failed_fails: expr, $raa_first_dropped_cs: expr) => {
457                 match $err {
458                         ChannelMonitorUpdateErr::PermanentFailure => {
459                                 let (channel_id, mut chan) = $entry.remove_entry();
460                                 if let Some(short_id) = chan.get_short_channel_id() {
461                                         $channel_state.short_to_id.remove(&short_id);
462                                 }
463                                 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
464                                 // chain in a confused state! We need to move them into the ChannelMonitor which
465                                 // will be responsible for failing backwards once things confirm on-chain.
466                                 // It's ok that we drop $failed_forwards here - at this point we'd rather they
467                                 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
468                                 // us bother trying to claim it just to forward on to another peer. If we're
469                                 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
470                                 // given up the preimage yet, so might as well just wait until the payment is
471                                 // retried, avoiding the on-chain fees.
472                                 return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
473                         },
474                         ChannelMonitorUpdateErr::TemporaryFailure => {
475                                 $entry.get_mut().monitor_update_failed($action_type, $failed_forwards, $failed_fails, $raa_first_dropped_cs);
476                                 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()));
477                         },
478                 }
479         }
480 }
481
482 // Does not break in case of TemporaryFailure!
483 macro_rules! maybe_break_monitor_err {
484         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path) => {
485                 match $err {
486                         ChannelMonitorUpdateErr::PermanentFailure => {
487                                 let (channel_id, mut chan) = $entry.remove_entry();
488                                 if let Some(short_id) = chan.get_short_channel_id() {
489                                         $channel_state.short_to_id.remove(&short_id);
490                                 }
491                                 break Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
492                         },
493                         ChannelMonitorUpdateErr::TemporaryFailure => {
494                                 $entry.get_mut().monitor_update_failed($action_type, Vec::new(), Vec::new(), false);
495                         },
496                 }
497         }
498 }
499
500 impl ChannelManager {
501         /// Constructs a new ChannelManager to hold several channels and route between them.
502         ///
503         /// This is the main "logic hub" for all channel-related actions, and implements
504         /// ChannelMessageHandler.
505         ///
506         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
507         ///
508         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
509         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> {
510                 let secp_ctx = Secp256k1::new();
511
512                 let res = Arc::new(ChannelManager {
513                         default_configuration: config.clone(),
514                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
515                         fee_estimator: feeest.clone(),
516                         monitor: monitor.clone(),
517                         chain_monitor,
518                         tx_broadcaster,
519
520                         latest_block_height: AtomicUsize::new(0), //TODO: Get an init value
521                         last_block_hash: Mutex::new(Default::default()),
522                         secp_ctx,
523
524                         channel_state: Mutex::new(ChannelHolder{
525                                 by_id: HashMap::new(),
526                                 short_to_id: HashMap::new(),
527                                 next_forward: Instant::now(),
528                                 forward_htlcs: HashMap::new(),
529                                 claimable_htlcs: HashMap::new(),
530                                 pending_msg_events: Vec::new(),
531                         }),
532                         our_network_key: keys_manager.get_node_secret(),
533
534                         pending_events: Mutex::new(Vec::new()),
535                         total_consistency_lock: RwLock::new(()),
536
537                         keys_manager,
538
539                         logger,
540                 });
541                 let weak_res = Arc::downgrade(&res);
542                 res.chain_monitor.register_listener(weak_res);
543                 Ok(res)
544         }
545
546         /// Creates a new outbound channel to the given remote node and with the given value.
547         ///
548         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
549         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
550         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
551         /// may wish to avoid using 0 for user_id here.
552         ///
553         /// If successful, will generate a SendOpenChannel message event, so you should probably poll
554         /// PeerManager::process_events afterwards.
555         ///
556         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
557         /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
558         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
559                 if channel_value_satoshis < 1000 {
560                         return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
561                 }
562
563                 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)?;
564                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
565
566                 let _ = self.total_consistency_lock.read().unwrap();
567                 let mut channel_state = self.channel_state.lock().unwrap();
568                 match channel_state.by_id.entry(channel.channel_id()) {
569                         hash_map::Entry::Occupied(_) => {
570                                 if cfg!(feature = "fuzztarget") {
571                                         return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
572                                 } else {
573                                         panic!("RNG is bad???");
574                                 }
575                         },
576                         hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
577                 }
578                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
579                         node_id: their_network_key,
580                         msg: res,
581                 });
582                 Ok(())
583         }
584
585         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
586         /// more information.
587         pub fn list_channels(&self) -> Vec<ChannelDetails> {
588                 let channel_state = self.channel_state.lock().unwrap();
589                 let mut res = Vec::with_capacity(channel_state.by_id.len());
590                 for (channel_id, channel) in channel_state.by_id.iter() {
591                         res.push(ChannelDetails {
592                                 channel_id: (*channel_id).clone(),
593                                 short_channel_id: channel.get_short_channel_id(),
594                                 remote_network_id: channel.get_their_node_id(),
595                                 channel_value_satoshis: channel.get_value_satoshis(),
596                                 user_id: channel.get_user_id(),
597                         });
598                 }
599                 res
600         }
601
602         /// Gets the list of usable channels, in random order. Useful as an argument to
603         /// Router::get_route to ensure non-announced channels are used.
604         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
605                 let channel_state = self.channel_state.lock().unwrap();
606                 let mut res = Vec::with_capacity(channel_state.by_id.len());
607                 for (channel_id, channel) in channel_state.by_id.iter() {
608                         // Note we use is_live here instead of usable which leads to somewhat confused
609                         // internal/external nomenclature, but that's ok cause that's probably what the user
610                         // really wanted anyway.
611                         if channel.is_live() {
612                                 res.push(ChannelDetails {
613                                         channel_id: (*channel_id).clone(),
614                                         short_channel_id: channel.get_short_channel_id(),
615                                         remote_network_id: channel.get_their_node_id(),
616                                         channel_value_satoshis: channel.get_value_satoshis(),
617                                         user_id: channel.get_user_id(),
618                                 });
619                         }
620                 }
621                 res
622         }
623
624         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
625         /// will be accepted on the given channel, and after additional timeout/the closing of all
626         /// pending HTLCs, the channel will be closed on chain.
627         ///
628         /// May generate a SendShutdown message event on success, which should be relayed.
629         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
630                 let _ = self.total_consistency_lock.read().unwrap();
631
632                 let (mut failed_htlcs, chan_option) = {
633                         let mut channel_state_lock = self.channel_state.lock().unwrap();
634                         let channel_state = channel_state_lock.borrow_parts();
635                         match channel_state.by_id.entry(channel_id.clone()) {
636                                 hash_map::Entry::Occupied(mut chan_entry) => {
637                                         let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
638                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
639                                                 node_id: chan_entry.get().get_their_node_id(),
640                                                 msg: shutdown_msg
641                                         });
642                                         if chan_entry.get().is_shutdown() {
643                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
644                                                         channel_state.short_to_id.remove(&short_id);
645                                                 }
646                                                 (failed_htlcs, Some(chan_entry.remove_entry().1))
647                                         } else { (failed_htlcs, None) }
648                                 },
649                                 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
650                         }
651                 };
652                 for htlc_source in failed_htlcs.drain(..) {
653                         // unknown_next_peer...I dunno who that is anymore....
654                         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() });
655                 }
656                 let chan_update = if let Some(chan) = chan_option {
657                         if let Ok(update) = self.get_channel_update(&chan) {
658                                 Some(update)
659                         } else { None }
660                 } else { None };
661
662                 if let Some(update) = chan_update {
663                         let mut channel_state = self.channel_state.lock().unwrap();
664                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
665                                 msg: update
666                         });
667                 }
668
669                 Ok(())
670         }
671
672         #[inline]
673         fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
674                 let (local_txn, mut failed_htlcs) = shutdown_res;
675                 for htlc_source in failed_htlcs.drain(..) {
676                         // unknown_next_peer...I dunno who that is anymore....
677                         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() });
678                 }
679                 for tx in local_txn {
680                         self.tx_broadcaster.broadcast_transaction(&tx);
681                 }
682         }
683
684         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
685         /// the chain and rejecting new HTLCs on the given channel.
686         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
687                 let _ = self.total_consistency_lock.read().unwrap();
688
689                 let mut chan = {
690                         let mut channel_state_lock = self.channel_state.lock().unwrap();
691                         let channel_state = channel_state_lock.borrow_parts();
692                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
693                                 if let Some(short_id) = chan.get_short_channel_id() {
694                                         channel_state.short_to_id.remove(&short_id);
695                                 }
696                                 chan
697                         } else {
698                                 return;
699                         }
700                 };
701                 self.finish_force_close_channel(chan.force_shutdown());
702                 if let Ok(update) = self.get_channel_update(&chan) {
703                         let mut channel_state = self.channel_state.lock().unwrap();
704                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
705                                 msg: update
706                         });
707                 }
708         }
709
710         /// Force close all channels, immediately broadcasting the latest local commitment transaction
711         /// for each to the chain and rejecting new HTLCs on each.
712         pub fn force_close_all_channels(&self) {
713                 for chan in self.list_channels() {
714                         self.force_close_channel(&chan.channel_id);
715                 }
716         }
717
718         #[inline]
719         fn gen_rho_mu_from_shared_secret(shared_secret: &[u8]) -> ([u8; 32], [u8; 32]) {
720                 assert_eq!(shared_secret.len(), 32);
721                 ({
722                         let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
723                         hmac.input(&shared_secret[..]);
724                         let mut res = [0; 32];
725                         hmac.raw_result(&mut res);
726                         res
727                 },
728                 {
729                         let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
730                         hmac.input(&shared_secret[..]);
731                         let mut res = [0; 32];
732                         hmac.raw_result(&mut res);
733                         res
734                 })
735         }
736
737         #[inline]
738         fn gen_um_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
739                 assert_eq!(shared_secret.len(), 32);
740                 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
741                 hmac.input(&shared_secret[..]);
742                 let mut res = [0; 32];
743                 hmac.raw_result(&mut res);
744                 res
745         }
746
747         #[inline]
748         fn gen_ammag_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
749                 assert_eq!(shared_secret.len(), 32);
750                 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
751                 hmac.input(&shared_secret[..]);
752                 let mut res = [0; 32];
753                 hmac.raw_result(&mut res);
754                 res
755         }
756
757         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
758         #[inline]
759         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> {
760                 let mut blinded_priv = session_priv.clone();
761                 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
762
763                 for hop in route.hops.iter() {
764                         let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
765
766                         let mut sha = Sha256::new();
767                         sha.input(&blinded_pub.serialize()[..]);
768                         sha.input(&shared_secret[..]);
769                         let mut blinding_factor = [0u8; 32];
770                         sha.result(&mut blinding_factor);
771
772                         let ephemeral_pubkey = blinded_pub;
773
774                         blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
775                         blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
776
777                         callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
778                 }
779
780                 Ok(())
781         }
782
783         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
784         fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
785                 let mut res = Vec::with_capacity(route.hops.len());
786
787                 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
788                         let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret[..]);
789
790                         res.push(OnionKeys {
791                                 #[cfg(test)]
792                                 shared_secret,
793                                 #[cfg(test)]
794                                 blinding_factor: _blinding_factor,
795                                 ephemeral_pubkey,
796                                 rho,
797                                 mu,
798                         });
799                 })?;
800
801                 Ok(res)
802         }
803
804         /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
805         fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
806                 let mut cur_value_msat = 0u64;
807                 let mut cur_cltv = starting_htlc_offset;
808                 let mut last_short_channel_id = 0;
809                 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
810                 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
811                 unsafe { res.set_len(route.hops.len()); }
812
813                 for (idx, hop) in route.hops.iter().enumerate().rev() {
814                         // First hop gets special values so that it can check, on receipt, that everything is
815                         // exactly as it should be (and the next hop isn't trying to probe to find out if we're
816                         // the intended recipient).
817                         let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
818                         let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
819                         res[idx] = msgs::OnionHopData {
820                                 realm: 0,
821                                 data: msgs::OnionRealm0HopData {
822                                         short_channel_id: last_short_channel_id,
823                                         amt_to_forward: value_msat,
824                                         outgoing_cltv_value: cltv,
825                                 },
826                                 hmac: [0; 32],
827                         };
828                         cur_value_msat += hop.fee_msat;
829                         if cur_value_msat >= 21000000 * 100000000 * 1000 {
830                                 return Err(APIError::RouteError{err: "Channel fees overflowed?!"});
831                         }
832                         cur_cltv += hop.cltv_expiry_delta as u32;
833                         if cur_cltv >= 500000000 {
834                                 return Err(APIError::RouteError{err: "Channel CLTV overflowed?!"});
835                         }
836                         last_short_channel_id = hop.short_channel_id;
837                 }
838                 Ok((res, cur_value_msat, cur_cltv))
839         }
840
841         #[inline]
842         fn shift_arr_right(arr: &mut [u8; 20*65]) {
843                 unsafe {
844                         ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
845                 }
846                 for i in 0..65 {
847                         arr[i] = 0;
848                 }
849         }
850
851         #[inline]
852         fn xor_bufs(dst: &mut[u8], src: &[u8]) {
853                 assert_eq!(dst.len(), src.len());
854
855                 for i in 0..dst.len() {
856                         dst[i] ^= src[i];
857                 }
858         }
859
860         const ZERO:[u8; 21*65] = [0; 21*65];
861         fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> msgs::OnionPacket {
862                 let mut buf = Vec::with_capacity(21*65);
863                 buf.resize(21*65, 0);
864
865                 let filler = {
866                         let iters = payloads.len() - 1;
867                         let end_len = iters * 65;
868                         let mut res = Vec::with_capacity(end_len);
869                         res.resize(end_len, 0);
870
871                         for (i, keys) in onion_keys.iter().enumerate() {
872                                 if i == payloads.len() - 1 { continue; }
873                                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
874                                 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
875                                 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
876                         }
877                         res
878                 };
879
880                 let mut packet_data = [0; 20*65];
881                 let mut hmac_res = [0; 32];
882
883                 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
884                         ChannelManager::shift_arr_right(&mut packet_data);
885                         payload.hmac = hmac_res;
886                         packet_data[0..65].copy_from_slice(&payload.encode()[..]);
887
888                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
889                         chacha.process(&packet_data, &mut buf[0..20*65]);
890                         packet_data[..].copy_from_slice(&buf[0..20*65]);
891
892                         if i == 0 {
893                                 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
894                         }
895
896                         let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
897                         hmac.input(&packet_data);
898                         hmac.input(&associated_data[..]);
899                         hmac.raw_result(&mut hmac_res);
900                 }
901
902                 msgs::OnionPacket{
903                         version: 0,
904                         public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
905                         hop_data: packet_data,
906                         hmac: hmac_res,
907                 }
908         }
909
910         /// Encrypts a failure packet. raw_packet can either be a
911         /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
912         fn encrypt_failure_packet(shared_secret: &[u8], raw_packet: &[u8]) -> msgs::OnionErrorPacket {
913                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
914
915                 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
916                 packet_crypted.resize(raw_packet.len(), 0);
917                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
918                 chacha.process(&raw_packet, &mut packet_crypted[..]);
919                 msgs::OnionErrorPacket {
920                         data: packet_crypted,
921                 }
922         }
923
924         fn build_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
925                 assert_eq!(shared_secret.len(), 32);
926                 assert!(failure_data.len() <= 256 - 2);
927
928                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
929
930                 let failuremsg = {
931                         let mut res = Vec::with_capacity(2 + failure_data.len());
932                         res.push(((failure_type >> 8) & 0xff) as u8);
933                         res.push(((failure_type >> 0) & 0xff) as u8);
934                         res.extend_from_slice(&failure_data[..]);
935                         res
936                 };
937                 let pad = {
938                         let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
939                         res.resize(256 - 2 - failure_data.len(), 0);
940                         res
941                 };
942                 let mut packet = msgs::DecodedOnionErrorPacket {
943                         hmac: [0; 32],
944                         failuremsg: failuremsg,
945                         pad: pad,
946                 };
947
948                 let mut hmac = Hmac::new(Sha256::new(), &um);
949                 hmac.input(&packet.encode()[32..]);
950                 hmac.raw_result(&mut packet.hmac);
951
952                 packet
953         }
954
955         #[inline]
956         fn build_first_hop_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
957                 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
958                 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
959         }
960
961         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
962                 macro_rules! get_onion_hash {
963                         () => {
964                                 {
965                                         let mut sha = Sha256::new();
966                                         sha.input(&msg.onion_routing_packet.hop_data);
967                                         let mut onion_hash = [0; 32];
968                                         sha.result(&mut onion_hash);
969                                         onion_hash
970                                 }
971                         }
972                 }
973
974                 if let Err(_) = msg.onion_routing_packet.public_key {
975                         log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
976                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
977                                 channel_id: msg.channel_id,
978                                 htlc_id: msg.htlc_id,
979                                 sha256_of_onion: get_onion_hash!(),
980                                 failure_code: 0x8000 | 0x4000 | 6,
981                         })), self.channel_state.lock().unwrap());
982                 }
983
984                 let shared_secret = {
985                         let mut arr = [0; 32];
986                         arr.copy_from_slice(&SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
987                         arr
988                 };
989                 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
990
991                 let mut channel_state = None;
992                 macro_rules! return_err {
993                         ($msg: expr, $err_code: expr, $data: expr) => {
994                                 {
995                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
996                                         if channel_state.is_none() {
997                                                 channel_state = Some(self.channel_state.lock().unwrap());
998                                         }
999                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1000                                                 channel_id: msg.channel_id,
1001                                                 htlc_id: msg.htlc_id,
1002                                                 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1003                                         })), channel_state.unwrap());
1004                                 }
1005                         }
1006                 }
1007
1008                 if msg.onion_routing_packet.version != 0 {
1009                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1010                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1011                         //the hash doesn't really serve any purpuse - in the case of hashing all data, the
1012                         //receiving node would have to brute force to figure out which version was put in the
1013                         //packet by the node that send us the message, in the case of hashing the hop_data, the
1014                         //node knows the HMAC matched, so they already know what is there...
1015                         return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
1016                 }
1017
1018                 let mut hmac = Hmac::new(Sha256::new(), &mu);
1019                 hmac.input(&msg.onion_routing_packet.hop_data);
1020                 hmac.input(&msg.payment_hash);
1021                 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
1022                         return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
1023                 }
1024
1025                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1026                 let next_hop_data = {
1027                         let mut decoded = [0; 65];
1028                         chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
1029                         match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
1030                                 Err(err) => {
1031                                         let error_code = match err {
1032                                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1033                                                 _ => 0x2000 | 2, // Should never happen
1034                                         };
1035                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
1036                                 },
1037                                 Ok(msg) => msg
1038                         }
1039                 };
1040
1041                 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
1042                                 // OUR PAYMENT!
1043                                 // final_expiry_too_soon
1044                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS) as u64 {
1045                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1046                                 }
1047                                 // final_incorrect_htlc_amount
1048                                 if next_hop_data.data.amt_to_forward > msg.amount_msat {
1049                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1050                                 }
1051                                 // final_incorrect_cltv_expiry
1052                                 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
1053                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1054                                 }
1055
1056                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
1057                                 // message, however that would leak that we are the recipient of this payment, so
1058                                 // instead we stay symmetric with the forwarding case, only responding (after a
1059                                 // delay) once they've send us a commitment_signed!
1060
1061                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1062                                         onion_packet: None,
1063                                         payment_hash: msg.payment_hash.clone(),
1064                                         short_channel_id: 0,
1065                                         incoming_shared_secret: shared_secret,
1066                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1067                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1068                                 })
1069                         } else {
1070                                 let mut new_packet_data = [0; 20*65];
1071                                 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
1072                                 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
1073
1074                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1075
1076                                 let blinding_factor = {
1077                                         let mut sha = Sha256::new();
1078                                         sha.input(&new_pubkey.serialize()[..]);
1079                                         sha.input(&shared_secret);
1080                                         let mut res = [0u8; 32];
1081                                         sha.result(&mut res);
1082                                         match SecretKey::from_slice(&self.secp_ctx, &res) {
1083                                                 Err(_) => {
1084                                                         return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1085                                                 },
1086                                                 Ok(key) => key
1087                                         }
1088                                 };
1089
1090                                 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
1091                                         return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1092                                 }
1093
1094                                 let outgoing_packet = msgs::OnionPacket {
1095                                         version: 0,
1096                                         public_key: Ok(new_pubkey),
1097                                         hop_data: new_packet_data,
1098                                         hmac: next_hop_data.hmac.clone(),
1099                                 };
1100
1101                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1102                                         onion_packet: Some(outgoing_packet),
1103                                         payment_hash: msg.payment_hash.clone(),
1104                                         short_channel_id: next_hop_data.data.short_channel_id,
1105                                         incoming_shared_secret: shared_secret,
1106                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1107                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1108                                 })
1109                         };
1110
1111                 channel_state = Some(self.channel_state.lock().unwrap());
1112                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1113                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1114                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1115                                 let forwarding_id = match id_option {
1116                                         None => { // unknown_next_peer
1117                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1118                                         },
1119                                         Some(id) => id.clone(),
1120                                 };
1121                                 if let Some((err, code, chan_update)) = loop {
1122                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1123
1124                                         // Note that we could technically not return an error yet here and just hope
1125                                         // that the connection is reestablished or monitor updated by the time we get
1126                                         // around to doing the actual forward, but better to fail early if we can and
1127                                         // hopefully an attacker trying to path-trace payments cannot make this occur
1128                                         // on a small/per-node/per-channel scale.
1129                                         if !chan.is_live() { // channel_disabled
1130                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1131                                         }
1132                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1133                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1134                                         }
1135                                         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) });
1136                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1137                                                 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())));
1138                                         }
1139                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1140                                                 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())));
1141                                         }
1142                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1143                                         // We want to have at least HTLC_FAIL_TIMEOUT_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1144                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS as u32 { // expiry_too_soon
1145                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1146                                         }
1147                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1148                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1149                                         }
1150                                         break None;
1151                                 }
1152                                 {
1153                                         let mut res = Vec::with_capacity(8 + 128);
1154                                         if code == 0x1000 | 11 || code == 0x1000 | 12 {
1155                                                 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1156                                         }
1157                                         else if code == 0x1000 | 13 {
1158                                                 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1159                                         }
1160                                         if let Some(chan_update) = chan_update {
1161                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1162                                         }
1163                                         return_err!(err, code, &res[..]);
1164                                 }
1165                         }
1166                 }
1167
1168                 (pending_forward_info, channel_state.unwrap())
1169         }
1170
1171         /// only fails if the channel does not yet have an assigned short_id
1172         /// May be called with channel_state already locked!
1173         fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
1174                 let short_channel_id = match chan.get_short_channel_id() {
1175                         None => return Err(HandleError{err: "Channel not yet established", action: None}),
1176                         Some(id) => id,
1177                 };
1178
1179                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1180
1181                 let unsigned = msgs::UnsignedChannelUpdate {
1182                         chain_hash: self.genesis_hash,
1183                         short_channel_id: short_channel_id,
1184                         timestamp: chan.get_channel_update_count(),
1185                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1186                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1187                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1188                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1189                         fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1190                         excess_data: Vec::new(),
1191                 };
1192
1193                 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
1194                 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key);
1195
1196                 Ok(msgs::ChannelUpdate {
1197                         signature: sig,
1198                         contents: unsigned
1199                 })
1200         }
1201
1202         /// Sends a payment along a given route.
1203         ///
1204         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1205         /// fields for more info.
1206         ///
1207         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1208         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1209         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1210         /// specified in the last hop in the route! Thus, you should probably do your own
1211         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1212         /// payment") and prevent double-sends yourself.
1213         ///
1214         /// May generate a SendHTLCs message event on success, which should be relayed.
1215         ///
1216         /// Raises APIError::RoutError when invalid route or forward parameter
1217         /// (cltv_delta, fee, node public key) is specified.
1218         /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1219         /// (including due to previous monitor update failure or new permanent monitor update failure).
1220         /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1221         /// relevant updates.
1222         ///
1223         /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1224         /// and you may wish to retry via a different route immediately.
1225         /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1226         /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1227         /// the payment via a different route unless you intend to pay twice!
1228         pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), APIError> {
1229                 if route.hops.len() < 1 || route.hops.len() > 20 {
1230                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1231                 }
1232                 let our_node_id = self.get_our_node_id();
1233                 for (idx, hop) in route.hops.iter().enumerate() {
1234                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1235                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1236                         }
1237                 }
1238
1239                 let session_priv = self.keys_manager.get_session_key();
1240
1241                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1242
1243                 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1244                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1245                 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
1246                 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1247
1248                 let _ = self.total_consistency_lock.read().unwrap();
1249
1250                 let err: Result<(), _> = loop {
1251                         let mut channel_lock = self.channel_state.lock().unwrap();
1252
1253                         let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1254                                 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1255                                 Some(id) => id.clone(),
1256                         };
1257
1258                         let channel_state = channel_lock.borrow_parts();
1259                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1260                                 match {
1261                                         if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1262                                                 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1263                                         }
1264                                         if !chan.get().is_live() {
1265                                                 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1266                                         }
1267                                         break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1268                                                 route: route.clone(),
1269                                                 session_priv: session_priv.clone(),
1270                                                 first_hop_htlc_msat: htlc_msat,
1271                                         }, onion_packet), channel_state, chan)
1272                                 } {
1273                                         Some((update_add, commitment_signed, chan_monitor)) => {
1274                                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1275                                                         maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst);
1276                                                         // Note that MonitorUpdateFailed here indicates (per function docs)
1277                                                         // that we will resent the commitment update once we unfree monitor
1278                                                         // updating, so we have to take special care that we don't return
1279                                                         // something else in case we will resend later!
1280                                                         return Err(APIError::MonitorUpdateFailed);
1281                                                 }
1282
1283                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1284                                                         node_id: route.hops.first().unwrap().pubkey,
1285                                                         updates: msgs::CommitmentUpdate {
1286                                                                 update_add_htlcs: vec![update_add],
1287                                                                 update_fulfill_htlcs: Vec::new(),
1288                                                                 update_fail_htlcs: Vec::new(),
1289                                                                 update_fail_malformed_htlcs: Vec::new(),
1290                                                                 update_fee: None,
1291                                                                 commitment_signed,
1292                                                         },
1293                                                 });
1294                                         },
1295                                         None => {},
1296                                 }
1297                         } else { unreachable!(); }
1298                         return Ok(());
1299                 };
1300
1301                 match handle_error!(self, err, route.hops.first().unwrap().pubkey) {
1302                         Ok(_) => unreachable!(),
1303                         Err(e) => {
1304                                 if let Some(msgs::ErrorAction::IgnoreError) = e.action {
1305                                 } else {
1306                                         log_error!(self, "Got bad keys: {}!", e.err);
1307                                         let mut channel_state = self.channel_state.lock().unwrap();
1308                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1309                                                 node_id: route.hops.first().unwrap().pubkey,
1310                                                 action: e.action,
1311                                         });
1312                                 }
1313                                 Err(APIError::ChannelUnavailable { err: e.err })
1314                         },
1315                 }
1316         }
1317
1318         /// Call this upon creation of a funding transaction for the given channel.
1319         ///
1320         /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1321         /// or your counterparty can steal your funds!
1322         ///
1323         /// Panics if a funding transaction has already been provided for this channel.
1324         ///
1325         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1326         /// be trivially prevented by using unique funding transaction keys per-channel).
1327         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1328                 let _ = self.total_consistency_lock.read().unwrap();
1329
1330                 let (chan, msg, chan_monitor) = {
1331                         let (res, chan) = {
1332                                 let mut channel_state = self.channel_state.lock().unwrap();
1333                                 match channel_state.by_id.remove(temporary_channel_id) {
1334                                         Some(mut chan) => {
1335                                                 (chan.get_outbound_funding_created(funding_txo)
1336                                                         .map_err(|e| if let ChannelError::Close(msg) = e {
1337                                                                 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1338                                                         } else { unreachable!(); })
1339                                                 , chan)
1340                                         },
1341                                         None => return
1342                                 }
1343                         };
1344                         match handle_error!(self, res, chan.get_their_node_id()) {
1345                                 Ok(funding_msg) => {
1346                                         (chan, funding_msg.0, funding_msg.1)
1347                                 },
1348                                 Err(e) => {
1349                                         log_error!(self, "Got bad signatures: {}!", e.err);
1350                                         let mut channel_state = self.channel_state.lock().unwrap();
1351                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1352                                                 node_id: chan.get_their_node_id(),
1353                                                 action: e.action,
1354                                         });
1355                                         return;
1356                                 },
1357                         }
1358                 };
1359                 // Because we have exclusive ownership of the channel here we can release the channel_state
1360                 // lock before add_update_monitor
1361                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1362                         unimplemented!();
1363                 }
1364
1365                 let mut channel_state = self.channel_state.lock().unwrap();
1366                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1367                         node_id: chan.get_their_node_id(),
1368                         msg: msg,
1369                 });
1370                 match channel_state.by_id.entry(chan.channel_id()) {
1371                         hash_map::Entry::Occupied(_) => {
1372                                 panic!("Generated duplicate funding txid?");
1373                         },
1374                         hash_map::Entry::Vacant(e) => {
1375                                 e.insert(chan);
1376                         }
1377                 }
1378         }
1379
1380         fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1381                 if !chan.should_announce() { return None }
1382
1383                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1384                         Ok(res) => res,
1385                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1386                 };
1387                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1388                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1389
1390                 Some(msgs::AnnouncementSignatures {
1391                         channel_id: chan.channel_id(),
1392                         short_channel_id: chan.get_short_channel_id().unwrap(),
1393                         node_signature: our_node_sig,
1394                         bitcoin_signature: our_bitcoin_sig,
1395                 })
1396         }
1397
1398         /// Processes HTLCs which are pending waiting on random forward delay.
1399         ///
1400         /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1401         /// Will likely generate further events.
1402         pub fn process_pending_htlc_forwards(&self) {
1403                 let _ = self.total_consistency_lock.read().unwrap();
1404
1405                 let mut new_events = Vec::new();
1406                 let mut failed_forwards = Vec::new();
1407                 {
1408                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1409                         let channel_state = channel_state_lock.borrow_parts();
1410
1411                         if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1412                                 return;
1413                         }
1414
1415                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1416                                 if short_chan_id != 0 {
1417                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1418                                                 Some(chan_id) => chan_id.clone(),
1419                                                 None => {
1420                                                         failed_forwards.reserve(pending_forwards.len());
1421                                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1422                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1423                                                                         short_channel_id: prev_short_channel_id,
1424                                                                         htlc_id: prev_htlc_id,
1425                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1426                                                                 });
1427                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1428                                                         }
1429                                                         continue;
1430                                                 }
1431                                         };
1432                                         let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1433
1434                                         let mut add_htlc_msgs = Vec::new();
1435                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1436                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1437                                                         short_channel_id: prev_short_channel_id,
1438                                                         htlc_id: prev_htlc_id,
1439                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1440                                                 });
1441                                                 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()) {
1442                                                         Err(_e) => {
1443                                                                 let chan_update = self.get_channel_update(forward_chan).unwrap();
1444                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1445                                                                 continue;
1446                                                         },
1447                                                         Ok(update_add) => {
1448                                                                 match update_add {
1449                                                                         Some(msg) => { add_htlc_msgs.push(msg); },
1450                                                                         None => {
1451                                                                                 // Nothing to do here...we're waiting on a remote
1452                                                                                 // revoke_and_ack before we can add anymore HTLCs. The Channel
1453                                                                                 // will automatically handle building the update_add_htlc and
1454                                                                                 // commitment_signed messages when we can.
1455                                                                                 // TODO: Do some kind of timer to set the channel as !is_live()
1456                                                                                 // as we don't really want others relying on us relaying through
1457                                                                                 // this channel currently :/.
1458                                                                         }
1459                                                                 }
1460                                                         }
1461                                                 }
1462                                         }
1463
1464                                         if !add_htlc_msgs.is_empty() {
1465                                                 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1466                                                         Ok(res) => res,
1467                                                         Err(e) => {
1468                                                                 if let ChannelError::Ignore(_) = e {
1469                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1470                                                                 }
1471                                                                 //TODO: Handle...this is bad!
1472                                                                 continue;
1473                                                         },
1474                                                 };
1475                                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1476                                                         unimplemented!();
1477                                                 }
1478                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1479                                                         node_id: forward_chan.get_their_node_id(),
1480                                                         updates: msgs::CommitmentUpdate {
1481                                                                 update_add_htlcs: add_htlc_msgs,
1482                                                                 update_fulfill_htlcs: Vec::new(),
1483                                                                 update_fail_htlcs: Vec::new(),
1484                                                                 update_fail_malformed_htlcs: Vec::new(),
1485                                                                 update_fee: None,
1486                                                                 commitment_signed: commitment_msg,
1487                                                         },
1488                                                 });
1489                                         }
1490                                 } else {
1491                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1492                                                 let prev_hop_data = HTLCPreviousHopData {
1493                                                         short_channel_id: prev_short_channel_id,
1494                                                         htlc_id: prev_htlc_id,
1495                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1496                                                 };
1497                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1498                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(prev_hop_data),
1499                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![prev_hop_data]); },
1500                                                 };
1501                                                 new_events.push(events::Event::PaymentReceived {
1502                                                         payment_hash: forward_info.payment_hash,
1503                                                         amt: forward_info.amt_to_forward,
1504                                                 });
1505                                         }
1506                                 }
1507                         }
1508                 }
1509
1510                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1511                         match update {
1512                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1513                                 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() }),
1514                         };
1515                 }
1516
1517                 if new_events.is_empty() { return }
1518                 let mut events = self.pending_events.lock().unwrap();
1519                 events.append(&mut new_events);
1520         }
1521
1522         /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect after a PaymentReceived event.
1523         pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32], reason: PaymentFailReason) -> bool {
1524                 let _ = self.total_consistency_lock.read().unwrap();
1525
1526                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1527                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1528                 if let Some(mut sources) = removed_source {
1529                         for htlc_with_hash in sources.drain(..) {
1530                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1531                                 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() });
1532                         }
1533                         true
1534                 } else { false }
1535         }
1536
1537         /// Fails an HTLC backwards to the sender of it to us.
1538         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1539         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1540         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1541         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1542         /// still-available channels.
1543         fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &[u8; 32], onion_error: HTLCFailReason) {
1544                 match source {
1545                         HTLCSource::OutboundRoute { .. } => {
1546                                 mem::drop(channel_state_lock);
1547                                 if let &HTLCFailReason::ErrorPacket { ref err } = &onion_error {
1548                                         let (channel_update, payment_retryable) = self.process_onion_failure(&source, err.data.clone());
1549                                         if let Some(update) = channel_update {
1550                                                 self.channel_state.lock().unwrap().pending_msg_events.push(
1551                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate {
1552                                                                 update,
1553                                                         }
1554                                                 );
1555                                         }
1556                                         self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1557                                                 payment_hash: payment_hash.clone(),
1558                                                 rejected_by_dest: !payment_retryable,
1559                                         });
1560                                 } else {
1561                                         //TODO: Pass this back (see GH #243)
1562                                         self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1563                                                 payment_hash: payment_hash.clone(),
1564                                                 rejected_by_dest: false, // We failed it ourselves, can't blame them
1565                                         });
1566                                 }
1567                         },
1568                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1569                                 let err_packet = match onion_error {
1570                                         HTLCFailReason::Reason { failure_code, data } => {
1571                                                 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1572                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1573                                         },
1574                                         HTLCFailReason::ErrorPacket { err } => {
1575                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1576                                         }
1577                                 };
1578
1579                                 let channel_state = channel_state_lock.borrow_parts();
1580
1581                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1582                                         Some(chan_id) => chan_id.clone(),
1583                                         None => return
1584                                 };
1585
1586                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1587                                 match chan.get_update_fail_htlc_and_commit(htlc_id, err_packet) {
1588                                         Ok(Some((msg, commitment_msg, chan_monitor))) => {
1589                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1590                                                         unimplemented!();
1591                                                 }
1592                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1593                                                         node_id: chan.get_their_node_id(),
1594                                                         updates: msgs::CommitmentUpdate {
1595                                                                 update_add_htlcs: Vec::new(),
1596                                                                 update_fulfill_htlcs: Vec::new(),
1597                                                                 update_fail_htlcs: vec![msg],
1598                                                                 update_fail_malformed_htlcs: Vec::new(),
1599                                                                 update_fee: None,
1600                                                                 commitment_signed: commitment_msg,
1601                                                         },
1602                                                 });
1603                                         },
1604                                         Ok(None) => {},
1605                                         Err(_e) => {
1606                                                 //TODO: Do something with e?
1607                                                 return;
1608                                         },
1609                                 }
1610                         },
1611                 }
1612         }
1613
1614         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1615         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1616         /// should probably kick the net layer to go send messages if this returns true!
1617         ///
1618         /// May panic if called except in response to a PaymentReceived event.
1619         pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1620                 let mut sha = Sha256::new();
1621                 sha.input(&payment_preimage);
1622                 let mut payment_hash = [0; 32];
1623                 sha.result(&mut payment_hash);
1624
1625                 let _ = self.total_consistency_lock.read().unwrap();
1626
1627                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1628                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1629                 if let Some(mut sources) = removed_source {
1630                         for htlc_with_hash in sources.drain(..) {
1631                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1632                                 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1633                         }
1634                         true
1635                 } else { false }
1636         }
1637         fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: [u8; 32]) {
1638                 match source {
1639                         HTLCSource::OutboundRoute { .. } => {
1640                                 mem::drop(channel_state_lock);
1641                                 let mut pending_events = self.pending_events.lock().unwrap();
1642                                 pending_events.push(events::Event::PaymentSent {
1643                                         payment_preimage
1644                                 });
1645                         },
1646                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1647                                 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1648                                 let channel_state = channel_state_lock.borrow_parts();
1649
1650                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1651                                         Some(chan_id) => chan_id.clone(),
1652                                         None => {
1653                                                 // TODO: There is probably a channel manager somewhere that needs to
1654                                                 // learn the preimage as the channel already hit the chain and that's
1655                                                 // why its missing.
1656                                                 return
1657                                         }
1658                                 };
1659
1660                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1661                                 match chan.get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1662                                         Ok((msgs, monitor_option)) => {
1663                                                 if let Some(chan_monitor) = monitor_option {
1664                                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1665                                                                 unimplemented!();// but def dont push the event...
1666                                                         }
1667                                                 }
1668                                                 if let Some((msg, commitment_signed)) = msgs {
1669                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1670                                                                 node_id: chan.get_their_node_id(),
1671                                                                 updates: msgs::CommitmentUpdate {
1672                                                                         update_add_htlcs: Vec::new(),
1673                                                                         update_fulfill_htlcs: vec![msg],
1674                                                                         update_fail_htlcs: Vec::new(),
1675                                                                         update_fail_malformed_htlcs: Vec::new(),
1676                                                                         update_fee: None,
1677                                                                         commitment_signed,
1678                                                                 }
1679                                                         });
1680                                                 }
1681                                         },
1682                                         Err(_e) => {
1683                                                 // TODO: There is probably a channel manager somewhere that needs to
1684                                                 // learn the preimage as the channel may be about to hit the chain.
1685                                                 //TODO: Do something with e?
1686                                                 return
1687                                         },
1688                                 }
1689                         },
1690                 }
1691         }
1692
1693         /// Gets the node_id held by this ChannelManager
1694         pub fn get_our_node_id(&self) -> PublicKey {
1695                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1696         }
1697
1698         /// Used to restore channels to normal operation after a
1699         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1700         /// operation.
1701         pub fn test_restore_channel_monitor(&self) {
1702                 let mut close_results = Vec::new();
1703                 let mut htlc_forwards = Vec::new();
1704                 let mut htlc_failures = Vec::new();
1705                 let _ = self.total_consistency_lock.read().unwrap();
1706
1707                 {
1708                         let mut channel_lock = self.channel_state.lock().unwrap();
1709                         let channel_state = channel_lock.borrow_parts();
1710                         let short_to_id = channel_state.short_to_id;
1711                         let pending_msg_events = channel_state.pending_msg_events;
1712                         channel_state.by_id.retain(|_, channel| {
1713                                 if channel.is_awaiting_monitor_update() {
1714                                         let chan_monitor = channel.channel_monitor();
1715                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1716                                                 match e {
1717                                                         ChannelMonitorUpdateErr::PermanentFailure => {
1718                                                                 // TODO: There may be some pending HTLCs that we intended to fail
1719                                                                 // backwards when a monitor update failed. We should make sure
1720                                                                 // knowledge of those gets moved into the appropriate in-memory
1721                                                                 // ChannelMonitor and they get failed backwards once we get
1722                                                                 // on-chain confirmations.
1723                                                                 // Note I think #198 addresses this, so once its merged a test
1724                                                                 // should be written.
1725                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1726                                                                         short_to_id.remove(&short_id);
1727                                                                 }
1728                                                                 close_results.push(channel.force_shutdown());
1729                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1730                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1731                                                                                 msg: update
1732                                                                         });
1733                                                                 }
1734                                                                 false
1735                                                         },
1736                                                         ChannelMonitorUpdateErr::TemporaryFailure => true,
1737                                                 }
1738                                         } else {
1739                                                 let (raa, commitment_update, order, pending_forwards, mut pending_failures) = channel.monitor_updating_restored();
1740                                                 if !pending_forwards.is_empty() {
1741                                                         htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1742                                                 }
1743                                                 htlc_failures.append(&mut pending_failures);
1744
1745                                                 macro_rules! handle_cs { () => {
1746                                                         if let Some(update) = commitment_update {
1747                                                                 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1748                                                                         node_id: channel.get_their_node_id(),
1749                                                                         updates: update,
1750                                                                 });
1751                                                         }
1752                                                 } }
1753                                                 macro_rules! handle_raa { () => {
1754                                                         if let Some(revoke_and_ack) = raa {
1755                                                                 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1756                                                                         node_id: channel.get_their_node_id(),
1757                                                                         msg: revoke_and_ack,
1758                                                                 });
1759                                                         }
1760                                                 } }
1761                                                 match order {
1762                                                         RAACommitmentOrder::CommitmentFirst => {
1763                                                                 handle_cs!();
1764                                                                 handle_raa!();
1765                                                         },
1766                                                         RAACommitmentOrder::RevokeAndACKFirst => {
1767                                                                 handle_raa!();
1768                                                                 handle_cs!();
1769                                                         },
1770                                                 }
1771                                                 true
1772                                         }
1773                                 } else { true }
1774                         });
1775                 }
1776
1777                 for failure in htlc_failures.drain(..) {
1778                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1779                 }
1780                 self.forward_htlcs(&mut htlc_forwards[..]);
1781
1782                 for res in close_results.drain(..) {
1783                         self.finish_force_close_channel(res);
1784                 }
1785         }
1786
1787         fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1788                 if msg.chain_hash != self.genesis_hash {
1789                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1790                 }
1791
1792                 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)
1793                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1794                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1795                 let channel_state = channel_state_lock.borrow_parts();
1796                 match channel_state.by_id.entry(channel.channel_id()) {
1797                         hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1798                         hash_map::Entry::Vacant(entry) => {
1799                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1800                                         node_id: their_node_id.clone(),
1801                                         msg: channel.get_accept_channel(),
1802                                 });
1803                                 entry.insert(channel);
1804                         }
1805                 }
1806                 Ok(())
1807         }
1808
1809         fn internal_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1810                 let (value, output_script, user_id) = {
1811                         let mut channel_lock = self.channel_state.lock().unwrap();
1812                         let channel_state = channel_lock.borrow_parts();
1813                         match channel_state.by_id.entry(msg.temporary_channel_id) {
1814                                 hash_map::Entry::Occupied(mut chan) => {
1815                                         if chan.get().get_their_node_id() != *their_node_id {
1816                                                 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1817                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1818                                         }
1819                                         try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration), channel_state, chan);
1820                                         (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1821                                 },
1822                                 //TODO: same as above
1823                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1824                         }
1825                 };
1826                 let mut pending_events = self.pending_events.lock().unwrap();
1827                 pending_events.push(events::Event::FundingGenerationReady {
1828                         temporary_channel_id: msg.temporary_channel_id,
1829                         channel_value_satoshis: value,
1830                         output_script: output_script,
1831                         user_channel_id: user_id,
1832                 });
1833                 Ok(())
1834         }
1835
1836         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1837                 let ((funding_msg, monitor_update), chan) = {
1838                         let mut channel_lock = self.channel_state.lock().unwrap();
1839                         let channel_state = channel_lock.borrow_parts();
1840                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1841                                 hash_map::Entry::Occupied(mut chan) => {
1842                                         if chan.get().get_their_node_id() != *their_node_id {
1843                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1844                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1845                                         }
1846                                         (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1847                                 },
1848                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1849                         }
1850                 };
1851                 // Because we have exclusive ownership of the channel here we can release the channel_state
1852                 // lock before add_update_monitor
1853                 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1854                         unimplemented!();
1855                 }
1856                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1857                 let channel_state = channel_state_lock.borrow_parts();
1858                 match channel_state.by_id.entry(funding_msg.channel_id) {
1859                         hash_map::Entry::Occupied(_) => {
1860                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1861                         },
1862                         hash_map::Entry::Vacant(e) => {
1863                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1864                                         node_id: their_node_id.clone(),
1865                                         msg: funding_msg,
1866                                 });
1867                                 e.insert(chan);
1868                         }
1869                 }
1870                 Ok(())
1871         }
1872
1873         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1874                 let (funding_txo, user_id) = {
1875                         let mut channel_lock = self.channel_state.lock().unwrap();
1876                         let channel_state = channel_lock.borrow_parts();
1877                         match channel_state.by_id.entry(msg.channel_id) {
1878                                 hash_map::Entry::Occupied(mut chan) => {
1879                                         if chan.get().get_their_node_id() != *their_node_id {
1880                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1881                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1882                                         }
1883                                         let chan_monitor = try_chan_entry!(self, chan.get_mut().funding_signed(&msg), channel_state, chan);
1884                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1885                                                 unimplemented!();
1886                                         }
1887                                         (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
1888                                 },
1889                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1890                         }
1891                 };
1892                 let mut pending_events = self.pending_events.lock().unwrap();
1893                 pending_events.push(events::Event::FundingBroadcastSafe {
1894                         funding_txo: funding_txo,
1895                         user_channel_id: user_id,
1896                 });
1897                 Ok(())
1898         }
1899
1900         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
1901                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1902                 let channel_state = channel_state_lock.borrow_parts();
1903                 match channel_state.by_id.entry(msg.channel_id) {
1904                         hash_map::Entry::Occupied(mut chan) => {
1905                                 if chan.get().get_their_node_id() != *their_node_id {
1906                                         //TODO: here and below MsgHandleErrInternal, #153 case
1907                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1908                                 }
1909                                 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
1910                                 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
1911                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1912                                                 node_id: their_node_id.clone(),
1913                                                 msg: announcement_sigs,
1914                                         });
1915                                 }
1916                                 Ok(())
1917                         },
1918                         hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1919                 }
1920         }
1921
1922         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
1923                 let (mut dropped_htlcs, chan_option) = {
1924                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1925                         let channel_state = channel_state_lock.borrow_parts();
1926
1927                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1928                                 hash_map::Entry::Occupied(mut chan_entry) => {
1929                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1930                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1931                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1932                                         }
1933                                         let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg), channel_state, chan_entry);
1934                                         if let Some(msg) = shutdown {
1935                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1936                                                         node_id: their_node_id.clone(),
1937                                                         msg,
1938                                                 });
1939                                         }
1940                                         if let Some(msg) = closing_signed {
1941                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1942                                                         node_id: their_node_id.clone(),
1943                                                         msg,
1944                                                 });
1945                                         }
1946                                         if chan_entry.get().is_shutdown() {
1947                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1948                                                         channel_state.short_to_id.remove(&short_id);
1949                                                 }
1950                                                 (dropped_htlcs, Some(chan_entry.remove_entry().1))
1951                                         } else { (dropped_htlcs, None) }
1952                                 },
1953                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1954                         }
1955                 };
1956                 for htlc_source in dropped_htlcs.drain(..) {
1957                         // unknown_next_peer...I dunno who that is anymore....
1958                         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() });
1959                 }
1960                 if let Some(chan) = chan_option {
1961                         if let Ok(update) = self.get_channel_update(&chan) {
1962                                 let mut channel_state = self.channel_state.lock().unwrap();
1963                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1964                                         msg: update
1965                                 });
1966                         }
1967                 }
1968                 Ok(())
1969         }
1970
1971         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
1972                 let (tx, chan_option) = {
1973                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1974                         let channel_state = channel_state_lock.borrow_parts();
1975                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1976                                 hash_map::Entry::Occupied(mut chan_entry) => {
1977                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1978                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1979                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1980                                         }
1981                                         let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg), channel_state, chan_entry);
1982                                         if let Some(msg) = closing_signed {
1983                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1984                                                         node_id: their_node_id.clone(),
1985                                                         msg,
1986                                                 });
1987                                         }
1988                                         if tx.is_some() {
1989                                                 // We're done with this channel, we've got a signed closing transaction and
1990                                                 // will send the closing_signed back to the remote peer upon return. This
1991                                                 // also implies there are no pending HTLCs left on the channel, so we can
1992                                                 // fully delete it from tracking (the channel monitor is still around to
1993                                                 // watch for old state broadcasts)!
1994                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1995                                                         channel_state.short_to_id.remove(&short_id);
1996                                                 }
1997                                                 (tx, Some(chan_entry.remove_entry().1))
1998                                         } else { (tx, None) }
1999                                 },
2000                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2001                         }
2002                 };
2003                 if let Some(broadcast_tx) = tx {
2004                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2005                 }
2006                 if let Some(chan) = chan_option {
2007                         if let Ok(update) = self.get_channel_update(&chan) {
2008                                 let mut channel_state = self.channel_state.lock().unwrap();
2009                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2010                                         msg: update
2011                                 });
2012                         }
2013                 }
2014                 Ok(())
2015         }
2016
2017         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2018                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2019                 //determine the state of the payment based on our response/if we forward anything/the time
2020                 //we take to respond. We should take care to avoid allowing such an attack.
2021                 //
2022                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2023                 //us repeatedly garbled in different ways, and compare our error messages, which are
2024                 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
2025                 //but we should prevent it anyway.
2026
2027                 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2028                 let channel_state = channel_state_lock.borrow_parts();
2029
2030                 match channel_state.by_id.entry(msg.channel_id) {
2031                         hash_map::Entry::Occupied(mut chan) => {
2032                                 if chan.get().get_their_node_id() != *their_node_id {
2033                                         //TODO: here MsgHandleErrInternal, #153 case
2034                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2035                                 }
2036                                 if !chan.get().is_usable() {
2037                                         // If the update_add is completely bogus, the call will Err and we will close,
2038                                         // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2039                                         // want to reject the new HTLC and fail it backwards instead of forwarding.
2040                                         if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2041                                                 let chan_update = self.get_channel_update(chan.get());
2042                                                 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2043                                                         channel_id: msg.channel_id,
2044                                                         htlc_id: msg.htlc_id,
2045                                                         reason: if let Ok(update) = chan_update {
2046                                                                 ChannelManager::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &update.encode_with_len()[..])
2047                                                         } else {
2048                                                                 // This can only happen if the channel isn't in the fully-funded
2049                                                                 // state yet, implying our counterparty is trying to route payments
2050                                                                 // over the channel back to themselves (cause no one else should
2051                                                                 // know the short_id is a lightning channel yet). We should have no
2052                                                                 // problem just calling this unknown_next_peer
2053                                                                 ChannelManager::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2054                                                         },
2055                                                 }));
2056                                         }
2057                                 }
2058                                 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2059                         },
2060                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2061                 }
2062                 Ok(())
2063         }
2064
2065         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2066                 let mut channel_lock = self.channel_state.lock().unwrap();
2067                 let htlc_source = {
2068                         let channel_state = channel_lock.borrow_parts();
2069                         match channel_state.by_id.entry(msg.channel_id) {
2070                                 hash_map::Entry::Occupied(mut chan) => {
2071                                         if chan.get().get_their_node_id() != *their_node_id {
2072                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2073                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2074                                         }
2075                                         try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2076                                 },
2077                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2078                         }
2079                 };
2080                 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2081                 Ok(())
2082         }
2083
2084         // Process failure we got back from upstream on a payment we sent. Returns update and a boolean
2085         // indicating that the payment itself failed
2086         fn process_onion_failure(&self, htlc_source: &HTLCSource, mut packet_decrypted: Vec<u8>) -> (Option<msgs::HTLCFailChannelUpdate>, bool) {
2087                 if let &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } = htlc_source {
2088                         macro_rules! onion_failure_log {
2089                                 ( $error_code_textual: expr, $error_code: expr, $reported_name: expr, $reported_value: expr ) => {
2090                                         log_trace!(self, "{}({:#x}) {}({})", $error_code_textual, $error_code, $reported_name, $reported_value);
2091                                 };
2092                                 ( $error_code_textual: expr, $error_code: expr ) => {
2093                                         log_trace!(self, "{}({})", $error_code_textual, $error_code);
2094                                 };
2095                         }
2096
2097                         const BADONION: u16 = 0x8000;
2098                         const PERM: u16 = 0x4000;
2099                         const UPDATE: u16 = 0x1000;
2100
2101                         let mut res = None;
2102                         let mut htlc_msat = *first_hop_htlc_msat;
2103
2104                         // Handle packed channel/node updates for passing back for the route handler
2105                         Self::construct_onion_keys_callback(&self.secp_ctx, route, session_priv, |shared_secret, _, _, route_hop| {
2106                                 if res.is_some() { return; }
2107
2108                                 let incoming_htlc_msat = htlc_msat;
2109                                 let amt_to_forward = htlc_msat - route_hop.fee_msat;
2110                                 htlc_msat = amt_to_forward;
2111
2112                                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret[..]);
2113
2114                                 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
2115                                 decryption_tmp.resize(packet_decrypted.len(), 0);
2116                                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
2117                                 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
2118                                 packet_decrypted = decryption_tmp;
2119
2120                                 let is_from_final_node = route.hops.last().unwrap().pubkey == route_hop.pubkey;
2121
2122                                 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
2123                                         let um = ChannelManager::gen_um_from_shared_secret(&shared_secret[..]);
2124                                         let mut hmac = Hmac::new(Sha256::new(), &um);
2125                                         hmac.input(&err_packet.encode()[32..]);
2126                                         let mut calc_tag = [0u8; 32];
2127                                         hmac.raw_result(&mut calc_tag);
2128
2129                                         if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
2130                                                 if err_packet.failuremsg.len() < 2 {
2131                                                         // Useless packet that we can't use but it passed HMAC, so it
2132                                                         // definitely came from the peer in question
2133                                                         res = Some((None, !is_from_final_node));
2134                                                 } else {
2135                                                         let error_code = byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]);
2136
2137                                                         match error_code & 0xff {
2138                                                                 1|2|3 => {
2139                                                                         // either from an intermediate or final node
2140                                                                         //   invalid_realm(PERM|1),
2141                                                                         //   temporary_node_failure(NODE|2)
2142                                                                         //   permanent_node_failure(PERM|NODE|2)
2143                                                                         //   required_node_feature_mssing(PERM|NODE|3)
2144                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2145                                                                                 node_id: route_hop.pubkey,
2146                                                                                 is_permanent: error_code & PERM == PERM,
2147                                                                         }), !(error_code & PERM == PERM && is_from_final_node)));
2148                                                                         // node returning invalid_realm is removed from network_map,
2149                                                                         // although NODE flag is not set, TODO: or remove channel only?
2150                                                                         // retry payment when removed node is not a final node
2151                                                                         return;
2152                                                                 },
2153                                                                 _ => {}
2154                                                         }
2155
2156                                                         if is_from_final_node {
2157                                                                 let payment_retryable = match error_code {
2158                                                                         c if c == PERM|15 => false, // unknown_payment_hash
2159                                                                         c if c == PERM|16 => false, // incorrect_payment_amount
2160                                                                         17 => true, // final_expiry_too_soon
2161                                                                         18 if err_packet.failuremsg.len() == 6 => { // final_incorrect_cltv_expiry
2162                                                                                 let _reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2163                                                                                 true
2164                                                                         },
2165                                                                         19 if err_packet.failuremsg.len() == 10 => { // final_incorrect_htlc_amount
2166                                                                                 let _reported_incoming_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2167                                                                                 true
2168                                                                         },
2169                                                                         _ => {
2170                                                                                 // A final node has sent us either an invalid code or an error_code that
2171                                                                                 // MUST be sent from the processing node, or the formmat of failuremsg
2172                                                                                 // does not coform to the spec.
2173                                                                                 // Remove it from the network map and don't may retry payment
2174                                                                                 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2175                                                                                         node_id: route_hop.pubkey,
2176                                                                                         is_permanent: true,
2177                                                                                 }), false));
2178                                                                                 return;
2179                                                                         }
2180                                                                 };
2181                                                                 res = Some((None, payment_retryable));
2182                                                                 return;
2183                                                         }
2184
2185                                                         // now, error_code should be only from the intermediate nodes
2186                                                         match error_code {
2187                                                                 _c if error_code & PERM == PERM => {
2188                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
2189                                                                                 short_channel_id: route_hop.short_channel_id,
2190                                                                                 is_permanent: true,
2191                                                                         }), false));
2192                                                                 },
2193                                                                 _c if error_code & UPDATE == UPDATE => {
2194                                                                         let offset = match error_code {
2195                                                                                 c if c == UPDATE|7  => 0, // temporary_channel_failure
2196                                                                                 c if c == UPDATE|11 => 8, // amount_below_minimum
2197                                                                                 c if c == UPDATE|12 => 8, // fee_insufficient
2198                                                                                 c if c == UPDATE|13 => 4, // incorrect_cltv_expiry
2199                                                                                 c if c == UPDATE|14 => 0, // expiry_too_soon
2200                                                                                 c if c == UPDATE|20 => 2, // channel_disabled
2201                                                                                 _ =>  {
2202                                                                                         // node sending unknown code
2203                                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2204                                                                                                 node_id: route_hop.pubkey,
2205                                                                                                 is_permanent: true,
2206                                                                                         }), false));
2207                                                                                         return;
2208                                                                                 }
2209                                                                         };
2210
2211                                                                         if err_packet.failuremsg.len() >= offset + 2 {
2212                                                                                 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[offset+2..offset+4]) as usize;
2213                                                                                 if err_packet.failuremsg.len() >= offset + 4 + update_len {
2214                                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&err_packet.failuremsg[offset + 4..offset + 4 + update_len])) {
2215                                                                                                 // if channel_update should NOT have caused the failure:
2216                                                                                                 // MAY treat the channel_update as invalid.
2217                                                                                                 let is_chan_update_invalid = match error_code {
2218                                                                                                         c if c == UPDATE|7 => { // temporary_channel_failure
2219                                                                                                                 false
2220                                                                                                         },
2221                                                                                                         c if c == UPDATE|11 => { // amount_below_minimum
2222                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2223                                                                                                                 onion_failure_log!("amount_below_minimum", UPDATE|11, "htlc_msat", reported_htlc_msat);
2224                                                                                                                 incoming_htlc_msat > chan_update.contents.htlc_minimum_msat
2225                                                                                                         },
2226                                                                                                         c if c == UPDATE|12 => { // fee_insufficient
2227                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2228                                                                                                                 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) });
2229                                                                                                                 onion_failure_log!("fee_insufficient", UPDATE|12, "htlc_msat", reported_htlc_msat);
2230                                                                                                                 new_fee.is_none() || incoming_htlc_msat >= new_fee.unwrap() && incoming_htlc_msat >= amt_to_forward + new_fee.unwrap()
2231                                                                                                         }
2232                                                                                                         c if c == UPDATE|13 => { // incorrect_cltv_expiry
2233                                                                                                                 let reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2234                                                                                                                 onion_failure_log!("incorrect_cltv_expiry", UPDATE|13, "cltv_expiry", reported_cltv_expiry);
2235                                                                                                                 route_hop.cltv_expiry_delta as u16 >= chan_update.contents.cltv_expiry_delta
2236                                                                                                         },
2237                                                                                                         c if c == UPDATE|20 => { // channel_disabled
2238                                                                                                                 let reported_flags = byte_utils::slice_to_be16(&err_packet.failuremsg[2..2+2]);
2239                                                                                                                 onion_failure_log!("channel_disabled", UPDATE|20, "flags", reported_flags);
2240                                                                                                                 chan_update.contents.flags & 0x01 == 0x01
2241                                                                                                         },
2242                                                                                                         c if c == UPDATE|21 => true, // expiry_too_far
2243                                                                                                         _ => { unreachable!(); },
2244                                                                                                 };
2245
2246                                                                                                 let msg = if is_chan_update_invalid { None } else {
2247                                                                                                         Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
2248                                                                                                                 msg: chan_update,
2249                                                                                                         })
2250                                                                                                 };
2251                                                                                                 res = Some((msg, true));
2252                                                                                                 return;
2253                                                                                         }
2254                                                                                 }
2255                                                                         }
2256                                                                 },
2257                                                                 _c if error_code & BADONION == BADONION => {
2258                                                                         //TODO
2259                                                                 },
2260                                                                 14 => { // expiry_too_soon
2261                                                                         res = Some((None, true));
2262                                                                         return;
2263                                                                 }
2264                                                                 _ => {
2265                                                                         // node sending unknown code
2266                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2267                                                                                 node_id: route_hop.pubkey,
2268                                                                                 is_permanent: true,
2269                                                                         }), false));
2270                                                                         return;
2271                                                                 }
2272                                                         }
2273                                                 }
2274                                         }
2275                                 }
2276                         }).expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
2277                         res.unwrap_or((None, true))
2278                 } else { ((None, true)) }
2279         }
2280
2281         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2282                 let mut channel_lock = self.channel_state.lock().unwrap();
2283                 let channel_state = channel_lock.borrow_parts();
2284                 match channel_state.by_id.entry(msg.channel_id) {
2285                         hash_map::Entry::Occupied(mut chan) => {
2286                                 if chan.get().get_their_node_id() != *their_node_id {
2287                                         //TODO: here and below MsgHandleErrInternal, #153 case
2288                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2289                                 }
2290                                 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() }), channel_state, chan);
2291                         },
2292                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2293                 }
2294                 Ok(())
2295         }
2296
2297         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2298                 let mut channel_lock = self.channel_state.lock().unwrap();
2299                 let channel_state = channel_lock.borrow_parts();
2300                 match channel_state.by_id.entry(msg.channel_id) {
2301                         hash_map::Entry::Occupied(mut chan) => {
2302                                 if chan.get().get_their_node_id() != *their_node_id {
2303                                         //TODO: here and below MsgHandleErrInternal, #153 case
2304                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2305                                 }
2306                                 if (msg.failure_code & 0x8000) == 0 {
2307                                         try_chan_entry!(self, Err(ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set")), channel_state, chan);
2308                                 }
2309                                 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() }), channel_state, chan);
2310                                 Ok(())
2311                         },
2312                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2313                 }
2314         }
2315
2316         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2317                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2318                 let channel_state = channel_state_lock.borrow_parts();
2319                 match channel_state.by_id.entry(msg.channel_id) {
2320                         hash_map::Entry::Occupied(mut chan) => {
2321                                 if chan.get().get_their_node_id() != *their_node_id {
2322                                         //TODO: here and below MsgHandleErrInternal, #153 case
2323                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2324                                 }
2325                                 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) =
2326                                         try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &*self.fee_estimator), channel_state, chan);
2327                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2328                                         return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, commitment_signed.is_some());
2329                                         //TODO: Rebroadcast closing_signed if present on monitor update restoration
2330                                 }
2331                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2332                                         node_id: their_node_id.clone(),
2333                                         msg: revoke_and_ack,
2334                                 });
2335                                 if let Some(msg) = commitment_signed {
2336                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2337                                                 node_id: their_node_id.clone(),
2338                                                 updates: msgs::CommitmentUpdate {
2339                                                         update_add_htlcs: Vec::new(),
2340                                                         update_fulfill_htlcs: Vec::new(),
2341                                                         update_fail_htlcs: Vec::new(),
2342                                                         update_fail_malformed_htlcs: Vec::new(),
2343                                                         update_fee: None,
2344                                                         commitment_signed: msg,
2345                                                 },
2346                                         });
2347                                 }
2348                                 if let Some(msg) = closing_signed {
2349                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2350                                                 node_id: their_node_id.clone(),
2351                                                 msg,
2352                                         });
2353                                 }
2354                                 Ok(())
2355                         },
2356                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2357                 }
2358         }
2359
2360         #[inline]
2361         fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2362                 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2363                         let mut forward_event = None;
2364                         if !pending_forwards.is_empty() {
2365                                 let mut channel_state = self.channel_state.lock().unwrap();
2366                                 if channel_state.forward_htlcs.is_empty() {
2367                                         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));
2368                                         channel_state.next_forward = forward_event.unwrap();
2369                                 }
2370                                 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2371                                         match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2372                                                 hash_map::Entry::Occupied(mut entry) => {
2373                                                         entry.get_mut().push(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info });
2374                                                 },
2375                                                 hash_map::Entry::Vacant(entry) => {
2376                                                         entry.insert(vec!(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info }));
2377                                                 }
2378                                         }
2379                                 }
2380                         }
2381                         match forward_event {
2382                                 Some(time) => {
2383                                         let mut pending_events = self.pending_events.lock().unwrap();
2384                                         pending_events.push(events::Event::PendingHTLCsForwardable {
2385                                                 time_forwardable: time
2386                                         });
2387                                 }
2388                                 None => {},
2389                         }
2390                 }
2391         }
2392
2393         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2394                 let (pending_forwards, mut pending_failures, short_channel_id) = {
2395                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2396                         let channel_state = channel_state_lock.borrow_parts();
2397                         match channel_state.by_id.entry(msg.channel_id) {
2398                                 hash_map::Entry::Occupied(mut chan) => {
2399                                         if chan.get().get_their_node_id() != *their_node_id {
2400                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2401                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2402                                         }
2403                                         let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) =
2404                                                 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &*self.fee_estimator), channel_state, chan);
2405                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2406                                                 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, pending_forwards, pending_failures);
2407                                         }
2408                                         if let Some(updates) = commitment_update {
2409                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2410                                                         node_id: their_node_id.clone(),
2411                                                         updates,
2412                                                 });
2413                                         }
2414                                         if let Some(msg) = closing_signed {
2415                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2416                                                         node_id: their_node_id.clone(),
2417                                                         msg,
2418                                                 });
2419                                         }
2420                                         (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2421                                 },
2422                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2423                         }
2424                 };
2425                 for failure in pending_failures.drain(..) {
2426                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2427                 }
2428                 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2429
2430                 Ok(())
2431         }
2432
2433         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2434                 let mut channel_lock = self.channel_state.lock().unwrap();
2435                 let channel_state = channel_lock.borrow_parts();
2436                 match channel_state.by_id.entry(msg.channel_id) {
2437                         hash_map::Entry::Occupied(mut chan) => {
2438                                 if chan.get().get_their_node_id() != *their_node_id {
2439                                         //TODO: here and below MsgHandleErrInternal, #153 case
2440                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2441                                 }
2442                                 try_chan_entry!(self, chan.get_mut().update_fee(&*self.fee_estimator, &msg), channel_state, chan);
2443                         },
2444                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2445                 }
2446                 Ok(())
2447         }
2448
2449         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2450                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2451                 let channel_state = channel_state_lock.borrow_parts();
2452
2453                 match channel_state.by_id.entry(msg.channel_id) {
2454                         hash_map::Entry::Occupied(mut chan) => {
2455                                 if chan.get().get_their_node_id() != *their_node_id {
2456                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2457                                 }
2458                                 if !chan.get().is_usable() {
2459                                         return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
2460                                 }
2461
2462                                 let our_node_id = self.get_our_node_id();
2463                                 let (announcement, our_bitcoin_sig) =
2464                                         try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2465
2466                                 let were_node_one = announcement.node_id_1 == our_node_id;
2467                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2468                                 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2469                                                 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2470                                         try_chan_entry!(self, Err(ChannelError::Close("Bad announcement_signatures node_signature")), channel_state, chan);
2471                                 }
2472
2473                                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2474
2475                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2476                                         msg: msgs::ChannelAnnouncement {
2477                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2478                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2479                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2480                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2481                                                 contents: announcement,
2482                                         },
2483                                         update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2484                                 });
2485                         },
2486                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2487                 }
2488                 Ok(())
2489         }
2490
2491         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2492                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2493                 let channel_state = channel_state_lock.borrow_parts();
2494
2495                 match channel_state.by_id.entry(msg.channel_id) {
2496                         hash_map::Entry::Occupied(mut chan) => {
2497                                 if chan.get().get_their_node_id() != *their_node_id {
2498                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2499                                 }
2500                                 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, mut order, shutdown) =
2501                                         try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2502                                 if let Some(monitor) = channel_monitor {
2503                                         if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2504                                                 // channel_reestablish doesn't guarantee the order it returns is sensical
2505                                                 // for the messages it returns, but if we're setting what messages to
2506                                                 // re-transmit on monitor update success, we need to make sure it is sane.
2507                                                 if revoke_and_ack.is_none() {
2508                                                         order = RAACommitmentOrder::CommitmentFirst;
2509                                                 }
2510                                                 if commitment_update.is_none() {
2511                                                         order = RAACommitmentOrder::RevokeAndACKFirst;
2512                                                 }
2513                                                 return_monitor_err!(self, e, channel_state, chan, order);
2514                                                 //TODO: Resend the funding_locked if needed once we get the monitor running again
2515                                         }
2516                                 }
2517                                 if let Some(msg) = funding_locked {
2518                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2519                                                 node_id: their_node_id.clone(),
2520                                                 msg
2521                                         });
2522                                 }
2523                                 macro_rules! send_raa { () => {
2524                                         if let Some(msg) = revoke_and_ack {
2525                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2526                                                         node_id: their_node_id.clone(),
2527                                                         msg
2528                                                 });
2529                                         }
2530                                 } }
2531                                 macro_rules! send_cu { () => {
2532                                         if let Some(updates) = commitment_update {
2533                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2534                                                         node_id: their_node_id.clone(),
2535                                                         updates
2536                                                 });
2537                                         }
2538                                 } }
2539                                 match order {
2540                                         RAACommitmentOrder::RevokeAndACKFirst => {
2541                                                 send_raa!();
2542                                                 send_cu!();
2543                                         },
2544                                         RAACommitmentOrder::CommitmentFirst => {
2545                                                 send_cu!();
2546                                                 send_raa!();
2547                                         },
2548                                 }
2549                                 if let Some(msg) = shutdown {
2550                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2551                                                 node_id: their_node_id.clone(),
2552                                                 msg,
2553                                         });
2554                                 }
2555                                 Ok(())
2556                         },
2557                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2558                 }
2559         }
2560
2561         /// Begin Update fee process. Allowed only on an outbound channel.
2562         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2563         /// PeerManager::process_events afterwards.
2564         /// Note: This API is likely to change!
2565         #[doc(hidden)]
2566         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2567                 let _ = self.total_consistency_lock.read().unwrap();
2568                 let their_node_id;
2569                 let err: Result<(), _> = loop {
2570                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2571                         let channel_state = channel_state_lock.borrow_parts();
2572
2573                         match channel_state.by_id.entry(channel_id) {
2574                                 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2575                                 hash_map::Entry::Occupied(mut chan) => {
2576                                         if !chan.get().is_outbound() {
2577                                                 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2578                                         }
2579                                         if chan.get().is_awaiting_monitor_update() {
2580                                                 return Err(APIError::MonitorUpdateFailed);
2581                                         }
2582                                         if !chan.get().is_live() {
2583                                                 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2584                                         }
2585                                         their_node_id = chan.get().get_their_node_id();
2586                                         if let Some((update_fee, commitment_signed, chan_monitor)) =
2587                                                         break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2588                                         {
2589                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2590                                                         unimplemented!();
2591                                                 }
2592                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2593                                                         node_id: chan.get().get_their_node_id(),
2594                                                         updates: msgs::CommitmentUpdate {
2595                                                                 update_add_htlcs: Vec::new(),
2596                                                                 update_fulfill_htlcs: Vec::new(),
2597                                                                 update_fail_htlcs: Vec::new(),
2598                                                                 update_fail_malformed_htlcs: Vec::new(),
2599                                                                 update_fee: Some(update_fee),
2600                                                                 commitment_signed,
2601                                                         },
2602                                                 });
2603                                         }
2604                                 },
2605                         }
2606                         return Ok(())
2607                 };
2608
2609                 match handle_error!(self, err, their_node_id) {
2610                         Ok(_) => unreachable!(),
2611                         Err(e) => {
2612                                 if let Some(msgs::ErrorAction::IgnoreError) = e.action {
2613                                 } else {
2614                                         log_error!(self, "Got bad keys: {}!", e.err);
2615                                         let mut channel_state = self.channel_state.lock().unwrap();
2616                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
2617                                                 node_id: their_node_id,
2618                                                 action: e.action,
2619                                         });
2620                                 }
2621                                 Err(APIError::APIMisuseError { err: e.err })
2622                         },
2623                 }
2624         }
2625 }
2626
2627 impl events::MessageSendEventsProvider for ChannelManager {
2628         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2629                 // TODO: Event release to users and serialization is currently race-y: its very easy for a
2630                 // user to serialize a ChannelManager with pending events in it and lose those events on
2631                 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2632                 {
2633                         //TODO: This behavior should be documented.
2634                         for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2635                                 if let Some(preimage) = htlc_update.payment_preimage {
2636                                         self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2637                                 } else {
2638                                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
2639                                 }
2640                         }
2641                 }
2642
2643                 let mut ret = Vec::new();
2644                 let mut channel_state = self.channel_state.lock().unwrap();
2645                 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2646                 ret
2647         }
2648 }
2649
2650 impl events::EventsProvider for ChannelManager {
2651         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2652                 // TODO: Event release to users and serialization is currently race-y: its very easy for a
2653                 // user to serialize a ChannelManager with pending events in it and lose those events on
2654                 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2655                 {
2656                         //TODO: This behavior should be documented.
2657                         for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2658                                 if let Some(preimage) = htlc_update.payment_preimage {
2659                                         self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2660                                 } else {
2661                                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
2662                                 }
2663                         }
2664                 }
2665
2666                 let mut ret = Vec::new();
2667                 let mut pending_events = self.pending_events.lock().unwrap();
2668                 mem::swap(&mut ret, &mut *pending_events);
2669                 ret
2670         }
2671 }
2672
2673 impl ChainListener for ChannelManager {
2674         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2675                 let _ = self.total_consistency_lock.read().unwrap();
2676                 let mut failed_channels = Vec::new();
2677                 {
2678                         let mut channel_lock = self.channel_state.lock().unwrap();
2679                         let channel_state = channel_lock.borrow_parts();
2680                         let short_to_id = channel_state.short_to_id;
2681                         let pending_msg_events = channel_state.pending_msg_events;
2682                         channel_state.by_id.retain(|_, channel| {
2683                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2684                                 if let Ok(Some(funding_locked)) = chan_res {
2685                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2686                                                 node_id: channel.get_their_node_id(),
2687                                                 msg: funding_locked,
2688                                         });
2689                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2690                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2691                                                         node_id: channel.get_their_node_id(),
2692                                                         msg: announcement_sigs,
2693                                                 });
2694                                         }
2695                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2696                                 } else if let Err(e) = chan_res {
2697                                         pending_msg_events.push(events::MessageSendEvent::HandleError {
2698                                                 node_id: channel.get_their_node_id(),
2699                                                 action: Some(msgs::ErrorAction::SendErrorMessage { msg: e }),
2700                                         });
2701                                         return false;
2702                                 }
2703                                 if let Some(funding_txo) = channel.get_funding_txo() {
2704                                         for tx in txn_matched {
2705                                                 for inp in tx.input.iter() {
2706                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2707                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2708                                                                         short_to_id.remove(&short_id);
2709                                                                 }
2710                                                                 // It looks like our counterparty went on-chain. We go ahead and
2711                                                                 // broadcast our latest local state as well here, just in case its
2712                                                                 // some kind of SPV attack, though we expect these to be dropped.
2713                                                                 failed_channels.push(channel.force_shutdown());
2714                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2715                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2716                                                                                 msg: update
2717                                                                         });
2718                                                                 }
2719                                                                 return false;
2720                                                         }
2721                                                 }
2722                                         }
2723                                 }
2724                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2725                                         if let Some(short_id) = channel.get_short_channel_id() {
2726                                                 short_to_id.remove(&short_id);
2727                                         }
2728                                         failed_channels.push(channel.force_shutdown());
2729                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2730                                         // the latest local tx for us, so we should skip that here (it doesn't really
2731                                         // hurt anything, but does make tests a bit simpler).
2732                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2733                                         if let Ok(update) = self.get_channel_update(&channel) {
2734                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2735                                                         msg: update
2736                                                 });
2737                                         }
2738                                         return false;
2739                                 }
2740                                 true
2741                         });
2742                 }
2743                 for failure in failed_channels.drain(..) {
2744                         self.finish_force_close_channel(failure);
2745                 }
2746                 self.latest_block_height.store(height as usize, Ordering::Release);
2747                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2748         }
2749
2750         /// We force-close the channel without letting our counterparty participate in the shutdown
2751         fn block_disconnected(&self, header: &BlockHeader) {
2752                 let _ = self.total_consistency_lock.read().unwrap();
2753                 let mut failed_channels = Vec::new();
2754                 {
2755                         let mut channel_lock = self.channel_state.lock().unwrap();
2756                         let channel_state = channel_lock.borrow_parts();
2757                         let short_to_id = channel_state.short_to_id;
2758                         let pending_msg_events = channel_state.pending_msg_events;
2759                         channel_state.by_id.retain(|_,  v| {
2760                                 if v.block_disconnected(header) {
2761                                         if let Some(short_id) = v.get_short_channel_id() {
2762                                                 short_to_id.remove(&short_id);
2763                                         }
2764                                         failed_channels.push(v.force_shutdown());
2765                                         if let Ok(update) = self.get_channel_update(&v) {
2766                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2767                                                         msg: update
2768                                                 });
2769                                         }
2770                                         false
2771                                 } else {
2772                                         true
2773                                 }
2774                         });
2775                 }
2776                 for failure in failed_channels.drain(..) {
2777                         self.finish_force_close_channel(failure);
2778                 }
2779                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2780                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2781         }
2782 }
2783
2784 impl ChannelMessageHandler for ChannelManager {
2785         //TODO: Handle errors and close channel (or so)
2786         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), HandleError> {
2787                 let _ = self.total_consistency_lock.read().unwrap();
2788                 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
2789         }
2790
2791         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2792                 let _ = self.total_consistency_lock.read().unwrap();
2793                 handle_error!(self, self.internal_accept_channel(their_node_id, msg), their_node_id)
2794         }
2795
2796         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), HandleError> {
2797                 let _ = self.total_consistency_lock.read().unwrap();
2798                 handle_error!(self, self.internal_funding_created(their_node_id, msg), their_node_id)
2799         }
2800
2801         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2802                 let _ = self.total_consistency_lock.read().unwrap();
2803                 handle_error!(self, self.internal_funding_signed(their_node_id, msg), their_node_id)
2804         }
2805
2806         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
2807                 let _ = self.total_consistency_lock.read().unwrap();
2808                 handle_error!(self, self.internal_funding_locked(their_node_id, msg), their_node_id)
2809         }
2810
2811         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), HandleError> {
2812                 let _ = self.total_consistency_lock.read().unwrap();
2813                 handle_error!(self, self.internal_shutdown(their_node_id, msg), their_node_id)
2814         }
2815
2816         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), HandleError> {
2817                 let _ = self.total_consistency_lock.read().unwrap();
2818                 handle_error!(self, self.internal_closing_signed(their_node_id, msg), their_node_id)
2819         }
2820
2821         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2822                 let _ = self.total_consistency_lock.read().unwrap();
2823                 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), their_node_id)
2824         }
2825
2826         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2827                 let _ = self.total_consistency_lock.read().unwrap();
2828                 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), their_node_id)
2829         }
2830
2831         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
2832                 let _ = self.total_consistency_lock.read().unwrap();
2833                 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), their_node_id)
2834         }
2835
2836         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2837                 let _ = self.total_consistency_lock.read().unwrap();
2838                 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), their_node_id)
2839         }
2840
2841         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), HandleError> {
2842                 let _ = self.total_consistency_lock.read().unwrap();
2843                 handle_error!(self, self.internal_commitment_signed(their_node_id, msg), their_node_id)
2844         }
2845
2846         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), HandleError> {
2847                 let _ = self.total_consistency_lock.read().unwrap();
2848                 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), their_node_id)
2849         }
2850
2851         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2852                 let _ = self.total_consistency_lock.read().unwrap();
2853                 handle_error!(self, self.internal_update_fee(their_node_id, msg), their_node_id)
2854         }
2855
2856         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2857                 let _ = self.total_consistency_lock.read().unwrap();
2858                 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2859         }
2860
2861         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), HandleError> {
2862                 let _ = self.total_consistency_lock.read().unwrap();
2863                 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), their_node_id)
2864         }
2865
2866         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2867                 let _ = self.total_consistency_lock.read().unwrap();
2868                 let mut failed_channels = Vec::new();
2869                 let mut failed_payments = Vec::new();
2870                 {
2871                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2872                         let channel_state = channel_state_lock.borrow_parts();
2873                         let short_to_id = channel_state.short_to_id;
2874                         let pending_msg_events = channel_state.pending_msg_events;
2875                         if no_connection_possible {
2876                                 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2877                                 channel_state.by_id.retain(|_, chan| {
2878                                         if chan.get_their_node_id() == *their_node_id {
2879                                                 if let Some(short_id) = chan.get_short_channel_id() {
2880                                                         short_to_id.remove(&short_id);
2881                                                 }
2882                                                 failed_channels.push(chan.force_shutdown());
2883                                                 if let Ok(update) = self.get_channel_update(&chan) {
2884                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2885                                                                 msg: update
2886                                                         });
2887                                                 }
2888                                                 false
2889                                         } else {
2890                                                 true
2891                                         }
2892                                 });
2893                         } else {
2894                                 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2895                                 channel_state.by_id.retain(|_, chan| {
2896                                         if chan.get_their_node_id() == *their_node_id {
2897                                                 //TODO: mark channel disabled (and maybe announce such after a timeout).
2898                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2899                                                 if !failed_adds.is_empty() {
2900                                                         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
2901                                                         failed_payments.push((chan_update, failed_adds));
2902                                                 }
2903                                                 if chan.is_shutdown() {
2904                                                         if let Some(short_id) = chan.get_short_channel_id() {
2905                                                                 short_to_id.remove(&short_id);
2906                                                         }
2907                                                         return false;
2908                                                 }
2909                                         }
2910                                         true
2911                                 })
2912                         }
2913                 }
2914                 for failure in failed_channels.drain(..) {
2915                         self.finish_force_close_channel(failure);
2916                 }
2917                 for (chan_update, mut htlc_sources) in failed_payments {
2918                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2919                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2920                         }
2921                 }
2922         }
2923
2924         fn peer_connected(&self, their_node_id: &PublicKey) {
2925                 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2926
2927                 let _ = self.total_consistency_lock.read().unwrap();
2928                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2929                 let channel_state = channel_state_lock.borrow_parts();
2930                 let pending_msg_events = channel_state.pending_msg_events;
2931                 channel_state.by_id.retain(|_, chan| {
2932                         if chan.get_their_node_id() == *their_node_id {
2933                                 if !chan.have_received_message() {
2934                                         // If we created this (outbound) channel while we were disconnected from the
2935                                         // peer we probably failed to send the open_channel message, which is now
2936                                         // lost. We can't have had anything pending related to this channel, so we just
2937                                         // drop it.
2938                                         false
2939                                 } else {
2940                                         pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2941                                                 node_id: chan.get_their_node_id(),
2942                                                 msg: chan.get_channel_reestablish(),
2943                                         });
2944                                         true
2945                                 }
2946                         } else { true }
2947                 });
2948                 //TODO: Also re-broadcast announcement_signatures
2949         }
2950
2951         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2952                 let _ = self.total_consistency_lock.read().unwrap();
2953
2954                 if msg.channel_id == [0; 32] {
2955                         for chan in self.list_channels() {
2956                                 if chan.remote_network_id == *their_node_id {
2957                                         self.force_close_channel(&chan.channel_id);
2958                                 }
2959                         }
2960                 } else {
2961                         self.force_close_channel(&msg.channel_id);
2962                 }
2963         }
2964 }
2965
2966 const SERIALIZATION_VERSION: u8 = 1;
2967 const MIN_SERIALIZATION_VERSION: u8 = 1;
2968
2969 impl Writeable for PendingForwardHTLCInfo {
2970         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2971                 if let &Some(ref onion) = &self.onion_packet {
2972                         1u8.write(writer)?;
2973                         onion.write(writer)?;
2974                 } else {
2975                         0u8.write(writer)?;
2976                 }
2977                 self.incoming_shared_secret.write(writer)?;
2978                 self.payment_hash.write(writer)?;
2979                 self.short_channel_id.write(writer)?;
2980                 self.amt_to_forward.write(writer)?;
2981                 self.outgoing_cltv_value.write(writer)?;
2982                 Ok(())
2983         }
2984 }
2985
2986 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
2987         fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
2988                 let onion_packet = match <u8 as Readable<R>>::read(reader)? {
2989                         0 => None,
2990                         1 => Some(msgs::OnionPacket::read(reader)?),
2991                         _ => return Err(DecodeError::InvalidValue),
2992                 };
2993                 Ok(PendingForwardHTLCInfo {
2994                         onion_packet,
2995                         incoming_shared_secret: Readable::read(reader)?,
2996                         payment_hash: Readable::read(reader)?,
2997                         short_channel_id: Readable::read(reader)?,
2998                         amt_to_forward: Readable::read(reader)?,
2999                         outgoing_cltv_value: Readable::read(reader)?,
3000                 })
3001         }
3002 }
3003
3004 impl Writeable for HTLCFailureMsg {
3005         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3006                 match self {
3007                         &HTLCFailureMsg::Relay(ref fail_msg) => {
3008                                 0u8.write(writer)?;
3009                                 fail_msg.write(writer)?;
3010                         },
3011                         &HTLCFailureMsg::Malformed(ref fail_msg) => {
3012                                 1u8.write(writer)?;
3013                                 fail_msg.write(writer)?;
3014                         }
3015                 }
3016                 Ok(())
3017         }
3018 }
3019
3020 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
3021         fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3022                 match <u8 as Readable<R>>::read(reader)? {
3023                         0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
3024                         1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
3025                         _ => Err(DecodeError::InvalidValue),
3026                 }
3027         }
3028 }
3029
3030 impl Writeable for PendingHTLCStatus {
3031         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3032                 match self {
3033                         &PendingHTLCStatus::Forward(ref forward_info) => {
3034                                 0u8.write(writer)?;
3035                                 forward_info.write(writer)?;
3036                         },
3037                         &PendingHTLCStatus::Fail(ref fail_msg) => {
3038                                 1u8.write(writer)?;
3039                                 fail_msg.write(writer)?;
3040                         }
3041                 }
3042                 Ok(())
3043         }
3044 }
3045
3046 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3047         fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3048                 match <u8 as Readable<R>>::read(reader)? {
3049                         0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3050                         1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3051                         _ => Err(DecodeError::InvalidValue),
3052                 }
3053         }
3054 }
3055
3056 impl_writeable!(HTLCPreviousHopData, 0, {
3057         short_channel_id,
3058         htlc_id,
3059         incoming_packet_shared_secret
3060 });
3061
3062 impl Writeable for HTLCSource {
3063         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3064                 match self {
3065                         &HTLCSource::PreviousHopData(ref hop_data) => {
3066                                 0u8.write(writer)?;
3067                                 hop_data.write(writer)?;
3068                         },
3069                         &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
3070                                 1u8.write(writer)?;
3071                                 route.write(writer)?;
3072                                 session_priv.write(writer)?;
3073                                 first_hop_htlc_msat.write(writer)?;
3074                         }
3075                 }
3076                 Ok(())
3077         }
3078 }
3079
3080 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3081         fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3082                 match <u8 as Readable<R>>::read(reader)? {
3083                         0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3084                         1 => Ok(HTLCSource::OutboundRoute {
3085                                 route: Readable::read(reader)?,
3086                                 session_priv: Readable::read(reader)?,
3087                                 first_hop_htlc_msat: Readable::read(reader)?,
3088                         }),
3089                         _ => Err(DecodeError::InvalidValue),
3090                 }
3091         }
3092 }
3093
3094 impl Writeable for HTLCFailReason {
3095         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3096                 match self {
3097                         &HTLCFailReason::ErrorPacket { ref err } => {
3098                                 0u8.write(writer)?;
3099                                 err.write(writer)?;
3100                         },
3101                         &HTLCFailReason::Reason { ref failure_code, ref data } => {
3102                                 1u8.write(writer)?;
3103                                 failure_code.write(writer)?;
3104                                 data.write(writer)?;
3105                         }
3106                 }
3107                 Ok(())
3108         }
3109 }
3110
3111 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3112         fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3113                 match <u8 as Readable<R>>::read(reader)? {
3114                         0 => Ok(HTLCFailReason::ErrorPacket { err: Readable::read(reader)? }),
3115                         1 => Ok(HTLCFailReason::Reason {
3116                                 failure_code: Readable::read(reader)?,
3117                                 data: Readable::read(reader)?,
3118                         }),
3119                         _ => Err(DecodeError::InvalidValue),
3120                 }
3121         }
3122 }
3123
3124 impl_writeable!(HTLCForwardInfo, 0, {
3125         prev_short_channel_id,
3126         prev_htlc_id,
3127         forward_info
3128 });
3129
3130 impl Writeable for ChannelManager {
3131         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3132                 let _ = self.total_consistency_lock.write().unwrap();
3133
3134                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3135                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3136
3137                 self.genesis_hash.write(writer)?;
3138                 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3139                 self.last_block_hash.lock().unwrap().write(writer)?;
3140
3141                 let channel_state = self.channel_state.lock().unwrap();
3142                 let mut unfunded_channels = 0;
3143                 for (_, channel) in channel_state.by_id.iter() {
3144                         if !channel.is_funding_initiated() {
3145                                 unfunded_channels += 1;
3146                         }
3147                 }
3148                 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3149                 for (_, channel) in channel_state.by_id.iter() {
3150                         if channel.is_funding_initiated() {
3151                                 channel.write(writer)?;
3152                         }
3153                 }
3154
3155                 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3156                 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3157                         short_channel_id.write(writer)?;
3158                         (pending_forwards.len() as u64).write(writer)?;
3159                         for forward in pending_forwards {
3160                                 forward.write(writer)?;
3161                         }
3162                 }
3163
3164                 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3165                 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3166                         payment_hash.write(writer)?;
3167                         (previous_hops.len() as u64).write(writer)?;
3168                         for previous_hop in previous_hops {
3169                                 previous_hop.write(writer)?;
3170                         }
3171                 }
3172
3173                 Ok(())
3174         }
3175 }
3176
3177 /// Arguments for the creation of a ChannelManager that are not deserialized.
3178 ///
3179 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3180 /// is:
3181 /// 1) Deserialize all stored ChannelMonitors.
3182 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3183 ///    ChannelManager)>::read(reader, args).
3184 ///    This may result in closing some Channels if the ChannelMonitor is newer than the stored
3185 ///    ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3186 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3187 ///    ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3188 /// 4) Reconnect blocks on your ChannelMonitors.
3189 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3190 /// 6) Disconnect/connect blocks on the ChannelManager.
3191 /// 7) Register the new ChannelManager with your ChainWatchInterface (this does not happen
3192 ///    automatically as it does in ChannelManager::new()).
3193 pub struct ChannelManagerReadArgs<'a> {
3194         /// The keys provider which will give us relevant keys. Some keys will be loaded during
3195         /// deserialization.
3196         pub keys_manager: Arc<KeysInterface>,
3197
3198         /// The fee_estimator for use in the ChannelManager in the future.
3199         ///
3200         /// No calls to the FeeEstimator will be made during deserialization.
3201         pub fee_estimator: Arc<FeeEstimator>,
3202         /// The ManyChannelMonitor for use in the ChannelManager in the future.
3203         ///
3204         /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3205         /// you have deserialized ChannelMonitors separately and will add them to your
3206         /// ManyChannelMonitor after deserializing this ChannelManager.
3207         pub monitor: Arc<ManyChannelMonitor>,
3208         /// The ChainWatchInterface for use in the ChannelManager in the future.
3209         ///
3210         /// No calls to the ChainWatchInterface will be made during deserialization.
3211         pub chain_monitor: Arc<ChainWatchInterface>,
3212         /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3213         /// used to broadcast the latest local commitment transactions of channels which must be
3214         /// force-closed during deserialization.
3215         pub tx_broadcaster: Arc<BroadcasterInterface>,
3216         /// The Logger for use in the ChannelManager and which may be used to log information during
3217         /// deserialization.
3218         pub logger: Arc<Logger>,
3219         /// Default settings used for new channels. Any existing channels will continue to use the
3220         /// runtime settings which were stored when the ChannelManager was serialized.
3221         pub default_config: UserConfig,
3222
3223         /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3224         /// value.get_funding_txo() should be the key).
3225         ///
3226         /// If a monitor is inconsistent with the channel state during deserialization the channel will
3227         /// be force-closed using the data in the channelmonitor and the Channel will be dropped. This
3228         /// is true for missing channels as well. If there is a monitor missing for which we find
3229         /// channel data Err(DecodeError::InvalidValue) will be returned.
3230         ///
3231         /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3232         /// this struct.
3233         pub channel_monitors: &'a HashMap<OutPoint, &'a ChannelMonitor>,
3234 }
3235
3236 impl<'a, R : ::std::io::Read> ReadableArgs<R, ChannelManagerReadArgs<'a>> for (Sha256dHash, ChannelManager) {
3237         fn read(reader: &mut R, args: ChannelManagerReadArgs<'a>) -> Result<Self, DecodeError> {
3238                 let _ver: u8 = Readable::read(reader)?;
3239                 let min_ver: u8 = Readable::read(reader)?;
3240                 if min_ver > SERIALIZATION_VERSION {
3241                         return Err(DecodeError::UnknownVersion);
3242                 }
3243
3244                 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3245                 let latest_block_height: u32 = Readable::read(reader)?;
3246                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3247
3248                 let mut closed_channels = Vec::new();
3249
3250                 let channel_count: u64 = Readable::read(reader)?;
3251                 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3252                 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3253                 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3254                 for _ in 0..channel_count {
3255                         let mut channel: Channel = ReadableArgs::read(reader, args.logger.clone())?;
3256                         if channel.last_block_connected != last_block_hash {
3257                                 return Err(DecodeError::InvalidValue);
3258                         }
3259
3260                         let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3261                         funding_txo_set.insert(funding_txo.clone());
3262                         if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
3263                                 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3264                                                 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3265                                                 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3266                                         let mut force_close_res = channel.force_shutdown();
3267                                         force_close_res.0 = monitor.get_latest_local_commitment_txn();
3268                                         closed_channels.push(force_close_res);
3269                                 } else {
3270                                         if let Some(short_channel_id) = channel.get_short_channel_id() {
3271                                                 short_to_id.insert(short_channel_id, channel.channel_id());
3272                                         }
3273                                         by_id.insert(channel.channel_id(), channel);
3274                                 }
3275                         } else {
3276                                 return Err(DecodeError::InvalidValue);
3277                         }
3278                 }
3279
3280                 for (ref funding_txo, ref monitor) in args.channel_monitors.iter() {
3281                         if !funding_txo_set.contains(funding_txo) {
3282                                 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3283                         }
3284                 }
3285
3286                 let forward_htlcs_count: u64 = Readable::read(reader)?;
3287                 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3288                 for _ in 0..forward_htlcs_count {
3289                         let short_channel_id = Readable::read(reader)?;
3290                         let pending_forwards_count: u64 = Readable::read(reader)?;
3291                         let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3292                         for _ in 0..pending_forwards_count {
3293                                 pending_forwards.push(Readable::read(reader)?);
3294                         }
3295                         forward_htlcs.insert(short_channel_id, pending_forwards);
3296                 }
3297
3298                 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3299                 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3300                 for _ in 0..claimable_htlcs_count {
3301                         let payment_hash = Readable::read(reader)?;
3302                         let previous_hops_len: u64 = Readable::read(reader)?;
3303                         let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3304                         for _ in 0..previous_hops_len {
3305                                 previous_hops.push(Readable::read(reader)?);
3306                         }
3307                         claimable_htlcs.insert(payment_hash, previous_hops);
3308                 }
3309
3310                 let channel_manager = ChannelManager {
3311                         genesis_hash,
3312                         fee_estimator: args.fee_estimator,
3313                         monitor: args.monitor,
3314                         chain_monitor: args.chain_monitor,
3315                         tx_broadcaster: args.tx_broadcaster,
3316
3317                         latest_block_height: AtomicUsize::new(latest_block_height as usize),
3318                         last_block_hash: Mutex::new(last_block_hash),
3319                         secp_ctx: Secp256k1::new(),
3320
3321                         channel_state: Mutex::new(ChannelHolder {
3322                                 by_id,
3323                                 short_to_id,
3324                                 next_forward: Instant::now(),
3325                                 forward_htlcs,
3326                                 claimable_htlcs,
3327                                 pending_msg_events: Vec::new(),
3328                         }),
3329                         our_network_key: args.keys_manager.get_node_secret(),
3330
3331                         pending_events: Mutex::new(Vec::new()),
3332                         total_consistency_lock: RwLock::new(()),
3333                         keys_manager: args.keys_manager,
3334                         logger: args.logger,
3335                         default_configuration: args.default_config,
3336                 };
3337
3338                 for close_res in closed_channels.drain(..) {
3339                         channel_manager.finish_force_close_channel(close_res);
3340                         //TODO: Broadcast channel update for closed channels, but only after we've made a
3341                         //connection or two.
3342                 }
3343
3344                 Ok((last_block_hash.clone(), channel_manager))
3345         }
3346 }
3347
3348 #[cfg(test)]
3349 mod tests {
3350         use chain::chaininterface;
3351         use chain::transaction::OutPoint;
3352         use chain::chaininterface::{ChainListener, ChainWatchInterface};
3353         use chain::keysinterface::{KeysInterface, SpendableOutputDescriptor};
3354         use chain::keysinterface;
3355         use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
3356         use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,OnionKeys,PaymentFailReason,RAACommitmentOrder};
3357         use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS, ManyChannelMonitor};
3358         use ln::channel::{ACCEPTED_HTLC_SCRIPT_WEIGHT, OFFERED_HTLC_SCRIPT_WEIGHT};
3359         use ln::router::{Route, RouteHop, Router};
3360         use ln::msgs;
3361         use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
3362         use util::test_utils;
3363         use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
3364         use util::errors::APIError;
3365         use util::logger::Logger;
3366         use util::ser::{Writeable, Writer, ReadableArgs};
3367         use util::config::UserConfig;
3368
3369         use bitcoin::util::hash::{BitcoinHash, Sha256dHash};
3370         use bitcoin::util::bip143;
3371         use bitcoin::util::address::Address;
3372         use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
3373         use bitcoin::blockdata::block::{Block, BlockHeader};
3374         use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
3375         use bitcoin::blockdata::script::{Builder, Script};
3376         use bitcoin::blockdata::opcodes;
3377         use bitcoin::blockdata::constants::genesis_block;
3378         use bitcoin::network::constants::Network;
3379
3380         use hex;
3381
3382         use secp256k1::{Secp256k1, Message};
3383         use secp256k1::key::{PublicKey,SecretKey};
3384
3385         use crypto::sha2::Sha256;
3386         use crypto::digest::Digest;
3387
3388         use rand::{thread_rng,Rng};
3389
3390         use std::cell::RefCell;
3391         use std::collections::{BTreeSet, HashMap};
3392         use std::default::Default;
3393         use std::rc::Rc;
3394         use std::sync::{Arc, Mutex};
3395         use std::sync::atomic::Ordering;
3396         use std::time::Instant;
3397         use std::mem;
3398
3399         fn build_test_onion_keys() -> Vec<OnionKeys> {
3400                 // Keys from BOLT 4, used in both test vector tests
3401                 let secp_ctx = Secp256k1::new();
3402
3403                 let route = Route {
3404                         hops: vec!(
3405                                         RouteHop {
3406                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
3407                                                 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
3408                                         },
3409                                         RouteHop {
3410                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
3411                                                 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
3412                                         },
3413                                         RouteHop {
3414                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
3415                                                 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
3416                                         },
3417                                         RouteHop {
3418                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
3419                                                 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
3420                                         },
3421                                         RouteHop {
3422                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
3423                                                 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
3424                                         },
3425                         ),
3426                 };
3427
3428                 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
3429
3430                 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
3431                 assert_eq!(onion_keys.len(), route.hops.len());
3432                 onion_keys
3433         }
3434
3435         #[test]
3436         fn onion_vectors() {
3437                 // Packet creation test vectors from BOLT 4
3438                 let onion_keys = build_test_onion_keys();
3439
3440                 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
3441                 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
3442                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
3443                 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
3444                 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
3445
3446                 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
3447                 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
3448                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
3449                 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
3450                 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
3451
3452                 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
3453                 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
3454                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
3455                 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
3456                 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
3457
3458                 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
3459                 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
3460                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
3461                 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
3462                 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
3463
3464                 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
3465                 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
3466                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
3467                 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
3468                 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
3469
3470                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
3471                 let payloads = vec!(
3472                         msgs::OnionHopData {
3473                                 realm: 0,
3474                                 data: msgs::OnionRealm0HopData {
3475                                         short_channel_id: 0,
3476                                         amt_to_forward: 0,
3477                                         outgoing_cltv_value: 0,
3478                                 },
3479                                 hmac: [0; 32],
3480                         },
3481                         msgs::OnionHopData {
3482                                 realm: 0,
3483                                 data: msgs::OnionRealm0HopData {
3484                                         short_channel_id: 0x0101010101010101,
3485                                         amt_to_forward: 0x0100000001,
3486                                         outgoing_cltv_value: 0,
3487                                 },
3488                                 hmac: [0; 32],
3489                         },
3490                         msgs::OnionHopData {
3491                                 realm: 0,
3492                                 data: msgs::OnionRealm0HopData {
3493                                         short_channel_id: 0x0202020202020202,
3494                                         amt_to_forward: 0x0200000002,
3495                                         outgoing_cltv_value: 0,
3496                                 },
3497                                 hmac: [0; 32],
3498                         },
3499                         msgs::OnionHopData {
3500                                 realm: 0,
3501                                 data: msgs::OnionRealm0HopData {
3502                                         short_channel_id: 0x0303030303030303,
3503                                         amt_to_forward: 0x0300000003,
3504                                         outgoing_cltv_value: 0,
3505                                 },
3506                                 hmac: [0; 32],
3507                         },
3508                         msgs::OnionHopData {
3509                                 realm: 0,
3510                                 data: msgs::OnionRealm0HopData {
3511                                         short_channel_id: 0x0404040404040404,
3512                                         amt_to_forward: 0x0400000004,
3513                                         outgoing_cltv_value: 0,
3514                                 },
3515                                 hmac: [0; 32],
3516                         },
3517                 );
3518
3519                 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]);
3520                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
3521                 // anyway...
3522                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
3523         }
3524
3525         #[test]
3526         fn test_failure_packet_onion() {
3527                 // Returning Errors test vectors from BOLT 4
3528
3529                 let onion_keys = build_test_onion_keys();
3530                 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret[..], 0x2002, &[0; 0]);
3531                 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
3532
3533                 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret[..], &onion_error.encode()[..]);
3534                 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
3535
3536                 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret[..], &onion_packet_1.data[..]);
3537                 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
3538
3539                 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret[..], &onion_packet_2.data[..]);
3540                 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
3541
3542                 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret[..], &onion_packet_3.data[..]);
3543                 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
3544
3545                 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret[..], &onion_packet_4.data[..]);
3546                 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
3547         }
3548
3549         fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
3550                 assert!(chain.does_match_tx(tx));
3551                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3552                 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
3553                 for i in 2..100 {
3554                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3555                         chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
3556                 }
3557         }
3558
3559         struct Node {
3560                 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
3561                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
3562                 chan_monitor: Arc<test_utils::TestChannelMonitor>,
3563                 node: Arc<ChannelManager>,
3564                 router: Router,
3565                 node_seed: [u8; 32],
3566                 network_payment_count: Rc<RefCell<u8>>,
3567                 network_chan_count: Rc<RefCell<u32>>,
3568         }
3569         impl Drop for Node {
3570                 fn drop(&mut self) {
3571                         if !::std::thread::panicking() {
3572                                 // Check that we processed all pending events
3573                                 assert_eq!(self.node.get_and_clear_pending_msg_events().len(), 0);
3574                                 assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
3575                                 assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3576                         }
3577                 }
3578         }
3579
3580         fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3581                 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
3582         }
3583
3584         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) {
3585                 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
3586                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
3587                 (announcement, as_update, bs_update, channel_id, tx)
3588         }
3589
3590         macro_rules! get_revoke_commit_msgs {
3591                 ($node: expr, $node_id: expr) => {
3592                         {
3593                                 let events = $node.node.get_and_clear_pending_msg_events();
3594                                 assert_eq!(events.len(), 2);
3595                                 (match events[0] {
3596                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3597                                                 assert_eq!(*node_id, $node_id);
3598                                                 (*msg).clone()
3599                                         },
3600                                         _ => panic!("Unexpected event"),
3601                                 }, match events[1] {
3602                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3603                                                 assert_eq!(*node_id, $node_id);
3604                                                 assert!(updates.update_add_htlcs.is_empty());
3605                                                 assert!(updates.update_fulfill_htlcs.is_empty());
3606                                                 assert!(updates.update_fail_htlcs.is_empty());
3607                                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
3608                                                 assert!(updates.update_fee.is_none());
3609                                                 updates.commitment_signed.clone()
3610                                         },
3611                                         _ => panic!("Unexpected event"),
3612                                 })
3613                         }
3614                 }
3615         }
3616
3617         macro_rules! get_event_msg {
3618                 ($node: expr, $event_type: path, $node_id: expr) => {
3619                         {
3620                                 let events = $node.node.get_and_clear_pending_msg_events();
3621                                 assert_eq!(events.len(), 1);
3622                                 match events[0] {
3623                                         $event_type { ref node_id, ref msg } => {
3624                                                 assert_eq!(*node_id, $node_id);
3625                                                 (*msg).clone()
3626                                         },
3627                                         _ => panic!("Unexpected event"),
3628                                 }
3629                         }
3630                 }
3631         }
3632
3633         macro_rules! get_htlc_update_msgs {
3634                 ($node: expr, $node_id: expr) => {
3635                         {
3636                                 let events = $node.node.get_and_clear_pending_msg_events();
3637                                 assert_eq!(events.len(), 1);
3638                                 match events[0] {
3639                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3640                                                 assert_eq!(*node_id, $node_id);
3641                                                 (*updates).clone()
3642                                         },
3643                                         _ => panic!("Unexpected event"),
3644                                 }
3645                         }
3646                 }
3647         }
3648
3649         macro_rules! get_feerate {
3650                 ($node: expr, $channel_id: expr) => {
3651                         {
3652                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3653                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
3654                                 chan.get_feerate()
3655                         }
3656                 }
3657         }
3658
3659
3660         fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
3661                 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
3662                 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();
3663                 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();
3664
3665                 let chan_id = *node_a.network_chan_count.borrow();
3666                 let tx;
3667                 let funding_output;
3668
3669                 let events_2 = node_a.node.get_and_clear_pending_events();
3670                 assert_eq!(events_2.len(), 1);
3671                 match events_2[0] {
3672                         Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
3673                                 assert_eq!(*channel_value_satoshis, channel_value);
3674                                 assert_eq!(user_channel_id, 42);
3675
3676                                 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
3677                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3678                                 }]};
3679                                 funding_output = OutPoint::new(tx.txid(), 0);
3680
3681                                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
3682                                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3683                                 assert_eq!(added_monitors.len(), 1);
3684                                 assert_eq!(added_monitors[0].0, funding_output);
3685                                 added_monitors.clear();
3686                         },
3687                         _ => panic!("Unexpected event"),
3688                 }
3689
3690                 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();
3691                 {
3692                         let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
3693                         assert_eq!(added_monitors.len(), 1);
3694                         assert_eq!(added_monitors[0].0, funding_output);
3695                         added_monitors.clear();
3696                 }
3697
3698                 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();
3699                 {
3700                         let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3701                         assert_eq!(added_monitors.len(), 1);
3702                         assert_eq!(added_monitors[0].0, funding_output);
3703                         added_monitors.clear();
3704                 }
3705
3706                 let events_4 = node_a.node.get_and_clear_pending_events();
3707                 assert_eq!(events_4.len(), 1);
3708                 match events_4[0] {
3709                         Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
3710                                 assert_eq!(user_channel_id, 42);
3711                                 assert_eq!(*funding_txo, funding_output);
3712                         },
3713                         _ => panic!("Unexpected event"),
3714                 };
3715
3716                 tx
3717         }
3718
3719         fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
3720                 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
3721                 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();
3722
3723                 let channel_id;
3724
3725                 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
3726                 let events_6 = node_a.node.get_and_clear_pending_msg_events();
3727                 assert_eq!(events_6.len(), 2);
3728                 ((match events_6[0] {
3729                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3730                                 channel_id = msg.channel_id.clone();
3731                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3732                                 msg.clone()
3733                         },
3734                         _ => panic!("Unexpected event"),
3735                 }, match events_6[1] {
3736                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3737                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3738                                 msg.clone()
3739                         },
3740                         _ => panic!("Unexpected event"),
3741                 }), channel_id)
3742         }
3743
3744         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) {
3745                 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
3746                 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
3747                 (msgs, chan_id, tx)
3748         }
3749
3750         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) {
3751                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap();
3752                 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
3753                 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
3754
3755                 let events_7 = node_b.node.get_and_clear_pending_msg_events();
3756                 assert_eq!(events_7.len(), 1);
3757                 let (announcement, bs_update) = match events_7[0] {
3758                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3759                                 (msg, update_msg)
3760                         },
3761                         _ => panic!("Unexpected event"),
3762                 };
3763
3764                 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
3765                 let events_8 = node_a.node.get_and_clear_pending_msg_events();
3766                 assert_eq!(events_8.len(), 1);
3767                 let as_update = match events_8[0] {
3768                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3769                                 assert!(*announcement == *msg);
3770                                 update_msg
3771                         },
3772                         _ => panic!("Unexpected event"),
3773                 };
3774
3775                 *node_a.network_chan_count.borrow_mut() += 1;
3776
3777                 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
3778         }
3779
3780         fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3781                 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
3782         }
3783
3784         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) {
3785                 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
3786                 for node in nodes {
3787                         assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
3788                         node.router.handle_channel_update(&chan_announcement.1).unwrap();
3789                         node.router.handle_channel_update(&chan_announcement.2).unwrap();
3790                 }
3791                 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
3792         }
3793
3794         macro_rules! check_spends {
3795                 ($tx: expr, $spends_tx: expr) => {
3796                         {
3797                                 let mut funding_tx_map = HashMap::new();
3798                                 let spends_tx = $spends_tx;
3799                                 funding_tx_map.insert(spends_tx.txid(), spends_tx);
3800                                 $tx.verify(&funding_tx_map).unwrap();
3801                         }
3802                 }
3803         }
3804
3805         macro_rules! get_closing_signed_broadcast {
3806                 ($node: expr, $dest_pubkey: expr) => {
3807                         {
3808                                 let events = $node.get_and_clear_pending_msg_events();
3809                                 assert!(events.len() == 1 || events.len() == 2);
3810                                 (match events[events.len() - 1] {
3811                                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3812                                                 assert_eq!(msg.contents.flags & 2, 2);
3813                                                 msg.clone()
3814                                         },
3815                                         _ => panic!("Unexpected event"),
3816                                 }, if events.len() == 2 {
3817                                         match events[0] {
3818                                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3819                                                         assert_eq!(*node_id, $dest_pubkey);
3820                                                         Some(msg.clone())
3821                                                 },
3822                                                 _ => panic!("Unexpected event"),
3823                                         }
3824                                 } else { None })
3825                         }
3826                 }
3827         }
3828
3829         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) {
3830                 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) };
3831                 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
3832                 let (tx_a, tx_b);
3833
3834                 node_a.close_channel(channel_id).unwrap();
3835                 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
3836
3837                 let events_1 = node_b.get_and_clear_pending_msg_events();
3838                 assert!(events_1.len() >= 1);
3839                 let shutdown_b = match events_1[0] {
3840                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
3841                                 assert_eq!(node_id, &node_a.get_our_node_id());
3842                                 msg.clone()
3843                         },
3844                         _ => panic!("Unexpected event"),
3845                 };
3846
3847                 let closing_signed_b = if !close_inbound_first {
3848                         assert_eq!(events_1.len(), 1);
3849                         None
3850                 } else {
3851                         Some(match events_1[1] {
3852                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3853                                         assert_eq!(node_id, &node_a.get_our_node_id());
3854                                         msg.clone()
3855                                 },
3856                                 _ => panic!("Unexpected event"),
3857                         })
3858                 };
3859
3860                 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
3861                 let (as_update, bs_update) = if close_inbound_first {
3862                         assert!(node_a.get_and_clear_pending_msg_events().is_empty());
3863                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3864                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3865                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3866                         let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3867
3868                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
3869                         let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3870                         assert!(none_b.is_none());
3871                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3872                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3873                         (as_update, bs_update)
3874                 } else {
3875                         let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
3876
3877                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
3878                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3879                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3880                         let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3881
3882                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3883                         let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3884                         assert!(none_a.is_none());
3885                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3886                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3887                         (as_update, bs_update)
3888                 };
3889                 assert_eq!(tx_a, tx_b);
3890                 check_spends!(tx_a, funding_tx);
3891
3892                 (as_update, bs_update, tx_a)
3893         }
3894
3895         struct SendEvent {
3896                 node_id: PublicKey,
3897                 msgs: Vec<msgs::UpdateAddHTLC>,
3898                 commitment_msg: msgs::CommitmentSigned,
3899         }
3900         impl SendEvent {
3901                 fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
3902                         assert!(updates.update_fulfill_htlcs.is_empty());
3903                         assert!(updates.update_fail_htlcs.is_empty());
3904                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3905                         assert!(updates.update_fee.is_none());
3906                         SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
3907                 }
3908
3909                 fn from_event(event: MessageSendEvent) -> SendEvent {
3910                         match event {
3911                                 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
3912                                 _ => panic!("Unexpected event type!"),
3913                         }
3914                 }
3915
3916                 fn from_node(node: &Node) -> SendEvent {
3917                         let mut events = node.node.get_and_clear_pending_msg_events();
3918                         assert_eq!(events.len(), 1);
3919                         SendEvent::from_event(events.pop().unwrap())
3920                 }
3921         }
3922
3923         macro_rules! check_added_monitors {
3924                 ($node: expr, $count: expr) => {
3925                         {
3926                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3927                                 assert_eq!(added_monitors.len(), $count);
3928                                 added_monitors.clear();
3929                         }
3930                 }
3931         }
3932
3933         macro_rules! commitment_signed_dance {
3934                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
3935                         {
3936                                 check_added_monitors!($node_a, 0);
3937                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3938                                 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3939                                 check_added_monitors!($node_a, 1);
3940                                 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
3941                         }
3942                 };
3943                 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
3944                         {
3945                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
3946                                 check_added_monitors!($node_b, 0);
3947                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3948                                 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3949                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3950                                 check_added_monitors!($node_b, 1);
3951                                 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
3952                                 let (bs_revoke_and_ack, extra_msg_option) = {
3953                                         let events = $node_b.node.get_and_clear_pending_msg_events();
3954                                         assert!(events.len() <= 2);
3955                                         (match events[0] {
3956                                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3957                                                         assert_eq!(*node_id, $node_a.node.get_our_node_id());
3958                                                         (*msg).clone()
3959                                                 },
3960                                                 _ => panic!("Unexpected event"),
3961                                         }, events.get(1).map(|e| e.clone()))
3962                                 };
3963                                 check_added_monitors!($node_b, 1);
3964                                 if $fail_backwards {
3965                                         assert!($node_a.node.get_and_clear_pending_events().is_empty());
3966                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3967                                 }
3968                                 (extra_msg_option, bs_revoke_and_ack)
3969                         }
3970                 };
3971                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
3972                         {
3973                                 check_added_monitors!($node_a, 0);
3974                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3975                                 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3976                                 check_added_monitors!($node_a, 1);
3977                                 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
3978                                 assert!(extra_msg_option.is_none());
3979                                 bs_revoke_and_ack
3980                         }
3981                 };
3982                 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
3983                         {
3984                                 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
3985                                 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3986                                 {
3987                                         let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
3988                                         if $fail_backwards {
3989                                                 assert_eq!(added_monitors.len(), 2);
3990                                                 assert!(added_monitors[0].0 != added_monitors[1].0);
3991                                         } else {
3992                                                 assert_eq!(added_monitors.len(), 1);
3993                                         }
3994                                         added_monitors.clear();
3995                                 }
3996                                 extra_msg_option
3997                         }
3998                 };
3999                 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
4000                         {
4001                                 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
4002                         }
4003                 };
4004                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
4005                         {
4006                                 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
4007                                 if $fail_backwards {
4008                                         let channel_state = $node_a.node.channel_state.lock().unwrap();
4009                                         assert_eq!(channel_state.pending_msg_events.len(), 1);
4010                                         if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
4011                                                 assert_ne!(*node_id, $node_b.node.get_our_node_id());
4012                                         } else { panic!("Unexpected event"); }
4013                                 } else {
4014                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
4015                                 }
4016                         }
4017                 }
4018         }
4019
4020         macro_rules! get_payment_preimage_hash {
4021                 ($node: expr) => {
4022                         {
4023                                 let payment_preimage = [*$node.network_payment_count.borrow(); 32];
4024                                 *$node.network_payment_count.borrow_mut() += 1;
4025                                 let mut payment_hash = [0; 32];
4026                                 let mut sha = Sha256::new();
4027                                 sha.input(&payment_preimage[..]);
4028                                 sha.result(&mut payment_hash);
4029                                 (payment_preimage, payment_hash)
4030                         }
4031                 }
4032         }
4033
4034         fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
4035                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
4036
4037                 let mut payment_event = {
4038                         origin_node.node.send_payment(route, our_payment_hash).unwrap();
4039                         check_added_monitors!(origin_node, 1);
4040
4041                         let mut events = origin_node.node.get_and_clear_pending_msg_events();
4042                         assert_eq!(events.len(), 1);
4043                         SendEvent::from_event(events.remove(0))
4044                 };
4045                 let mut prev_node = origin_node;
4046
4047                 for (idx, &node) in expected_route.iter().enumerate() {
4048                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
4049
4050                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4051                         check_added_monitors!(node, 0);
4052                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
4053
4054                         let events_1 = node.node.get_and_clear_pending_events();
4055                         assert_eq!(events_1.len(), 1);
4056                         match events_1[0] {
4057                                 Event::PendingHTLCsForwardable { .. } => { },
4058                                 _ => panic!("Unexpected event"),
4059                         };
4060
4061                         node.node.channel_state.lock().unwrap().next_forward = Instant::now();
4062                         node.node.process_pending_htlc_forwards();
4063
4064                         if idx == expected_route.len() - 1 {
4065                                 let events_2 = node.node.get_and_clear_pending_events();
4066                                 assert_eq!(events_2.len(), 1);
4067                                 match events_2[0] {
4068                                         Event::PaymentReceived { ref payment_hash, amt } => {
4069                                                 assert_eq!(our_payment_hash, *payment_hash);
4070                                                 assert_eq!(amt, recv_value);
4071                                         },
4072                                         _ => panic!("Unexpected event"),
4073                                 }
4074                         } else {
4075                                 let mut events_2 = node.node.get_and_clear_pending_msg_events();
4076                                 assert_eq!(events_2.len(), 1);
4077                                 check_added_monitors!(node, 1);
4078                                 payment_event = SendEvent::from_event(events_2.remove(0));
4079                                 assert_eq!(payment_event.msgs.len(), 1);
4080                         }
4081
4082                         prev_node = node;
4083                 }
4084
4085                 (our_payment_preimage, our_payment_hash)
4086         }
4087
4088         fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: [u8; 32]) {
4089                 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
4090                 check_added_monitors!(expected_route.last().unwrap(), 1);
4091
4092                 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
4093                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
4094                 macro_rules! get_next_msgs {
4095                         ($node: expr) => {
4096                                 {
4097                                         let events = $node.node.get_and_clear_pending_msg_events();
4098                                         assert_eq!(events.len(), 1);
4099                                         match events[0] {
4100                                                 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 } } => {
4101                                                         assert!(update_add_htlcs.is_empty());
4102                                                         assert_eq!(update_fulfill_htlcs.len(), 1);
4103                                                         assert!(update_fail_htlcs.is_empty());
4104                                                         assert!(update_fail_malformed_htlcs.is_empty());
4105                                                         assert!(update_fee.is_none());
4106                                                         expected_next_node = node_id.clone();
4107                                                         Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
4108                                                 },
4109                                                 _ => panic!("Unexpected event"),
4110                                         }
4111                                 }
4112                         }
4113                 }
4114
4115                 macro_rules! last_update_fulfill_dance {
4116                         ($node: expr, $prev_node: expr) => {
4117                                 {
4118                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
4119                                         check_added_monitors!($node, 0);
4120                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
4121                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
4122                                 }
4123                         }
4124                 }
4125                 macro_rules! mid_update_fulfill_dance {
4126                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
4127                                 {
4128                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
4129                                         check_added_monitors!($node, 1);
4130                                         let new_next_msgs = if $new_msgs {
4131                                                 get_next_msgs!($node)
4132                                         } else {
4133                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
4134                                                 None
4135                                         };
4136                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
4137                                         next_msgs = new_next_msgs;
4138                                 }
4139                         }
4140                 }
4141
4142                 let mut prev_node = expected_route.last().unwrap();
4143                 for (idx, node) in expected_route.iter().rev().enumerate() {
4144                         assert_eq!(expected_next_node, node.node.get_our_node_id());
4145                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
4146                         if next_msgs.is_some() {
4147                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
4148                         } else if update_next_msgs {
4149                                 next_msgs = get_next_msgs!(node);
4150                         } else {
4151                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
4152                         }
4153                         if !skip_last && idx == expected_route.len() - 1 {
4154                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
4155                         }
4156
4157                         prev_node = node;
4158                 }
4159
4160                 if !skip_last {
4161                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
4162                         let events = origin_node.node.get_and_clear_pending_events();
4163                         assert_eq!(events.len(), 1);
4164                         match events[0] {
4165                                 Event::PaymentSent { payment_preimage } => {
4166                                         assert_eq!(payment_preimage, our_payment_preimage);
4167                                 },
4168                                 _ => panic!("Unexpected event"),
4169                         }
4170                 }
4171         }
4172
4173         fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
4174                 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
4175         }
4176
4177         const TEST_FINAL_CLTV: u32 = 32;
4178
4179         fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
4180                 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();
4181                 assert_eq!(route.hops.len(), expected_route.len());
4182                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
4183                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
4184                 }
4185
4186                 send_along_route(origin_node, route, expected_route, recv_value)
4187         }
4188
4189         fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
4190                 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();
4191                 assert_eq!(route.hops.len(), expected_route.len());
4192                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
4193                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
4194                 }
4195
4196                 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
4197
4198                 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
4199                 match err {
4200                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
4201                         _ => panic!("Unknown error variants"),
4202                 };
4203         }
4204
4205         fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
4206                 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
4207                 claim_payment(&origin, expected_route, our_payment_preimage);
4208         }
4209
4210         fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: [u8; 32]) {
4211                 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, PaymentFailReason::PreimageUnknown));
4212                 check_added_monitors!(expected_route.last().unwrap(), 1);
4213
4214                 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
4215                 macro_rules! update_fail_dance {
4216                         ($node: expr, $prev_node: expr, $last_node: expr) => {
4217                                 {
4218                                         $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
4219                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
4220                                 }
4221                         }
4222                 }
4223
4224                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
4225                 let mut prev_node = expected_route.last().unwrap();
4226                 for (idx, node) in expected_route.iter().rev().enumerate() {
4227                         assert_eq!(expected_next_node, node.node.get_our_node_id());
4228                         if next_msgs.is_some() {
4229                                 // We may be the "last node" for the purpose of the commitment dance if we're
4230                                 // skipping the last node (implying it is disconnected) and we're the
4231                                 // second-to-last node!
4232                                 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
4233                         }
4234
4235                         let events = node.node.get_and_clear_pending_msg_events();
4236                         if !skip_last || idx != expected_route.len() - 1 {
4237                                 assert_eq!(events.len(), 1);
4238                                 match events[0] {
4239                                         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 } } => {
4240                                                 assert!(update_add_htlcs.is_empty());
4241                                                 assert!(update_fulfill_htlcs.is_empty());
4242                                                 assert_eq!(update_fail_htlcs.len(), 1);
4243                                                 assert!(update_fail_malformed_htlcs.is_empty());
4244                                                 assert!(update_fee.is_none());
4245                                                 expected_next_node = node_id.clone();
4246                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
4247                                         },
4248                                         _ => panic!("Unexpected event"),
4249                                 }
4250                         } else {
4251                                 assert!(events.is_empty());
4252                         }
4253                         if !skip_last && idx == expected_route.len() - 1 {
4254                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
4255                         }
4256
4257                         prev_node = node;
4258                 }
4259
4260                 if !skip_last {
4261                         update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
4262
4263                         let events = origin_node.node.get_and_clear_pending_events();
4264                         assert_eq!(events.len(), 1);
4265                         match events[0] {
4266                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
4267                                         assert_eq!(payment_hash, our_payment_hash);
4268                                         assert!(rejected_by_dest);
4269                                 },
4270                                 _ => panic!("Unexpected event"),
4271                         }
4272                 }
4273         }
4274
4275         fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
4276                 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
4277         }
4278
4279         fn create_network(node_count: usize) -> Vec<Node> {
4280                 let mut nodes = Vec::new();
4281                 let mut rng = thread_rng();
4282                 let secp_ctx = Secp256k1::new();
4283                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4284
4285                 let chan_count = Rc::new(RefCell::new(0));
4286                 let payment_count = Rc::new(RefCell::new(0));
4287
4288                 for _ in 0..node_count {
4289                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
4290                         let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
4291                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
4292                         let mut seed = [0; 32];
4293                         rng.fill_bytes(&mut seed);
4294                         let keys_manager = Arc::new(keysinterface::KeysManager::new(&seed, Network::Testnet, Arc::clone(&logger)));
4295                         let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone()));
4296                         let mut config = UserConfig::new();
4297                         config.channel_options.announced_channel = true;
4298                         config.channel_limits.force_announced_channel_preference = false;
4299                         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();
4300                         let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
4301                         nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, node_seed: seed,
4302                                 network_payment_count: payment_count.clone(),
4303                                 network_chan_count: chan_count.clone(),
4304                         });
4305                 }
4306
4307                 nodes
4308         }
4309
4310         #[test]
4311         fn test_async_inbound_update_fee() {
4312                 let mut nodes = create_network(2);
4313                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4314                 let channel_id = chan.2;
4315
4316                 // balancing
4317                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4318
4319                 // A                                        B
4320                 // update_fee                            ->
4321                 // send (1) commitment_signed            -.
4322                 //                                       <- update_add_htlc/commitment_signed
4323                 // send (2) RAA (awaiting remote revoke) -.
4324                 // (1) commitment_signed is delivered    ->
4325                 //                                       .- send (3) RAA (awaiting remote revoke)
4326                 // (2) RAA is delivered                  ->
4327                 //                                       .- send (4) commitment_signed
4328                 //                                       <- (3) RAA is delivered
4329                 // send (5) commitment_signed            -.
4330                 //                                       <- (4) commitment_signed is delivered
4331                 // send (6) RAA                          -.
4332                 // (5) commitment_signed is delivered    ->
4333                 //                                       <- RAA
4334                 // (6) RAA is delivered                  ->
4335
4336                 // First nodes[0] generates an update_fee
4337                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
4338                 check_added_monitors!(nodes[0], 1);
4339
4340                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4341                 assert_eq!(events_0.len(), 1);
4342                 let (update_msg, commitment_signed) = match events_0[0] { // (1)
4343                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4344                                 (update_fee.as_ref(), commitment_signed)
4345                         },
4346                         _ => panic!("Unexpected event"),
4347                 };
4348
4349                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4350
4351                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4352                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4353                 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();
4354                 check_added_monitors!(nodes[1], 1);
4355
4356                 let payment_event = {
4357                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4358                         assert_eq!(events_1.len(), 1);
4359                         SendEvent::from_event(events_1.remove(0))
4360                 };
4361                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4362                 assert_eq!(payment_event.msgs.len(), 1);
4363
4364                 // ...now when the messages get delivered everyone should be happy
4365                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4366                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4367                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4368                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4369                 check_added_monitors!(nodes[0], 1);
4370
4371                 // deliver(1), generate (3):
4372                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4373                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4374                 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
4375                 check_added_monitors!(nodes[1], 1);
4376
4377                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
4378                 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4379                 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
4380                 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
4381                 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
4382                 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
4383                 assert!(bs_update.update_fee.is_none()); // (4)
4384                 check_added_monitors!(nodes[1], 1);
4385
4386                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
4387                 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4388                 assert!(as_update.update_add_htlcs.is_empty()); // (5)
4389                 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
4390                 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
4391                 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
4392                 assert!(as_update.update_fee.is_none()); // (5)
4393                 check_added_monitors!(nodes[0], 1);
4394
4395                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
4396                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4397                 // only (6) so get_event_msg's assert(len == 1) passes
4398                 check_added_monitors!(nodes[0], 1);
4399
4400                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
4401                 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4402                 check_added_monitors!(nodes[1], 1);
4403
4404                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4405                 check_added_monitors!(nodes[0], 1);
4406
4407                 let events_2 = nodes[0].node.get_and_clear_pending_events();
4408                 assert_eq!(events_2.len(), 1);
4409                 match events_2[0] {
4410                         Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
4411                         _ => panic!("Unexpected event"),
4412                 }
4413
4414                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
4415                 check_added_monitors!(nodes[1], 1);
4416         }
4417
4418         #[test]
4419         fn test_update_fee_unordered_raa() {
4420                 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
4421                 // crash in an earlier version of the update_fee patch)
4422                 let mut nodes = create_network(2);
4423                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4424                 let channel_id = chan.2;
4425
4426                 // balancing
4427                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4428
4429                 // First nodes[0] generates an update_fee
4430                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
4431                 check_added_monitors!(nodes[0], 1);
4432
4433                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4434                 assert_eq!(events_0.len(), 1);
4435                 let update_msg = match events_0[0] { // (1)
4436                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
4437                                 update_fee.as_ref()
4438                         },
4439                         _ => panic!("Unexpected event"),
4440                 };
4441
4442                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4443
4444                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4445                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4446                 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();
4447                 check_added_monitors!(nodes[1], 1);
4448
4449                 let payment_event = {
4450                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4451                         assert_eq!(events_1.len(), 1);
4452                         SendEvent::from_event(events_1.remove(0))
4453                 };
4454                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4455                 assert_eq!(payment_event.msgs.len(), 1);
4456
4457                 // ...now when the messages get delivered everyone should be happy
4458                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4459                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4460                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4461                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4462                 check_added_monitors!(nodes[0], 1);
4463
4464                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
4465                 check_added_monitors!(nodes[1], 1);
4466
4467                 // We can't continue, sadly, because our (1) now has a bogus signature
4468         }
4469
4470         #[test]
4471         fn test_multi_flight_update_fee() {
4472                 let nodes = create_network(2);
4473                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4474                 let channel_id = chan.2;
4475
4476                 // A                                        B
4477                 // update_fee/commitment_signed          ->
4478                 //                                       .- send (1) RAA and (2) commitment_signed
4479                 // update_fee (never committed)          ->
4480                 // (3) update_fee                        ->
4481                 // We have to manually generate the above update_fee, it is allowed by the protocol but we
4482                 // don't track which updates correspond to which revoke_and_ack responses so we're in
4483                 // AwaitingRAA mode and will not generate the update_fee yet.
4484                 //                                       <- (1) RAA delivered
4485                 // (3) is generated and send (4) CS      -.
4486                 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
4487                 // know the per_commitment_point to use for it.
4488                 //                                       <- (2) commitment_signed delivered
4489                 // revoke_and_ack                        ->
4490                 //                                          B should send no response here
4491                 // (4) commitment_signed delivered       ->
4492                 //                                       <- RAA/commitment_signed delivered
4493                 // revoke_and_ack                        ->
4494
4495                 // First nodes[0] generates an update_fee
4496                 let initial_feerate = get_feerate!(nodes[0], channel_id);
4497                 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
4498                 check_added_monitors!(nodes[0], 1);
4499
4500                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4501                 assert_eq!(events_0.len(), 1);
4502                 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
4503                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4504                                 (update_fee.as_ref().unwrap(), commitment_signed)
4505                         },
4506                         _ => panic!("Unexpected event"),
4507                 };
4508
4509                 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
4510                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
4511                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
4512                 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4513                 check_added_monitors!(nodes[1], 1);
4514
4515                 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
4516                 // transaction:
4517                 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
4518                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4519                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4520
4521                 // Create the (3) update_fee message that nodes[0] will generate before it does...
4522                 let mut update_msg_2 = msgs::UpdateFee {
4523                         channel_id: update_msg_1.channel_id.clone(),
4524                         feerate_per_kw: (initial_feerate + 30) as u32,
4525                 };
4526
4527                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4528
4529                 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
4530                 // Deliver (3)
4531                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4532
4533                 // Deliver (1), generating (3) and (4)
4534                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
4535                 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4536                 check_added_monitors!(nodes[0], 1);
4537                 assert!(as_second_update.update_add_htlcs.is_empty());
4538                 assert!(as_second_update.update_fulfill_htlcs.is_empty());
4539                 assert!(as_second_update.update_fail_htlcs.is_empty());
4540                 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
4541                 // Check that the update_fee newly generated matches what we delivered:
4542                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
4543                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
4544
4545                 // Deliver (2) commitment_signed
4546                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
4547                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4548                 check_added_monitors!(nodes[0], 1);
4549                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4550
4551                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
4552                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4553                 check_added_monitors!(nodes[1], 1);
4554
4555                 // Delever (4)
4556                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
4557                 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4558                 check_added_monitors!(nodes[1], 1);
4559
4560                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4561                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4562                 check_added_monitors!(nodes[0], 1);
4563
4564                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
4565                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4566                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4567                 check_added_monitors!(nodes[0], 1);
4568
4569                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
4570                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4571                 check_added_monitors!(nodes[1], 1);
4572         }
4573
4574         #[test]
4575         fn test_update_fee_vanilla() {
4576                 let nodes = create_network(2);
4577                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4578                 let channel_id = chan.2;
4579
4580                 let feerate = get_feerate!(nodes[0], channel_id);
4581                 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
4582                 check_added_monitors!(nodes[0], 1);
4583
4584                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4585                 assert_eq!(events_0.len(), 1);
4586                 let (update_msg, commitment_signed) = match events_0[0] {
4587                                 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 } } => {
4588                                 (update_fee.as_ref(), commitment_signed)
4589                         },
4590                         _ => panic!("Unexpected event"),
4591                 };
4592                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4593
4594                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4595                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4596                 check_added_monitors!(nodes[1], 1);
4597
4598                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4599                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4600                 check_added_monitors!(nodes[0], 1);
4601
4602                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4603                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4604                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4605                 check_added_monitors!(nodes[0], 1);
4606
4607                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4608                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4609                 check_added_monitors!(nodes[1], 1);
4610         }
4611
4612         #[test]
4613         fn test_update_fee_that_funder_cannot_afford() {
4614                 let nodes = create_network(2);
4615                 let channel_value = 1888;
4616                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000);
4617                 let channel_id = chan.2;
4618
4619                 let feerate = 260;
4620                 nodes[0].node.update_fee(channel_id, feerate).unwrap();
4621                 check_added_monitors!(nodes[0], 1);
4622                 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4623
4624                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
4625
4626                 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
4627
4628                 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
4629                 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
4630                 {
4631                         let chan_lock = nodes[1].node.channel_state.lock().unwrap();
4632                         let chan = chan_lock.by_id.get(&channel_id).unwrap();
4633
4634                         //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
4635                         let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
4636                         let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
4637                         let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
4638                         actual_fee = channel_value - actual_fee;
4639                         assert_eq!(total_fee, actual_fee);
4640                 } //drop the mutex
4641
4642                 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
4643                 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
4644                 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
4645                 check_added_monitors!(nodes[0], 1);
4646
4647                 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4648
4649                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap()).unwrap();
4650
4651                 //While producing the commitment_signed response after handling a received update_fee request the
4652                 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
4653                 //Should produce and error.
4654                 let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
4655
4656                 assert!(match err.err {
4657                         "Funding remote cannot afford proposed new fee" => true,
4658                         _ => false,
4659                 });
4660
4661                 //clear the message we could not handle
4662                 nodes[1].node.get_and_clear_pending_msg_events();
4663         }
4664
4665         #[test]
4666         fn test_update_fee_with_fundee_update_add_htlc() {
4667                 let mut nodes = create_network(2);
4668                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4669                 let channel_id = chan.2;
4670
4671                 // balancing
4672                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4673
4674                 let feerate = get_feerate!(nodes[0], channel_id);
4675                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4676                 check_added_monitors!(nodes[0], 1);
4677
4678                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4679                 assert_eq!(events_0.len(), 1);
4680                 let (update_msg, commitment_signed) = match events_0[0] {
4681                                 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 } } => {
4682                                 (update_fee.as_ref(), commitment_signed)
4683                         },
4684                         _ => panic!("Unexpected event"),
4685                 };
4686                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4687                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4688                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4689                 check_added_monitors!(nodes[1], 1);
4690
4691                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
4692
4693                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
4694
4695                 // nothing happens since node[1] is in AwaitingRemoteRevoke
4696                 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
4697                 {
4698                         let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
4699                         assert_eq!(added_monitors.len(), 0);
4700                         added_monitors.clear();
4701                 }
4702                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4703                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4704                 // node[1] has nothing to do
4705
4706                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4707                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4708                 check_added_monitors!(nodes[0], 1);
4709
4710                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4711                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4712                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4713                 check_added_monitors!(nodes[0], 1);
4714                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4715                 check_added_monitors!(nodes[1], 1);
4716                 // AwaitingRemoteRevoke ends here
4717
4718                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4719                 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
4720                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
4721                 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
4722                 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
4723                 assert_eq!(commitment_update.update_fee.is_none(), true);
4724
4725                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
4726                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4727                 check_added_monitors!(nodes[0], 1);
4728                 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4729
4730                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
4731                 check_added_monitors!(nodes[1], 1);
4732                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4733
4734                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
4735                 check_added_monitors!(nodes[1], 1);
4736                 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4737                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4738
4739                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
4740                 check_added_monitors!(nodes[0], 1);
4741                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4742
4743                 let events = nodes[0].node.get_and_clear_pending_events();
4744                 assert_eq!(events.len(), 1);
4745                 match events[0] {
4746                         Event::PendingHTLCsForwardable { .. } => { },
4747                         _ => panic!("Unexpected event"),
4748                 };
4749                 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
4750                 nodes[0].node.process_pending_htlc_forwards();
4751
4752                 let events = nodes[0].node.get_and_clear_pending_events();
4753                 assert_eq!(events.len(), 1);
4754                 match events[0] {
4755                         Event::PaymentReceived { .. } => { },
4756                         _ => panic!("Unexpected event"),
4757                 };
4758
4759                 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
4760
4761                 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
4762                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
4763                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4764         }
4765
4766         #[test]
4767         fn test_update_fee() {
4768                 let nodes = create_network(2);
4769                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4770                 let channel_id = chan.2;
4771
4772                 // A                                        B
4773                 // (1) update_fee/commitment_signed      ->
4774                 //                                       <- (2) revoke_and_ack
4775                 //                                       .- send (3) commitment_signed
4776                 // (4) update_fee/commitment_signed      ->
4777                 //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
4778                 //                                       <- (3) commitment_signed delivered
4779                 // send (6) revoke_and_ack               -.
4780                 //                                       <- (5) deliver revoke_and_ack
4781                 // (6) deliver revoke_and_ack            ->
4782                 //                                       .- send (7) commitment_signed in response to (4)
4783                 //                                       <- (7) deliver commitment_signed
4784                 // revoke_and_ack                        ->
4785
4786                 // Create and deliver (1)...
4787                 let feerate = get_feerate!(nodes[0], channel_id);
4788                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4789                 check_added_monitors!(nodes[0], 1);
4790
4791                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4792                 assert_eq!(events_0.len(), 1);
4793                 let (update_msg, commitment_signed) = match events_0[0] {
4794                                 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 } } => {
4795                                 (update_fee.as_ref(), commitment_signed)
4796                         },
4797                         _ => panic!("Unexpected event"),
4798                 };
4799                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4800
4801                 // Generate (2) and (3):
4802                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4803                 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4804                 check_added_monitors!(nodes[1], 1);
4805
4806                 // Deliver (2):
4807                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4808                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4809                 check_added_monitors!(nodes[0], 1);
4810
4811                 // Create and deliver (4)...
4812                 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
4813                 check_added_monitors!(nodes[0], 1);
4814                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4815                 assert_eq!(events_0.len(), 1);
4816                 let (update_msg, commitment_signed) = match events_0[0] {
4817                                 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 } } => {
4818                                 (update_fee.as_ref(), commitment_signed)
4819                         },
4820                         _ => panic!("Unexpected event"),
4821                 };
4822
4823                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4824                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4825                 check_added_monitors!(nodes[1], 1);
4826                 // ... creating (5)
4827                 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4828                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4829
4830                 // Handle (3), creating (6):
4831                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
4832                 check_added_monitors!(nodes[0], 1);
4833                 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4834                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4835
4836                 // Deliver (5):
4837                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4838                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4839                 check_added_monitors!(nodes[0], 1);
4840
4841                 // Deliver (6), creating (7):
4842                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
4843                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4844                 assert!(commitment_update.update_add_htlcs.is_empty());
4845                 assert!(commitment_update.update_fulfill_htlcs.is_empty());
4846                 assert!(commitment_update.update_fail_htlcs.is_empty());
4847                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4848                 assert!(commitment_update.update_fee.is_none());
4849                 check_added_monitors!(nodes[1], 1);
4850
4851                 // Deliver (7)
4852                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4853                 check_added_monitors!(nodes[0], 1);
4854                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4855                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4856
4857                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4858                 check_added_monitors!(nodes[1], 1);
4859                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4860
4861                 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
4862                 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
4863                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4864         }
4865
4866         #[test]
4867         fn pre_funding_lock_shutdown_test() {
4868                 // Test sending a shutdown prior to funding_locked after funding generation
4869                 let nodes = create_network(2);
4870                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
4871                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4872                 nodes[0].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
4873                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
4874
4875                 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
4876                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4877                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4878                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4879                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4880
4881                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4882                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4883                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4884                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4885                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4886                 assert!(node_0_none.is_none());
4887
4888                 assert!(nodes[0].node.list_channels().is_empty());
4889                 assert!(nodes[1].node.list_channels().is_empty());
4890         }
4891
4892         #[test]
4893         fn updates_shutdown_wait() {
4894                 // Test sending a shutdown with outstanding updates pending
4895                 let mut nodes = create_network(3);
4896                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4897                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4898                 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4899                 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4900
4901                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
4902
4903                 nodes[0].node.close_channel(&chan_1.2).unwrap();
4904                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4905                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4906                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4907                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4908
4909                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4910                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4911
4912                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4913                 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
4914                 else { panic!("New sends should fail!") };
4915                 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
4916                 else { panic!("New sends should fail!") };
4917
4918                 assert!(nodes[2].node.claim_funds(our_payment_preimage));
4919                 check_added_monitors!(nodes[2], 1);
4920                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4921                 assert!(updates.update_add_htlcs.is_empty());
4922                 assert!(updates.update_fail_htlcs.is_empty());
4923                 assert!(updates.update_fail_malformed_htlcs.is_empty());
4924                 assert!(updates.update_fee.is_none());
4925                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4926                 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4927                 check_added_monitors!(nodes[1], 1);
4928                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4929                 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4930
4931                 assert!(updates_2.update_add_htlcs.is_empty());
4932                 assert!(updates_2.update_fail_htlcs.is_empty());
4933                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4934                 assert!(updates_2.update_fee.is_none());
4935                 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
4936                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
4937                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
4938
4939                 let events = nodes[0].node.get_and_clear_pending_events();
4940                 assert_eq!(events.len(), 1);
4941                 match events[0] {
4942                         Event::PaymentSent { ref payment_preimage } => {
4943                                 assert_eq!(our_payment_preimage, *payment_preimage);
4944                         },
4945                         _ => panic!("Unexpected event"),
4946                 }
4947
4948                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4949                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4950                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4951                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4952                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4953                 assert!(node_0_none.is_none());
4954
4955                 assert!(nodes[0].node.list_channels().is_empty());
4956
4957                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4958                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
4959                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
4960                 assert!(nodes[1].node.list_channels().is_empty());
4961                 assert!(nodes[2].node.list_channels().is_empty());
4962         }
4963
4964         #[test]
4965         fn htlc_fail_async_shutdown() {
4966                 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
4967                 let mut nodes = create_network(3);
4968                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4969                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4970
4971                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4972                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4973                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4974                 check_added_monitors!(nodes[0], 1);
4975                 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4976                 assert_eq!(updates.update_add_htlcs.len(), 1);
4977                 assert!(updates.update_fulfill_htlcs.is_empty());
4978                 assert!(updates.update_fail_htlcs.is_empty());
4979                 assert!(updates.update_fail_malformed_htlcs.is_empty());
4980                 assert!(updates.update_fee.is_none());
4981
4982                 nodes[1].node.close_channel(&chan_1.2).unwrap();
4983                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4984                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4985                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4986
4987                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
4988                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
4989                 check_added_monitors!(nodes[1], 1);
4990                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4991                 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
4992
4993                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4994                 assert!(updates_2.update_add_htlcs.is_empty());
4995                 assert!(updates_2.update_fulfill_htlcs.is_empty());
4996                 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
4997                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4998                 assert!(updates_2.update_fee.is_none());
4999
5000                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
5001                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
5002
5003                 let events = nodes[0].node.get_and_clear_pending_events();
5004                 assert_eq!(events.len(), 1);
5005                 match events[0] {
5006                         Event::PaymentFailed { ref payment_hash, ref rejected_by_dest } => {
5007                                 assert_eq!(our_payment_hash, *payment_hash);
5008                                 assert!(!rejected_by_dest);
5009                         },
5010                         _ => panic!("Unexpected event"),
5011                 }
5012
5013                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5014                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
5015                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
5016                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
5017                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
5018                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
5019                 assert!(node_0_none.is_none());
5020
5021                 assert!(nodes[0].node.list_channels().is_empty());
5022
5023                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
5024                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
5025                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
5026                 assert!(nodes[1].node.list_channels().is_empty());
5027                 assert!(nodes[2].node.list_channels().is_empty());
5028         }
5029
5030         fn do_test_shutdown_rebroadcast(recv_count: u8) {
5031                 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
5032                 // messages delivered prior to disconnect
5033                 let nodes = create_network(3);
5034                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5035                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5036
5037                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
5038
5039                 nodes[1].node.close_channel(&chan_1.2).unwrap();
5040                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
5041                 if recv_count > 0 {
5042                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
5043                         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
5044                         if recv_count > 1 {
5045                                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
5046                         }
5047                 }
5048
5049                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5050                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5051
5052                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5053                 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
5054                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5055                 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5056
5057                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
5058                 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
5059                 assert!(node_1_shutdown == node_1_2nd_shutdown);
5060
5061                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
5062                 let node_0_2nd_shutdown = if recv_count > 0 {
5063                         let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
5064                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
5065                         node_0_2nd_shutdown
5066                 } else {
5067                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5068                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
5069                         get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
5070                 };
5071                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
5072
5073                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5074                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5075
5076                 assert!(nodes[2].node.claim_funds(our_payment_preimage));
5077                 check_added_monitors!(nodes[2], 1);
5078                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5079                 assert!(updates.update_add_htlcs.is_empty());
5080                 assert!(updates.update_fail_htlcs.is_empty());
5081                 assert!(updates.update_fail_malformed_htlcs.is_empty());
5082                 assert!(updates.update_fee.is_none());
5083                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5084                 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
5085                 check_added_monitors!(nodes[1], 1);
5086                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5087                 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
5088
5089                 assert!(updates_2.update_add_htlcs.is_empty());
5090                 assert!(updates_2.update_fail_htlcs.is_empty());
5091                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
5092                 assert!(updates_2.update_fee.is_none());
5093                 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
5094                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
5095                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
5096
5097                 let events = nodes[0].node.get_and_clear_pending_events();
5098                 assert_eq!(events.len(), 1);
5099                 match events[0] {
5100                         Event::PaymentSent { ref payment_preimage } => {
5101                                 assert_eq!(our_payment_preimage, *payment_preimage);
5102                         },
5103                         _ => panic!("Unexpected event"),
5104                 }
5105
5106                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
5107                 if recv_count > 0 {
5108                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
5109                         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
5110                         assert!(node_1_closing_signed.is_some());
5111                 }
5112
5113                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5114                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5115
5116                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5117                 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
5118                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5119                 if recv_count == 0 {
5120                         // If all closing_signeds weren't delivered we can just resume where we left off...
5121                         let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5122
5123                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
5124                         let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
5125                         assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
5126
5127                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
5128                         let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
5129                         assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
5130
5131                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
5132                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5133
5134                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
5135                         let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
5136                         assert!(node_0_closing_signed == node_0_2nd_closing_signed);
5137
5138                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
5139                         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
5140                         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
5141                         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
5142                         assert!(node_0_none.is_none());
5143                 } else {
5144                         // If one node, however, received + responded with an identical closing_signed we end
5145                         // up erroring and node[0] will try to broadcast its own latest commitment transaction.
5146                         // There isn't really anything better we can do simply, but in the future we might
5147                         // explore storing a set of recently-closed channels that got disconnected during
5148                         // closing_signed and avoiding broadcasting local commitment txn for some timeout to
5149                         // give our counterparty enough time to (potentially) broadcast a cooperative closing
5150                         // transaction.
5151                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5152
5153                         if let Err(msgs::HandleError{action: Some(msgs::ErrorAction::SendErrorMessage{msg}), ..}) =
5154                                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
5155                                 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
5156                                 let msgs::ErrorMessage {ref channel_id, ..} = msg;
5157                                 assert_eq!(*channel_id, chan_1.2);
5158                         } else { panic!("Needed SendErrorMessage close"); }
5159
5160                         // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
5161                         // checks it, but in this case nodes[0] didn't ever get a chance to receive a
5162                         // closing_signed so we do it ourselves
5163                         let events = nodes[0].node.get_and_clear_pending_msg_events();
5164                         assert_eq!(events.len(), 1);
5165                         match events[0] {
5166                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5167                                         assert_eq!(msg.contents.flags & 2, 2);
5168                                 },
5169                                 _ => panic!("Unexpected event"),
5170                         }
5171                 }
5172
5173                 assert!(nodes[0].node.list_channels().is_empty());
5174
5175                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
5176                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
5177                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
5178                 assert!(nodes[1].node.list_channels().is_empty());
5179                 assert!(nodes[2].node.list_channels().is_empty());
5180         }
5181
5182         #[test]
5183         fn test_shutdown_rebroadcast() {
5184                 do_test_shutdown_rebroadcast(0);
5185                 do_test_shutdown_rebroadcast(1);
5186                 do_test_shutdown_rebroadcast(2);
5187         }
5188
5189         #[test]
5190         fn fake_network_test() {
5191                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5192                 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
5193                 let nodes = create_network(4);
5194
5195                 // Create some initial channels
5196                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5197                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5198                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5199
5200                 // Rebalance the network a bit by relaying one payment through all the channels...
5201                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5202                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5203                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5204                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5205
5206                 // Send some more payments
5207                 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
5208                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
5209                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
5210
5211                 // Test failure packets
5212                 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
5213                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
5214
5215                 // Add a new channel that skips 3
5216                 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
5217
5218                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
5219                 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
5220                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5221                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5222                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5223                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5224                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5225
5226                 // Do some rebalance loop payments, simultaneously
5227                 let mut hops = Vec::with_capacity(3);
5228                 hops.push(RouteHop {
5229                         pubkey: nodes[2].node.get_our_node_id(),
5230                         short_channel_id: chan_2.0.contents.short_channel_id,
5231                         fee_msat: 0,
5232                         cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
5233                 });
5234                 hops.push(RouteHop {
5235                         pubkey: nodes[3].node.get_our_node_id(),
5236                         short_channel_id: chan_3.0.contents.short_channel_id,
5237                         fee_msat: 0,
5238                         cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
5239                 });
5240                 hops.push(RouteHop {
5241                         pubkey: nodes[1].node.get_our_node_id(),
5242                         short_channel_id: chan_4.0.contents.short_channel_id,
5243                         fee_msat: 1000000,
5244                         cltv_expiry_delta: TEST_FINAL_CLTV,
5245                 });
5246                 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;
5247                 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;
5248                 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
5249
5250                 let mut hops = Vec::with_capacity(3);
5251                 hops.push(RouteHop {
5252                         pubkey: nodes[3].node.get_our_node_id(),
5253                         short_channel_id: chan_4.0.contents.short_channel_id,
5254                         fee_msat: 0,
5255                         cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
5256                 });
5257                 hops.push(RouteHop {
5258                         pubkey: nodes[2].node.get_our_node_id(),
5259                         short_channel_id: chan_3.0.contents.short_channel_id,
5260                         fee_msat: 0,
5261                         cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
5262                 });
5263                 hops.push(RouteHop {
5264                         pubkey: nodes[1].node.get_our_node_id(),
5265                         short_channel_id: chan_2.0.contents.short_channel_id,
5266                         fee_msat: 1000000,
5267                         cltv_expiry_delta: TEST_FINAL_CLTV,
5268                 });
5269                 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;
5270                 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;
5271                 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
5272
5273                 // Claim the rebalances...
5274                 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
5275                 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
5276
5277                 // Add a duplicate new channel from 2 to 4
5278                 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
5279
5280                 // Send some payments across both channels
5281                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5282                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5283                 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5284
5285                 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
5286
5287                 //TODO: Test that routes work again here as we've been notified that the channel is full
5288
5289                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
5290                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
5291                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
5292
5293                 // Close down the channels...
5294                 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
5295                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
5296                 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
5297                 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
5298                 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
5299         }
5300
5301         #[test]
5302         fn duplicate_htlc_test() {
5303                 // Test that we accept duplicate payment_hash HTLCs across the network and that
5304                 // claiming/failing them are all separate and don't effect each other
5305                 let mut nodes = create_network(6);
5306
5307                 // Create some initial channels to route via 3 to 4/5 from 0/1/2
5308                 create_announced_chan_between_nodes(&nodes, 0, 3);
5309                 create_announced_chan_between_nodes(&nodes, 1, 3);
5310                 create_announced_chan_between_nodes(&nodes, 2, 3);
5311                 create_announced_chan_between_nodes(&nodes, 3, 4);
5312                 create_announced_chan_between_nodes(&nodes, 3, 5);
5313
5314                 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
5315
5316                 *nodes[0].network_payment_count.borrow_mut() -= 1;
5317                 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
5318
5319                 *nodes[0].network_payment_count.borrow_mut() -= 1;
5320                 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
5321
5322                 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
5323                 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
5324                 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
5325         }
5326
5327         #[derive(PartialEq)]
5328         enum HTLCType { NONE, TIMEOUT, SUCCESS }
5329         /// Tests that the given node has broadcast transactions for the given Channel
5330         ///
5331         /// First checks that the latest local commitment tx has been broadcast, unless an explicit
5332         /// commitment_tx is provided, which may be used to test that a remote commitment tx was
5333         /// broadcast and the revoked outputs were claimed.
5334         ///
5335         /// Next tests that there is (or is not) a transaction that spends the commitment transaction
5336         /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
5337         ///
5338         /// All broadcast transactions must be accounted for in one of the above three types of we'll
5339         /// also fail.
5340         fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
5341                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5342                 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
5343
5344                 let mut res = Vec::with_capacity(2);
5345                 node_txn.retain(|tx| {
5346                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
5347                                 check_spends!(tx, chan.3.clone());
5348                                 if commitment_tx.is_none() {
5349                                         res.push(tx.clone());
5350                                 }
5351                                 false
5352                         } else { true }
5353                 });
5354                 if let Some(explicit_tx) = commitment_tx {
5355                         res.push(explicit_tx.clone());
5356                 }
5357
5358                 assert_eq!(res.len(), 1);
5359
5360                 if has_htlc_tx != HTLCType::NONE {
5361                         node_txn.retain(|tx| {
5362                                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
5363                                         check_spends!(tx, res[0].clone());
5364                                         if has_htlc_tx == HTLCType::TIMEOUT {
5365                                                 assert!(tx.lock_time != 0);
5366                                         } else {
5367                                                 assert!(tx.lock_time == 0);
5368                                         }
5369                                         res.push(tx.clone());
5370                                         false
5371                                 } else { true }
5372                         });
5373                         assert!(res.len() == 2 || res.len() == 3);
5374                         if res.len() == 3 {
5375                                 assert_eq!(res[1], res[2]);
5376                         }
5377                 }
5378
5379                 assert!(node_txn.is_empty());
5380                 res
5381         }
5382
5383         /// Tests that the given node has broadcast a claim transaction against the provided revoked
5384         /// HTLC transaction.
5385         fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
5386                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5387                 assert_eq!(node_txn.len(), 1);
5388                 node_txn.retain(|tx| {
5389                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
5390                                 check_spends!(tx, revoked_tx.clone());
5391                                 false
5392                         } else { true }
5393                 });
5394                 assert!(node_txn.is_empty());
5395         }
5396
5397         fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
5398                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5399
5400                 assert!(node_txn.len() >= 1);
5401                 assert_eq!(node_txn[0].input.len(), 1);
5402                 let mut found_prev = false;
5403
5404                 for tx in prev_txn {
5405                         if node_txn[0].input[0].previous_output.txid == tx.txid() {
5406                                 check_spends!(node_txn[0], tx.clone());
5407                                 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
5408                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
5409
5410                                 found_prev = true;
5411                                 break;
5412                         }
5413                 }
5414                 assert!(found_prev);
5415
5416                 let mut res = Vec::new();
5417                 mem::swap(&mut *node_txn, &mut res);
5418                 res
5419         }
5420
5421         fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
5422                 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
5423                 assert_eq!(events_1.len(), 1);
5424                 let as_update = match events_1[0] {
5425                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5426                                 msg.clone()
5427                         },
5428                         _ => panic!("Unexpected event"),
5429                 };
5430
5431                 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
5432                 assert_eq!(events_2.len(), 1);
5433                 let bs_update = match events_2[0] {
5434                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5435                                 msg.clone()
5436                         },
5437                         _ => panic!("Unexpected event"),
5438                 };
5439
5440                 for node in nodes {
5441                         node.router.handle_channel_update(&as_update).unwrap();
5442                         node.router.handle_channel_update(&bs_update).unwrap();
5443                 }
5444         }
5445
5446         macro_rules! expect_pending_htlcs_forwardable {
5447                 ($node: expr) => {{
5448                         let events = $node.node.get_and_clear_pending_events();
5449                         assert_eq!(events.len(), 1);
5450                         match events[0] {
5451                                 Event::PendingHTLCsForwardable { .. } => { },
5452                                 _ => panic!("Unexpected event"),
5453                         };
5454                         $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
5455                         $node.node.process_pending_htlc_forwards();
5456                 }}
5457         }
5458
5459         fn do_channel_reserve_test(test_recv: bool) {
5460                 use util::rng;
5461                 use std::sync::atomic::Ordering;
5462                 use ln::msgs::HandleError;
5463
5464                 macro_rules! get_channel_value_stat {
5465                         ($node: expr, $channel_id: expr) => {{
5466                                 let chan_lock = $node.node.channel_state.lock().unwrap();
5467                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
5468                                 chan.get_value_stat()
5469                         }}
5470                 }
5471
5472                 let mut nodes = create_network(3);
5473                 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
5474                 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
5475
5476                 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
5477                 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
5478
5479                 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
5480                 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
5481
5482                 macro_rules! get_route_and_payment_hash {
5483                         ($recv_value: expr) => {{
5484                                 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
5485                                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5486                                 (route, payment_hash, payment_preimage)
5487                         }}
5488                 };
5489
5490                 macro_rules! expect_forward {
5491                         ($node: expr) => {{
5492                                 let mut events = $node.node.get_and_clear_pending_msg_events();
5493                                 assert_eq!(events.len(), 1);
5494                                 check_added_monitors!($node, 1);
5495                                 let payment_event = SendEvent::from_event(events.remove(0));
5496                                 payment_event
5497                         }}
5498                 }
5499
5500                 macro_rules! expect_payment_received {
5501                         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
5502                                 let events = $node.node.get_and_clear_pending_events();
5503                                 assert_eq!(events.len(), 1);
5504                                 match events[0] {
5505                                         Event::PaymentReceived { ref payment_hash, amt } => {
5506                                                 assert_eq!($expected_payment_hash, *payment_hash);
5507                                                 assert_eq!($expected_recv_value, amt);
5508                                         },
5509                                         _ => panic!("Unexpected event"),
5510                                 }
5511                         }
5512                 };
5513
5514                 let feemsat = 239; // somehow we know?
5515                 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
5516
5517                 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
5518
5519                 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
5520                 {
5521                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
5522                         assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
5523                         let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
5524                         match err {
5525                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
5526                                 _ => panic!("Unknown error variants"),
5527                         }
5528                 }
5529
5530                 let mut htlc_id = 0;
5531                 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
5532                 // nodes[0]'s wealth
5533                 loop {
5534                         let amt_msat = recv_value_0 + total_fee_msat;
5535                         if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
5536                                 break;
5537                         }
5538                         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
5539                         htlc_id += 1;
5540
5541                         let (stat01_, stat11_, stat12_, stat22_) = (
5542                                 get_channel_value_stat!(nodes[0], chan_1.2),
5543                                 get_channel_value_stat!(nodes[1], chan_1.2),
5544                                 get_channel_value_stat!(nodes[1], chan_2.2),
5545                                 get_channel_value_stat!(nodes[2], chan_2.2),
5546                         );
5547
5548                         assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
5549                         assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
5550                         assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
5551                         assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
5552                         stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
5553                 }
5554
5555                 {
5556                         let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
5557                         // attempt to get channel_reserve violation
5558                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
5559                         let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
5560                         match err {
5561                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5562                                 _ => panic!("Unknown error variants"),
5563                         }
5564                 }
5565
5566                 // adding pending output
5567                 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
5568                 let amt_msat_1 = recv_value_1 + total_fee_msat;
5569
5570                 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
5571                 let payment_event_1 = {
5572                         nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
5573                         check_added_monitors!(nodes[0], 1);
5574
5575                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5576                         assert_eq!(events.len(), 1);
5577                         SendEvent::from_event(events.remove(0))
5578                 };
5579                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
5580
5581                 // channel reserve test with htlc pending output > 0
5582                 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
5583                 {
5584                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5585                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5586                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5587                                 _ => panic!("Unknown error variants"),
5588                         }
5589                 }
5590
5591                 {
5592                         // test channel_reserve test on nodes[1] side
5593                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5594
5595                         // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
5596                         let secp_ctx = Secp256k1::new();
5597                         let session_priv = SecretKey::from_slice(&secp_ctx, &{
5598                                 let mut session_key = [0; 32];
5599                                 rng::fill_bytes(&mut session_key);
5600                                 session_key
5601                         }).expect("RNG is bad!");
5602
5603                         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5604                         let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
5605                         let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height).unwrap();
5606                         let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5607                         let msg = msgs::UpdateAddHTLC {
5608                                 channel_id: chan_1.2,
5609                                 htlc_id,
5610                                 amount_msat: htlc_msat,
5611                                 payment_hash: our_payment_hash,
5612                                 cltv_expiry: htlc_cltv,
5613                                 onion_routing_packet: onion_packet,
5614                         };
5615
5616                         if test_recv {
5617                                 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
5618                                 match err {
5619                                         HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
5620                                 }
5621                                 // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
5622                                 assert_eq!(nodes[1].node.list_channels().len(), 1);
5623                                 assert_eq!(nodes[1].node.list_channels().len(), 1);
5624                                 let channel_close_broadcast = nodes[1].node.get_and_clear_pending_msg_events();
5625                                 assert_eq!(channel_close_broadcast.len(), 1);
5626                                 match channel_close_broadcast[0] {
5627                                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5628                                                 assert_eq!(msg.contents.flags & 2, 2);
5629                                         },
5630                                         _ => panic!("Unexpected event"),
5631                                 }
5632                                 return;
5633                         }
5634                 }
5635
5636                 // split the rest to test holding cell
5637                 let recv_value_21 = recv_value_2/2;
5638                 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
5639                 {
5640                         let stat = get_channel_value_stat!(nodes[0], chan_1.2);
5641                         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);
5642                 }
5643
5644                 // now see if they go through on both sides
5645                 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
5646                 // but this will stuck in the holding cell
5647                 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
5648                 check_added_monitors!(nodes[0], 0);
5649                 let events = nodes[0].node.get_and_clear_pending_events();
5650                 assert_eq!(events.len(), 0);
5651
5652                 // test with outbound holding cell amount > 0
5653                 {
5654                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
5655                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5656                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5657                                 _ => panic!("Unknown error variants"),
5658                         }
5659                 }
5660
5661                 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
5662                 // this will also stuck in the holding cell
5663                 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
5664                 check_added_monitors!(nodes[0], 0);
5665                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5666                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5667
5668                 // flush the pending htlc
5669                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
5670                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5671                 check_added_monitors!(nodes[1], 1);
5672
5673                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5674                 check_added_monitors!(nodes[0], 1);
5675                 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5676
5677                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
5678                 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5679                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5680                 check_added_monitors!(nodes[0], 1);
5681
5682                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5683                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5684                 check_added_monitors!(nodes[1], 1);
5685
5686                 expect_pending_htlcs_forwardable!(nodes[1]);
5687
5688                 let ref payment_event_11 = expect_forward!(nodes[1]);
5689                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
5690                 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
5691
5692                 expect_pending_htlcs_forwardable!(nodes[2]);
5693                 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
5694
5695                 // flush the htlcs in the holding cell
5696                 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
5697                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
5698                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
5699                 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
5700                 expect_pending_htlcs_forwardable!(nodes[1]);
5701
5702                 let ref payment_event_3 = expect_forward!(nodes[1]);
5703                 assert_eq!(payment_event_3.msgs.len(), 2);
5704                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
5705                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
5706
5707                 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
5708                 expect_pending_htlcs_forwardable!(nodes[2]);
5709
5710                 let events = nodes[2].node.get_and_clear_pending_events();
5711                 assert_eq!(events.len(), 2);
5712                 match events[0] {
5713                         Event::PaymentReceived { ref payment_hash, amt } => {
5714                                 assert_eq!(our_payment_hash_21, *payment_hash);
5715                                 assert_eq!(recv_value_21, amt);
5716                         },
5717                         _ => panic!("Unexpected event"),
5718                 }
5719                 match events[1] {
5720                         Event::PaymentReceived { ref payment_hash, amt } => {
5721                                 assert_eq!(our_payment_hash_22, *payment_hash);
5722                                 assert_eq!(recv_value_22, amt);
5723                         },
5724                         _ => panic!("Unexpected event"),
5725                 }
5726
5727                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
5728                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
5729                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
5730
5731                 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);
5732                 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
5733                 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
5734                 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
5735
5736                 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
5737                 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
5738         }
5739
5740         #[test]
5741         fn channel_reserve_test() {
5742                 do_channel_reserve_test(false);
5743                 do_channel_reserve_test(true);
5744         }
5745
5746         #[test]
5747         fn channel_monitor_network_test() {
5748                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5749                 // tests that ChannelMonitor is able to recover from various states.
5750                 let nodes = create_network(5);
5751
5752                 // Create some initial channels
5753                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5754                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5755                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5756                 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
5757
5758                 // Rebalance the network a bit by relaying one payment through all the channels...
5759                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5760                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5761                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5762                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5763
5764                 // Simple case with no pending HTLCs:
5765                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
5766                 {
5767                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
5768                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5769                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5770                         test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
5771                 }
5772                 get_announce_close_broadcast_events(&nodes, 0, 1);
5773                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5774                 assert_eq!(nodes[1].node.list_channels().len(), 1);
5775
5776                 // One pending HTLC is discarded by the force-close:
5777                 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
5778
5779                 // Simple case of one pending HTLC to HTLC-Timeout
5780                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
5781                 {
5782                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
5783                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5784                         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5785                         test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
5786                 }
5787                 get_announce_close_broadcast_events(&nodes, 1, 2);
5788                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5789                 assert_eq!(nodes[2].node.list_channels().len(), 1);
5790
5791                 macro_rules! claim_funds {
5792                         ($node: expr, $prev_node: expr, $preimage: expr) => {
5793                                 {
5794                                         assert!($node.node.claim_funds($preimage));
5795                                         check_added_monitors!($node, 1);
5796
5797                                         let events = $node.node.get_and_clear_pending_msg_events();
5798                                         assert_eq!(events.len(), 1);
5799                                         match events[0] {
5800                                                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
5801                                                         assert!(update_add_htlcs.is_empty());
5802                                                         assert!(update_fail_htlcs.is_empty());
5803                                                         assert_eq!(*node_id, $prev_node.node.get_our_node_id());
5804                                                 },
5805                                                 _ => panic!("Unexpected event"),
5806                                         };
5807                                 }
5808                         }
5809                 }
5810
5811                 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
5812                 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
5813                 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
5814                 {
5815                         let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
5816
5817                         // Claim the payment on nodes[3], giving it knowledge of the preimage
5818                         claim_funds!(nodes[3], nodes[2], payment_preimage_1);
5819
5820                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5821                         nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
5822
5823                         check_preimage_claim(&nodes[3], &node_txn);
5824                 }
5825                 get_announce_close_broadcast_events(&nodes, 2, 3);
5826                 assert_eq!(nodes[2].node.list_channels().len(), 0);
5827                 assert_eq!(nodes[3].node.list_channels().len(), 1);
5828
5829                 { // Cheat and reset nodes[4]'s height to 1
5830                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5831                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
5832                 }
5833
5834                 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
5835                 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
5836                 // One pending HTLC to time out:
5837                 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
5838                 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
5839                 // buffer space).
5840
5841                 {
5842                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5843                         nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5844                         for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
5845                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5846                                 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5847                         }
5848
5849                         let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
5850
5851                         // Claim the payment on nodes[4], giving it knowledge of the preimage
5852                         claim_funds!(nodes[4], nodes[3], payment_preimage_2);
5853
5854                         header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5855                         nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5856                         for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
5857                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5858                                 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5859                         }
5860
5861                         test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
5862
5863                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5864                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
5865
5866                         check_preimage_claim(&nodes[4], &node_txn);
5867                 }
5868                 get_announce_close_broadcast_events(&nodes, 3, 4);
5869                 assert_eq!(nodes[3].node.list_channels().len(), 0);
5870                 assert_eq!(nodes[4].node.list_channels().len(), 0);
5871         }
5872
5873         #[test]
5874         fn test_justice_tx() {
5875                 // Test justice txn built on revoked HTLC-Success tx, against both sides
5876
5877                 let nodes = create_network(2);
5878                 // Create some new channels:
5879                 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
5880
5881                 // A pending HTLC which will be revoked:
5882                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5883                 // Get the will-be-revoked local txn from nodes[0]
5884                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5885                 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
5886                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5887                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
5888                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
5889                 assert_eq!(revoked_local_txn[1].input.len(), 1);
5890                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5891                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
5892                 // Revoke the old state
5893                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
5894
5895                 {
5896                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5897                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5898                         {
5899                                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5900                                 assert_eq!(node_txn.len(), 3);
5901                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5902                                 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
5903
5904                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5905                                 node_txn.swap_remove(0);
5906                         }
5907                         test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
5908
5909                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5910                         let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
5911                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5912                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5913                         test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
5914                 }
5915                 get_announce_close_broadcast_events(&nodes, 0, 1);
5916
5917                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5918                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5919
5920                 // We test justice_tx build by A on B's revoked HTLC-Success tx
5921                 // Create some new channels:
5922                 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
5923
5924                 // A pending HTLC which will be revoked:
5925                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5926                 // Get the will-be-revoked local txn from B
5927                 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5928                 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
5929                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5930                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
5931                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
5932                 // Revoke the old state
5933                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
5934                 {
5935                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5936                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5937                         {
5938                                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5939                                 assert_eq!(node_txn.len(), 3);
5940                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5941                                 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
5942
5943                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5944                                 node_txn.swap_remove(0);
5945                         }
5946                         test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
5947
5948                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5949                         let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
5950                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5951                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5952                         test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
5953                 }
5954                 get_announce_close_broadcast_events(&nodes, 0, 1);
5955                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5956                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5957         }
5958
5959         #[test]
5960         fn revoked_output_claim() {
5961                 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
5962                 // transaction is broadcast by its counterparty
5963                 let nodes = create_network(2);
5964                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5965                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
5966                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5967                 assert_eq!(revoked_local_txn.len(), 1);
5968                 // Only output is the full channel value back to nodes[0]:
5969                 assert_eq!(revoked_local_txn[0].output.len(), 1);
5970                 // Send a payment through, updating everyone's latest commitment txn
5971                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
5972
5973                 // Inform nodes[1] that nodes[0] broadcast a stale tx
5974                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5975                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5976                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5977                 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
5978
5979                 assert_eq!(node_txn[0], node_txn[2]);
5980
5981                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5982                 check_spends!(node_txn[1], chan_1.3.clone());
5983
5984                 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
5985                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5986                 get_announce_close_broadcast_events(&nodes, 0, 1);
5987         }
5988
5989         #[test]
5990         fn claim_htlc_outputs_shared_tx() {
5991                 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
5992                 let nodes = create_network(2);
5993
5994                 // Create some new channel:
5995                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5996
5997                 // Rebalance the network to generate htlc in the two directions
5998                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5999                 // 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
6000                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6001                 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
6002
6003                 // Get the will-be-revoked local txn from node[0]
6004                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
6005                 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
6006                 assert_eq!(revoked_local_txn[0].input.len(), 1);
6007                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
6008                 assert_eq!(revoked_local_txn[1].input.len(), 1);
6009                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
6010                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
6011                 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
6012
6013                 //Revoke the old state
6014                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
6015
6016                 {
6017                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6018                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6019                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6020
6021                         let events = nodes[1].node.get_and_clear_pending_events();
6022                         assert_eq!(events.len(), 1);
6023                         match events[0] {
6024                                 Event::PaymentFailed { payment_hash, .. } => {
6025                                         assert_eq!(payment_hash, payment_hash_2);
6026                                 },
6027                                 _ => panic!("Unexpected event"),
6028                         }
6029
6030                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6031                         assert_eq!(node_txn.len(), 4);
6032
6033                         assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
6034                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
6035
6036                         assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
6037
6038                         let mut witness_lens = BTreeSet::new();
6039                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
6040                         witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
6041                         witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
6042                         assert_eq!(witness_lens.len(), 3);
6043                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
6044                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
6045                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
6046
6047                         // Next nodes[1] broadcasts its current local tx state:
6048                         assert_eq!(node_txn[1].input.len(), 1);
6049                         assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
6050
6051                         assert_eq!(node_txn[2].input.len(), 1);
6052                         let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
6053                         assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
6054                         assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
6055                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
6056                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
6057                 }
6058                 get_announce_close_broadcast_events(&nodes, 0, 1);
6059                 assert_eq!(nodes[0].node.list_channels().len(), 0);
6060                 assert_eq!(nodes[1].node.list_channels().len(), 0);
6061         }
6062
6063         #[test]
6064         fn claim_htlc_outputs_single_tx() {
6065                 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
6066                 let nodes = create_network(2);
6067
6068                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
6069
6070                 // Rebalance the network to generate htlc in the two directions
6071                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
6072                 // 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
6073                 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
6074                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6075                 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
6076
6077                 // Get the will-be-revoked local txn from node[0]
6078                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
6079
6080                 //Revoke the old state
6081                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
6082
6083                 {
6084                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6085                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
6086                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
6087
6088                         let events = nodes[1].node.get_and_clear_pending_events();
6089                         assert_eq!(events.len(), 1);
6090                         match events[0] {
6091                                 Event::PaymentFailed { payment_hash, .. } => {
6092                                         assert_eq!(payment_hash, payment_hash_2);
6093                                 },
6094                                 _ => panic!("Unexpected event"),
6095                         }
6096
6097                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6098                         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)
6099
6100                         assert_eq!(node_txn[0], node_txn[7]);
6101                         assert_eq!(node_txn[1], node_txn[8]);
6102                         assert_eq!(node_txn[2], node_txn[9]);
6103                         assert_eq!(node_txn[3], node_txn[10]);
6104                         assert_eq!(node_txn[4], node_txn[11]);
6105                         assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
6106                         assert_eq!(node_txn[4], node_txn[6]);
6107
6108                         assert_eq!(node_txn[0].input.len(), 1);
6109                         assert_eq!(node_txn[1].input.len(), 1);
6110                         assert_eq!(node_txn[2].input.len(), 1);
6111
6112                         let mut revoked_tx_map = HashMap::new();
6113                         revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
6114                         node_txn[0].verify(&revoked_tx_map).unwrap();
6115                         node_txn[1].verify(&revoked_tx_map).unwrap();
6116                         node_txn[2].verify(&revoked_tx_map).unwrap();
6117
6118                         let mut witness_lens = BTreeSet::new();
6119                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
6120                         witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
6121                         witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
6122                         assert_eq!(witness_lens.len(), 3);
6123                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
6124                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
6125                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
6126
6127                         assert_eq!(node_txn[3].input.len(), 1);
6128                         check_spends!(node_txn[3], chan_1.3.clone());
6129
6130                         assert_eq!(node_txn[4].input.len(), 1);
6131                         let witness_script = node_txn[4].input[0].witness.last().unwrap();
6132                         assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
6133                         assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
6134                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
6135                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
6136                 }
6137                 get_announce_close_broadcast_events(&nodes, 0, 1);
6138                 assert_eq!(nodes[0].node.list_channels().len(), 0);
6139                 assert_eq!(nodes[1].node.list_channels().len(), 0);
6140         }
6141
6142         #[test]
6143         fn test_htlc_on_chain_success() {
6144                 // Test that in case of an unilateral close onchain, we detect the state of output thanks to
6145                 // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
6146                 // broadcasting the right event to other nodes in payment path.
6147                 // A --------------------> B ----------------------> C (preimage)
6148                 // First, C should claim the HTLC output via HTLC-Success when its own latest local
6149                 // commitment transaction was broadcast.
6150                 // Then, B should learn the preimage from said transactions, attempting to claim backwards
6151                 // towards B.
6152                 // B should be able to claim via preimage if A then broadcasts its local tx.
6153                 // Finally, when A sees B's latest local commitment transaction it should be able to claim
6154                 // the HTLC output via the preimage it learned (which, once confirmed should generate a
6155                 // PaymentSent event).
6156
6157                 let nodes = create_network(3);
6158
6159                 // Create some initial channels
6160                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
6161                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
6162
6163                 // Rebalance the network a bit by relaying one payment through all the channels...
6164                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
6165                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
6166
6167                 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
6168                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6169
6170                 // Broadcast legit commitment tx from C on B's chain
6171                 // Broadcast HTLC Success transation by C on received output from C's commitment tx on B's chain
6172                 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
6173                 assert_eq!(commitment_tx.len(), 1);
6174                 check_spends!(commitment_tx[0], chan_2.3.clone());
6175                 nodes[2].node.claim_funds(our_payment_preimage);
6176                 check_added_monitors!(nodes[2], 1);
6177                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6178                 assert!(updates.update_add_htlcs.is_empty());
6179                 assert!(updates.update_fail_htlcs.is_empty());
6180                 assert!(updates.update_fail_malformed_htlcs.is_empty());
6181                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
6182
6183                 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
6184                 let events = nodes[2].node.get_and_clear_pending_msg_events();
6185                 assert_eq!(events.len(), 1);
6186                 match events[0] {
6187                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6188                         _ => panic!("Unexpected event"),
6189                 }
6190                 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
6191                 assert_eq!(node_txn.len(), 3);
6192                 assert_eq!(node_txn[1], commitment_tx[0]);
6193                 assert_eq!(node_txn[0], node_txn[2]);
6194                 check_spends!(node_txn[0], commitment_tx[0].clone());
6195                 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6196                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
6197                 assert_eq!(node_txn[0].lock_time, 0);
6198
6199                 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
6200                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: node_txn}, 1);
6201                 let events = nodes[1].node.get_and_clear_pending_msg_events();
6202                 {
6203                         let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
6204                         assert_eq!(added_monitors.len(), 1);
6205                         assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
6206                         added_monitors.clear();
6207                 }
6208                 assert_eq!(events.len(), 2);
6209                 match events[0] {
6210                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6211                         _ => panic!("Unexpected event"),
6212                 }
6213                 match events[1] {
6214                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
6215                                 assert!(update_add_htlcs.is_empty());
6216                                 assert!(update_fail_htlcs.is_empty());
6217                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6218                                 assert!(update_fail_malformed_htlcs.is_empty());
6219                                 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
6220                         },
6221                         _ => panic!("Unexpected event"),
6222                 };
6223                 {
6224                         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
6225                         // commitment transaction with a corresponding HTLC-Timeout transaction, as well as a
6226                         // timeout-claim of the output that nodes[2] just claimed via success.
6227                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 (timeout tx) * 2 (block-rescan)
6228                         assert_eq!(node_txn.len(), 4);
6229                         assert_eq!(node_txn[0], node_txn[3]);
6230                         check_spends!(node_txn[0], commitment_tx[0].clone());
6231                         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6232                         assert_ne!(node_txn[0].lock_time, 0);
6233                         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
6234                         check_spends!(node_txn[1], chan_2.3.clone());
6235                         check_spends!(node_txn[2], node_txn[1].clone());
6236                         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
6237                         assert_eq!(node_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6238                         assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
6239                         assert_ne!(node_txn[2].lock_time, 0);
6240                         node_txn.clear();
6241                 }
6242
6243                 // Broadcast legit commitment tx from A on B's chain
6244                 // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
6245                 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
6246                 check_spends!(commitment_tx[0], chan_1.3.clone());
6247                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
6248                 let events = nodes[1].node.get_and_clear_pending_msg_events();
6249                 assert_eq!(events.len(), 1);
6250                 match events[0] {
6251                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6252                         _ => panic!("Unexpected event"),
6253                 }
6254                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
6255                 assert_eq!(node_txn.len(), 3);
6256                 assert_eq!(node_txn[0], node_txn[2]);
6257                 check_spends!(node_txn[0], commitment_tx[0].clone());
6258                 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6259                 assert_eq!(node_txn[0].lock_time, 0);
6260                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
6261                 check_spends!(node_txn[1], chan_1.3.clone());
6262                 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
6263                 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
6264                 // we already checked the same situation with A.
6265
6266                 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
6267                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
6268                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6269                 assert_eq!(events.len(), 1);
6270                 match events[0] {
6271                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6272                         _ => panic!("Unexpected event"),
6273                 }
6274                 let events = nodes[0].node.get_and_clear_pending_events();
6275                 assert_eq!(events.len(), 1);
6276                 match events[0] {
6277                         Event::PaymentSent { payment_preimage } => {
6278                                 assert_eq!(payment_preimage, our_payment_preimage);
6279                         },
6280                         _ => panic!("Unexpected event"),
6281                 }
6282                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 (HTLC-Timeout tx) * 2 (block-rescan)
6283                 assert_eq!(node_txn.len(), 4);
6284                 assert_eq!(node_txn[0], node_txn[3]);
6285                 check_spends!(node_txn[0], commitment_tx[0].clone());
6286                 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6287                 assert_ne!(node_txn[0].lock_time, 0);
6288                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
6289                 check_spends!(node_txn[1], chan_1.3.clone());
6290                 check_spends!(node_txn[2], node_txn[1].clone());
6291                 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
6292                 assert_eq!(node_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6293                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
6294                 assert_ne!(node_txn[2].lock_time, 0);
6295         }
6296
6297         #[test]
6298         fn test_htlc_on_chain_timeout() {
6299                 // Test that in case of an unilateral close onchain, we detect the state of output thanks to
6300                 // ChainWatchInterface and timeout the HTLC  bacward accordingly. So here we test that ChannelManager is
6301                 // broadcasting the right event to other nodes in payment path.
6302                 // A ------------------> B ----------------------> C (timeout)
6303                 //    B's commitment tx                 C's commitment tx
6304                 //            \                                  \
6305                 //         B's HTLC timeout tx               B's timeout tx
6306
6307                 let nodes = create_network(3);
6308
6309                 // Create some intial channels
6310                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
6311                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
6312
6313                 // Rebalance the network a bit by relaying one payment thorugh all the channels...
6314                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
6315                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
6316
6317                 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
6318                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6319
6320                 // Brodacast legit commitment tx from C on B's chain
6321                 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
6322                 check_spends!(commitment_tx[0], chan_2.3.clone());
6323                 nodes[2].node.fail_htlc_backwards(&payment_hash, PaymentFailReason::PreimageUnknown);
6324                 {
6325                         let mut added_monitors = nodes[2].chan_monitor.added_monitors.lock().unwrap();
6326                         assert_eq!(added_monitors.len(), 1);
6327                         added_monitors.clear();
6328                 }
6329                 let events = nodes[2].node.get_and_clear_pending_msg_events();
6330                 assert_eq!(events.len(), 1);
6331                 match events[0] {
6332                         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, .. } } => {
6333                                 assert!(update_add_htlcs.is_empty());
6334                                 assert!(!update_fail_htlcs.is_empty());
6335                                 assert!(update_fulfill_htlcs.is_empty());
6336                                 assert!(update_fail_malformed_htlcs.is_empty());
6337                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
6338                         },
6339                         _ => panic!("Unexpected event"),
6340                 };
6341                 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
6342                 let events = nodes[2].node.get_and_clear_pending_msg_events();
6343                 assert_eq!(events.len(), 1);
6344                 match events[0] {
6345                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
6346                         _ => panic!("Unexpected event"),
6347                 }
6348                 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
6349                 assert_eq!(node_txn.len(), 1);
6350                 check_spends!(node_txn[0], chan_2.3.clone());
6351                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
6352
6353                 // Broadcast timeout transaction by B on received output fron C's commitment tx on B's chain
6354                 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
6355                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
6356                 let timeout_tx;
6357                 {
6358                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6359                         assert_eq!(node_txn.len(), 8); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 6 (HTLC-Timeout tx, commitment tx, timeout tx) * 2 (block-rescan)
6360                         assert_eq!(node_txn[0], node_txn[5]);
6361                         assert_eq!(node_txn[1], node_txn[6]);
6362                         assert_eq!(node_txn[2], node_txn[7]);
6363                         check_spends!(node_txn[0], commitment_tx[0].clone());
6364                         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6365                         check_spends!(node_txn[1], chan_2.3.clone());
6366                         check_spends!(node_txn[2], node_txn[1].clone());
6367                         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
6368                         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6369                         check_spends!(node_txn[3], chan_2.3.clone());
6370                         check_spends!(node_txn[4], node_txn[3].clone());
6371                         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
6372                         assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6373                         timeout_tx = node_txn[0].clone();
6374                         node_txn.clear();
6375                 }
6376
6377                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![timeout_tx]}, 1);
6378                 let events = nodes[1].node.get_and_clear_pending_msg_events();
6379                 check_added_monitors!(nodes[1], 1);
6380                 assert_eq!(events.len(), 2);
6381                 match events[0] {
6382                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
6383                         _ => panic!("Unexpected event"),
6384                 }
6385                 match events[1] {
6386                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
6387                                 assert!(update_add_htlcs.is_empty());
6388                                 assert!(!update_fail_htlcs.is_empty());
6389                                 assert!(update_fulfill_htlcs.is_empty());
6390                                 assert!(update_fail_malformed_htlcs.is_empty());
6391                                 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
6392                         },
6393                         _ => panic!("Unexpected event"),
6394                 };
6395                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // Well... here we detect our own htlc_timeout_tx so no tx to be generated
6396                 assert_eq!(node_txn.len(), 0);
6397
6398                 // Broadcast legit commitment tx from B on A's chain
6399                 let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
6400                 check_spends!(commitment_tx[0], chan_1.3.clone());
6401
6402                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
6403                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6404                 assert_eq!(events.len(), 1);
6405                 match events[0] {
6406                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
6407                         _ => panic!("Unexpected event"),
6408                 }
6409                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 block-rescan
6410                 assert_eq!(node_txn.len(), 4);
6411                 assert_eq!(node_txn[0], node_txn[3]);
6412                 check_spends!(node_txn[0], commitment_tx[0].clone());
6413                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6414                 check_spends!(node_txn[1], chan_1.3.clone());
6415                 check_spends!(node_txn[2], node_txn[1].clone());
6416                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
6417                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6418         }
6419
6420         #[test]
6421         fn test_simple_commitment_revoked_fail_backward() {
6422                 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
6423                 // and fail backward accordingly.
6424
6425                 let nodes = create_network(3);
6426
6427                 // Create some initial channels
6428                 create_announced_chan_between_nodes(&nodes, 0, 1);
6429                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
6430
6431                 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
6432                 // Get the will-be-revoked local txn from nodes[2]
6433                 let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
6434                 // Revoke the old state
6435                 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
6436
6437                 route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
6438
6439                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6440                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
6441                 let events = nodes[1].node.get_and_clear_pending_msg_events();
6442                 check_added_monitors!(nodes[1], 1);
6443                 assert_eq!(events.len(), 2);
6444                 match events[0] {
6445                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
6446                         _ => panic!("Unexpected event"),
6447                 }
6448                 match events[1] {
6449                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
6450                                 assert!(update_add_htlcs.is_empty());
6451                                 assert_eq!(update_fail_htlcs.len(), 1);
6452                                 assert!(update_fulfill_htlcs.is_empty());
6453                                 assert!(update_fail_malformed_htlcs.is_empty());
6454                                 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
6455
6456                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
6457                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6458
6459                                 let events = nodes[0].node.get_and_clear_pending_msg_events();
6460                                 assert_eq!(events.len(), 1);
6461                                 match events[0] {
6462                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6463                                         _ => panic!("Unexpected event"),
6464                                 }
6465                                 let events = nodes[0].node.get_and_clear_pending_events();
6466                                 assert_eq!(events.len(), 1);
6467                                 match events[0] {
6468                                         Event::PaymentFailed { .. } => {},
6469                                         _ => panic!("Unexpected event"),
6470                                 }
6471                         },
6472                         _ => panic!("Unexpected event"),
6473                 }
6474         }
6475
6476         #[test]
6477         fn test_htlc_ignore_latest_remote_commitment() {
6478                 // Test that HTLC transactions spending the latest remote commitment transaction are simply
6479                 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
6480                 let nodes = create_network(2);
6481                 create_announced_chan_between_nodes(&nodes, 0, 1);
6482
6483                 route_payment(&nodes[0], &[&nodes[1]], 10000000);
6484                 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
6485                 {
6486                         let events = nodes[0].node.get_and_clear_pending_msg_events();
6487                         assert_eq!(events.len(), 1);
6488                         match events[0] {
6489                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6490                                         assert_eq!(flags & 0b10, 0b10);
6491                                 },
6492                                 _ => panic!("Unexpected event"),
6493                         }
6494                 }
6495
6496                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6497                 assert_eq!(node_txn.len(), 2);
6498
6499                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6500                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
6501
6502                 {
6503                         let events = nodes[1].node.get_and_clear_pending_msg_events();
6504                         assert_eq!(events.len(), 1);
6505                         match events[0] {
6506                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6507                                         assert_eq!(flags & 0b10, 0b10);
6508                                 },
6509                                 _ => panic!("Unexpected event"),
6510                         }
6511                 }
6512
6513                 // Duplicate the block_connected call since this may happen due to other listeners
6514                 // registering new transactions
6515                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
6516         }
6517
6518         #[test]
6519         fn test_force_close_fail_back() {
6520                 // Check which HTLCs are failed-backwards on channel force-closure
6521                 let mut nodes = create_network(3);
6522                 create_announced_chan_between_nodes(&nodes, 0, 1);
6523                 create_announced_chan_between_nodes(&nodes, 1, 2);
6524
6525                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
6526
6527                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6528
6529                 let mut payment_event = {
6530                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6531                         check_added_monitors!(nodes[0], 1);
6532
6533                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6534                         assert_eq!(events.len(), 1);
6535                         SendEvent::from_event(events.remove(0))
6536                 };
6537
6538                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6539                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6540
6541                 let events_1 = nodes[1].node.get_and_clear_pending_events();
6542                 assert_eq!(events_1.len(), 1);
6543                 match events_1[0] {
6544                         Event::PendingHTLCsForwardable { .. } => { },
6545                         _ => panic!("Unexpected event"),
6546                 };
6547
6548                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6549                 nodes[1].node.process_pending_htlc_forwards();
6550
6551                 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6552                 assert_eq!(events_2.len(), 1);
6553                 payment_event = SendEvent::from_event(events_2.remove(0));
6554                 assert_eq!(payment_event.msgs.len(), 1);
6555
6556                 check_added_monitors!(nodes[1], 1);
6557                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6558                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6559                 check_added_monitors!(nodes[2], 1);
6560                 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6561
6562                 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
6563                 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
6564                 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
6565
6566                 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
6567                 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6568                 assert_eq!(events_3.len(), 1);
6569                 match events_3[0] {
6570                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6571                                 assert_eq!(flags & 0b10, 0b10);
6572                         },
6573                         _ => panic!("Unexpected event"),
6574                 }
6575
6576                 let tx = {
6577                         let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
6578                         // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
6579                         // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
6580                         // back to nodes[1] upon timeout otherwise.
6581                         assert_eq!(node_txn.len(), 1);
6582                         node_txn.remove(0)
6583                 };
6584
6585                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6586                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
6587
6588                 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6589                 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
6590                 assert_eq!(events_4.len(), 1);
6591                 match events_4[0] {
6592                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6593                                 assert_eq!(flags & 0b10, 0b10);
6594                         },
6595                         _ => panic!("Unexpected event"),
6596                 }
6597
6598                 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
6599                 {
6600                         let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
6601                         monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
6602                                 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
6603                 }
6604                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
6605                 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
6606                 assert_eq!(node_txn.len(), 1);
6607                 assert_eq!(node_txn[0].input.len(), 1);
6608                 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
6609                 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
6610                 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
6611
6612                 check_spends!(node_txn[0], tx);
6613         }
6614
6615         #[test]
6616         fn test_unconf_chan() {
6617                 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
6618                 let nodes = create_network(2);
6619                 create_announced_chan_between_nodes(&nodes, 0, 1);
6620
6621                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
6622                 assert_eq!(channel_state.by_id.len(), 1);
6623                 assert_eq!(channel_state.short_to_id.len(), 1);
6624                 mem::drop(channel_state);
6625
6626                 let mut headers = Vec::new();
6627                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6628                 headers.push(header.clone());
6629                 for _i in 2..100 {
6630                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6631                         headers.push(header.clone());
6632                 }
6633                 while !headers.is_empty() {
6634                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
6635                 }
6636                 {
6637                         let events = nodes[0].node.get_and_clear_pending_msg_events();
6638                         assert_eq!(events.len(), 1);
6639                         match events[0] {
6640                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6641                                         assert_eq!(flags & 0b10, 0b10);
6642                                 },
6643                                 _ => panic!("Unexpected event"),
6644                         }
6645                 }
6646                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
6647                 assert_eq!(channel_state.by_id.len(), 0);
6648                 assert_eq!(channel_state.short_to_id.len(), 0);
6649         }
6650
6651         macro_rules! get_chan_reestablish_msgs {
6652                 ($src_node: expr, $dst_node: expr) => {
6653                         {
6654                                 let mut res = Vec::with_capacity(1);
6655                                 for msg in $src_node.node.get_and_clear_pending_msg_events() {
6656                                         if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6657                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6658                                                 res.push(msg.clone());
6659                                         } else {
6660                                                 panic!("Unexpected event")
6661                                         }
6662                                 }
6663                                 res
6664                         }
6665                 }
6666         }
6667
6668         macro_rules! handle_chan_reestablish_msgs {
6669                 ($src_node: expr, $dst_node: expr) => {
6670                         {
6671                                 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
6672                                 let mut idx = 0;
6673                                 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
6674                                         idx += 1;
6675                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6676                                         Some(msg.clone())
6677                                 } else {
6678                                         None
6679                                 };
6680
6681                                 let mut revoke_and_ack = None;
6682                                 let mut commitment_update = None;
6683                                 let order = if let Some(ev) = msg_events.get(idx) {
6684                                         idx += 1;
6685                                         match ev {
6686                                                 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6687                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6688                                                         revoke_and_ack = Some(msg.clone());
6689                                                         RAACommitmentOrder::RevokeAndACKFirst
6690                                                 },
6691                                                 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6692                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6693                                                         commitment_update = Some(updates.clone());
6694                                                         RAACommitmentOrder::CommitmentFirst
6695                                                 },
6696                                                 _ => panic!("Unexpected event"),
6697                                         }
6698                                 } else {
6699                                         RAACommitmentOrder::CommitmentFirst
6700                                 };
6701
6702                                 if let Some(ev) = msg_events.get(idx) {
6703                                         match ev {
6704                                                 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6705                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6706                                                         assert!(revoke_and_ack.is_none());
6707                                                         revoke_and_ack = Some(msg.clone());
6708                                                 },
6709                                                 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6710                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6711                                                         assert!(commitment_update.is_none());
6712                                                         commitment_update = Some(updates.clone());
6713                                                 },
6714                                                 _ => panic!("Unexpected event"),
6715                                         }
6716                                 }
6717
6718                                 (funding_locked, revoke_and_ack, commitment_update, order)
6719                         }
6720                 }
6721         }
6722
6723         /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
6724         /// for claims/fails they are separated out.
6725         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)) {
6726                 node_a.node.peer_connected(&node_b.node.get_our_node_id());
6727                 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
6728                 node_b.node.peer_connected(&node_a.node.get_our_node_id());
6729                 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
6730
6731                 if send_funding_locked.0 {
6732                         // If a expects a funding_locked, it better not think it has received a revoke_and_ack
6733                         // from b
6734                         for reestablish in reestablish_1.iter() {
6735                                 assert_eq!(reestablish.next_remote_commitment_number, 0);
6736                         }
6737                 }
6738                 if send_funding_locked.1 {
6739                         // If b expects a funding_locked, it better not think it has received a revoke_and_ack
6740                         // from a
6741                         for reestablish in reestablish_2.iter() {
6742                                 assert_eq!(reestablish.next_remote_commitment_number, 0);
6743                         }
6744                 }
6745                 if send_funding_locked.0 || send_funding_locked.1 {
6746                         // If we expect any funding_locked's, both sides better have set
6747                         // next_local_commitment_number to 1
6748                         for reestablish in reestablish_1.iter() {
6749                                 assert_eq!(reestablish.next_local_commitment_number, 1);
6750                         }
6751                         for reestablish in reestablish_2.iter() {
6752                                 assert_eq!(reestablish.next_local_commitment_number, 1);
6753                         }
6754                 }
6755
6756                 let mut resp_1 = Vec::new();
6757                 for msg in reestablish_1 {
6758                         node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
6759                         resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
6760                 }
6761                 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
6762                         check_added_monitors!(node_b, 1);
6763                 } else {
6764                         check_added_monitors!(node_b, 0);
6765                 }
6766
6767                 let mut resp_2 = Vec::new();
6768                 for msg in reestablish_2 {
6769                         node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
6770                         resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
6771                 }
6772                 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
6773                         check_added_monitors!(node_a, 1);
6774                 } else {
6775                         check_added_monitors!(node_a, 0);
6776                 }
6777
6778                 // We dont yet support both needing updates, as that would require a different commitment dance:
6779                 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
6780                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
6781
6782                 for chan_msgs in resp_1.drain(..) {
6783                         if send_funding_locked.0 {
6784                                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
6785                                 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
6786                                 if !announcement_event.is_empty() {
6787                                         assert_eq!(announcement_event.len(), 1);
6788                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
6789                                                 //TODO: Test announcement_sigs re-sending
6790                                         } else { panic!("Unexpected event!"); }
6791                                 }
6792                         } else {
6793                                 assert!(chan_msgs.0.is_none());
6794                         }
6795                         if pending_raa.0 {
6796                                 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
6797                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
6798                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
6799                                 check_added_monitors!(node_a, 1);
6800                         } else {
6801                                 assert!(chan_msgs.1.is_none());
6802                         }
6803                         if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
6804                                 let commitment_update = chan_msgs.2.unwrap();
6805                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
6806                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
6807                                 } else {
6808                                         assert!(commitment_update.update_add_htlcs.is_empty());
6809                                 }
6810                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
6811                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
6812                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
6813                                 for update_add in commitment_update.update_add_htlcs {
6814                                         node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
6815                                 }
6816                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
6817                                         node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
6818                                 }
6819                                 for update_fail in commitment_update.update_fail_htlcs {
6820                                         node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
6821                                 }
6822
6823                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
6824                                         commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
6825                                 } else {
6826                                         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
6827                                         check_added_monitors!(node_a, 1);
6828                                         let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
6829                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
6830                                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6831                                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
6832                                         check_added_monitors!(node_b, 1);
6833                                 }
6834                         } else {
6835                                 assert!(chan_msgs.2.is_none());
6836                         }
6837                 }
6838
6839                 for chan_msgs in resp_2.drain(..) {
6840                         if send_funding_locked.1 {
6841                                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
6842                                 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
6843                                 if !announcement_event.is_empty() {
6844                                         assert_eq!(announcement_event.len(), 1);
6845                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
6846                                                 //TODO: Test announcement_sigs re-sending
6847                                         } else { panic!("Unexpected event!"); }
6848                                 }
6849                         } else {
6850                                 assert!(chan_msgs.0.is_none());
6851                         }
6852                         if pending_raa.1 {
6853                                 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
6854                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
6855                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
6856                                 check_added_monitors!(node_b, 1);
6857                         } else {
6858                                 assert!(chan_msgs.1.is_none());
6859                         }
6860                         if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
6861                                 let commitment_update = chan_msgs.2.unwrap();
6862                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
6863                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
6864                                 }
6865                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
6866                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
6867                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
6868                                 for update_add in commitment_update.update_add_htlcs {
6869                                         node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
6870                                 }
6871                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
6872                                         node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
6873                                 }
6874                                 for update_fail in commitment_update.update_fail_htlcs {
6875                                         node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
6876                                 }
6877
6878                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
6879                                         commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
6880                                 } else {
6881                                         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
6882                                         check_added_monitors!(node_b, 1);
6883                                         let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
6884                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
6885                                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6886                                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
6887                                         check_added_monitors!(node_a, 1);
6888                                 }
6889                         } else {
6890                                 assert!(chan_msgs.2.is_none());
6891                         }
6892                 }
6893         }
6894
6895         #[test]
6896         fn test_simple_peer_disconnect() {
6897                 // Test that we can reconnect when there are no lost messages
6898                 let nodes = create_network(3);
6899                 create_announced_chan_between_nodes(&nodes, 0, 1);
6900                 create_announced_chan_between_nodes(&nodes, 1, 2);
6901
6902                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6903                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6904                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6905
6906                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6907                 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6908                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
6909                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
6910
6911                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6912                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6913                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6914
6915                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6916                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6917                 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6918                 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6919
6920                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6921                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6922
6923                 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
6924                 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
6925
6926                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
6927                 {
6928                         let events = nodes[0].node.get_and_clear_pending_events();
6929                         assert_eq!(events.len(), 2);
6930                         match events[0] {
6931                                 Event::PaymentSent { payment_preimage } => {
6932                                         assert_eq!(payment_preimage, payment_preimage_3);
6933                                 },
6934                                 _ => panic!("Unexpected event"),
6935                         }
6936                         match events[1] {
6937                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
6938                                         assert_eq!(payment_hash, payment_hash_5);
6939                                         assert!(rejected_by_dest);
6940                                 },
6941                                 _ => panic!("Unexpected event"),
6942                         }
6943                 }
6944
6945                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
6946                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
6947         }
6948
6949         fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
6950                 // Test that we can reconnect when in-flight HTLC updates get dropped
6951                 let mut nodes = create_network(2);
6952                 if messages_delivered == 0 {
6953                         create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
6954                         // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
6955                 } else {
6956                         create_announced_chan_between_nodes(&nodes, 0, 1);
6957                 }
6958
6959                 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();
6960                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6961
6962                 let payment_event = {
6963                         nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
6964                         check_added_monitors!(nodes[0], 1);
6965
6966                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6967                         assert_eq!(events.len(), 1);
6968                         SendEvent::from_event(events.remove(0))
6969                 };
6970                 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
6971
6972                 if messages_delivered < 2 {
6973                         // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
6974                 } else {
6975                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6976                         if messages_delivered >= 3 {
6977                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6978                                 check_added_monitors!(nodes[1], 1);
6979                                 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6980
6981                                 if messages_delivered >= 4 {
6982                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6983                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6984                                         check_added_monitors!(nodes[0], 1);
6985
6986                                         if messages_delivered >= 5 {
6987                                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
6988                                                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6989                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6990                                                 check_added_monitors!(nodes[0], 1);
6991
6992                                                 if messages_delivered >= 6 {
6993                                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6994                                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6995                                                         check_added_monitors!(nodes[1], 1);
6996                                                 }
6997                                         }
6998                                 }
6999                         }
7000                 }
7001
7002                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7003                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7004                 if messages_delivered < 3 {
7005                         // Even if the funding_locked messages get exchanged, as long as nothing further was
7006                         // received on either side, both sides will need to resend them.
7007                         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
7008                 } else if messages_delivered == 3 {
7009                         // nodes[0] still wants its RAA + commitment_signed
7010                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
7011                 } else if messages_delivered == 4 {
7012                         // nodes[0] still wants its commitment_signed
7013                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
7014                 } else if messages_delivered == 5 {
7015                         // nodes[1] still wants its final RAA
7016                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
7017                 } else if messages_delivered == 6 {
7018                         // Everything was delivered...
7019                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7020                 }
7021
7022                 let events_1 = nodes[1].node.get_and_clear_pending_events();
7023                 assert_eq!(events_1.len(), 1);
7024                 match events_1[0] {
7025                         Event::PendingHTLCsForwardable { .. } => { },
7026                         _ => panic!("Unexpected event"),
7027                 };
7028
7029                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7030                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7031                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7032
7033                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
7034                 nodes[1].node.process_pending_htlc_forwards();
7035
7036                 let events_2 = nodes[1].node.get_and_clear_pending_events();
7037                 assert_eq!(events_2.len(), 1);
7038                 match events_2[0] {
7039                         Event::PaymentReceived { ref payment_hash, amt } => {
7040                                 assert_eq!(payment_hash_1, *payment_hash);
7041                                 assert_eq!(amt, 1000000);
7042                         },
7043                         _ => panic!("Unexpected event"),
7044                 }
7045
7046                 nodes[1].node.claim_funds(payment_preimage_1);
7047                 check_added_monitors!(nodes[1], 1);
7048
7049                 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
7050                 assert_eq!(events_3.len(), 1);
7051                 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
7052                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
7053                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7054                                 assert!(updates.update_add_htlcs.is_empty());
7055                                 assert!(updates.update_fail_htlcs.is_empty());
7056                                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
7057                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7058                                 assert!(updates.update_fee.is_none());
7059                                 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
7060                         },
7061                         _ => panic!("Unexpected event"),
7062                 };
7063
7064                 if messages_delivered >= 1 {
7065                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
7066
7067                         let events_4 = nodes[0].node.get_and_clear_pending_events();
7068                         assert_eq!(events_4.len(), 1);
7069                         match events_4[0] {
7070                                 Event::PaymentSent { ref payment_preimage } => {
7071                                         assert_eq!(payment_preimage_1, *payment_preimage);
7072                                 },
7073                                 _ => panic!("Unexpected event"),
7074                         }
7075
7076                         if messages_delivered >= 2 {
7077                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
7078                                 check_added_monitors!(nodes[0], 1);
7079                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7080
7081                                 if messages_delivered >= 3 {
7082                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
7083                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7084                                         check_added_monitors!(nodes[1], 1);
7085
7086                                         if messages_delivered >= 4 {
7087                                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
7088                                                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7089                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7090                                                 check_added_monitors!(nodes[1], 1);
7091
7092                                                 if messages_delivered >= 5 {
7093                                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
7094                                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7095                                                         check_added_monitors!(nodes[0], 1);
7096                                                 }
7097                                         }
7098                                 }
7099                         }
7100                 }
7101
7102                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7103                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7104                 if messages_delivered < 2 {
7105                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
7106                         //TODO: Deduplicate PaymentSent events, then enable this if:
7107                         //if messages_delivered < 1 {
7108                                 let events_4 = nodes[0].node.get_and_clear_pending_events();
7109                                 assert_eq!(events_4.len(), 1);
7110                                 match events_4[0] {
7111                                         Event::PaymentSent { ref payment_preimage } => {
7112                                                 assert_eq!(payment_preimage_1, *payment_preimage);
7113                                         },
7114                                         _ => panic!("Unexpected event"),
7115                                 }
7116                         //}
7117                 } else if messages_delivered == 2 {
7118                         // nodes[0] still wants its RAA + commitment_signed
7119                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
7120                 } else if messages_delivered == 3 {
7121                         // nodes[0] still wants its commitment_signed
7122                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
7123                 } else if messages_delivered == 4 {
7124                         // nodes[1] still wants its final RAA
7125                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
7126                 } else if messages_delivered == 5 {
7127                         // Everything was delivered...
7128                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7129                 }
7130
7131                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7132                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7133                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7134
7135                 // Channel should still work fine...
7136                 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
7137                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
7138         }
7139
7140         #[test]
7141         fn test_drop_messages_peer_disconnect_a() {
7142                 do_test_drop_messages_peer_disconnect(0);
7143                 do_test_drop_messages_peer_disconnect(1);
7144                 do_test_drop_messages_peer_disconnect(2);
7145                 do_test_drop_messages_peer_disconnect(3);
7146         }
7147
7148         #[test]
7149         fn test_drop_messages_peer_disconnect_b() {
7150                 do_test_drop_messages_peer_disconnect(4);
7151                 do_test_drop_messages_peer_disconnect(5);
7152                 do_test_drop_messages_peer_disconnect(6);
7153         }
7154
7155         #[test]
7156         fn test_funding_peer_disconnect() {
7157                 // Test that we can lock in our funding tx while disconnected
7158                 let nodes = create_network(2);
7159                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
7160
7161                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7162                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7163
7164                 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
7165                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
7166                 assert_eq!(events_1.len(), 1);
7167                 match events_1[0] {
7168                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
7169                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7170                         },
7171                         _ => panic!("Unexpected event"),
7172                 }
7173
7174                 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7175
7176                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7177                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7178
7179                 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
7180                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7181                 assert_eq!(events_2.len(), 2);
7182                 match events_2[0] {
7183                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
7184                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7185                         },
7186                         _ => panic!("Unexpected event"),
7187                 }
7188                 match events_2[1] {
7189                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
7190                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7191                         },
7192                         _ => panic!("Unexpected event"),
7193                 }
7194
7195                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7196
7197                 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
7198                 // rebroadcasting announcement_signatures upon reconnect.
7199
7200                 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();
7201                 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
7202                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
7203         }
7204
7205         #[test]
7206         fn test_drop_messages_peer_disconnect_dual_htlc() {
7207                 // Test that we can handle reconnecting when both sides of a channel have pending
7208                 // commitment_updates when we disconnect.
7209                 let mut nodes = create_network(2);
7210                 create_announced_chan_between_nodes(&nodes, 0, 1);
7211
7212                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7213
7214                 // Now try to send a second payment which will fail to send
7215                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7216                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
7217
7218                 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
7219                 check_added_monitors!(nodes[0], 1);
7220
7221                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
7222                 assert_eq!(events_1.len(), 1);
7223                 match events_1[0] {
7224                         MessageSendEvent::UpdateHTLCs { .. } => {},
7225                         _ => panic!("Unexpected event"),
7226                 }
7227
7228                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
7229                 check_added_monitors!(nodes[1], 1);
7230
7231                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7232                 assert_eq!(events_2.len(), 1);
7233                 match events_2[0] {
7234                         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 } } => {
7235                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7236                                 assert!(update_add_htlcs.is_empty());
7237                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7238                                 assert!(update_fail_htlcs.is_empty());
7239                                 assert!(update_fail_malformed_htlcs.is_empty());
7240                                 assert!(update_fee.is_none());
7241
7242                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
7243                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
7244                                 assert_eq!(events_3.len(), 1);
7245                                 match events_3[0] {
7246                                         Event::PaymentSent { ref payment_preimage } => {
7247                                                 assert_eq!(*payment_preimage, payment_preimage_1);
7248                                         },
7249                                         _ => panic!("Unexpected event"),
7250                                 }
7251
7252                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
7253                                 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7254                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7255                                 check_added_monitors!(nodes[0], 1);
7256                         },
7257                         _ => panic!("Unexpected event"),
7258                 }
7259
7260                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7261                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7262
7263                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7264                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7265                 assert_eq!(reestablish_1.len(), 1);
7266                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7267                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7268                 assert_eq!(reestablish_2.len(), 1);
7269
7270                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7271                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7272                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7273                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7274
7275                 assert!(as_resp.0.is_none());
7276                 assert!(bs_resp.0.is_none());
7277
7278                 assert!(bs_resp.1.is_none());
7279                 assert!(bs_resp.2.is_none());
7280
7281                 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
7282
7283                 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
7284                 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
7285                 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
7286                 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
7287                 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
7288                 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();
7289                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
7290                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7291                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7292                 check_added_monitors!(nodes[1], 1);
7293
7294                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
7295                 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7296                 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
7297                 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
7298                 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
7299                 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
7300                 assert!(bs_second_commitment_signed.update_fee.is_none());
7301                 check_added_monitors!(nodes[1], 1);
7302
7303                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
7304                 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7305                 assert!(as_commitment_signed.update_add_htlcs.is_empty());
7306                 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
7307                 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
7308                 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
7309                 assert!(as_commitment_signed.update_fee.is_none());
7310                 check_added_monitors!(nodes[0], 1);
7311
7312                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
7313                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7314                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7315                 check_added_monitors!(nodes[0], 1);
7316
7317                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
7318                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7319                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7320                 check_added_monitors!(nodes[1], 1);
7321
7322                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
7323                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7324                 check_added_monitors!(nodes[1], 1);
7325
7326                 let events_4 = nodes[1].node.get_and_clear_pending_events();
7327                 assert_eq!(events_4.len(), 1);
7328                 match events_4[0] {
7329                         Event::PendingHTLCsForwardable { .. } => { },
7330                         _ => panic!("Unexpected event"),
7331                 };
7332
7333                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
7334                 nodes[1].node.process_pending_htlc_forwards();
7335
7336                 let events_5 = nodes[1].node.get_and_clear_pending_events();
7337                 assert_eq!(events_5.len(), 1);
7338                 match events_5[0] {
7339                         Event::PaymentReceived { ref payment_hash, amt: _ } => {
7340                                 assert_eq!(payment_hash_2, *payment_hash);
7341                         },
7342                         _ => panic!("Unexpected event"),
7343                 }
7344
7345                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
7346                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7347                 check_added_monitors!(nodes[0], 1);
7348
7349                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
7350         }
7351
7352         #[test]
7353         fn test_simple_monitor_permanent_update_fail() {
7354                 // Test that we handle a simple permanent monitor update failure
7355                 let mut nodes = create_network(2);
7356                 create_announced_chan_between_nodes(&nodes, 0, 1);
7357
7358                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7359                 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
7360
7361                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
7362                 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
7363                 check_added_monitors!(nodes[0], 1);
7364
7365                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
7366                 assert_eq!(events_1.len(), 2);
7367                 match events_1[0] {
7368                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7369                         _ => panic!("Unexpected event"),
7370                 };
7371                 match events_1[1] {
7372                         MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
7373                         _ => panic!("Unexpected event"),
7374                 };
7375
7376                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
7377                 // PaymentFailed event
7378
7379                 assert_eq!(nodes[0].node.list_channels().len(), 0);
7380         }
7381
7382         fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
7383                 // Test that we can recover from a simple temporary monitor update failure optionally with
7384                 // a disconnect in between
7385                 let mut nodes = create_network(2);
7386                 create_announced_chan_between_nodes(&nodes, 0, 1);
7387
7388                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7389                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
7390
7391                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7392                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
7393                 check_added_monitors!(nodes[0], 1);
7394
7395                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7396                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7397                 assert_eq!(nodes[0].node.list_channels().len(), 1);
7398
7399                 if disconnect {
7400                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7401                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7402                         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7403                 }
7404
7405                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
7406                 nodes[0].node.test_restore_channel_monitor();
7407                 check_added_monitors!(nodes[0], 1);
7408
7409                 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
7410                 assert_eq!(events_2.len(), 1);
7411                 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
7412                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
7413                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
7414                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7415
7416                 expect_pending_htlcs_forwardable!(nodes[1]);
7417
7418                 let events_3 = nodes[1].node.get_and_clear_pending_events();
7419                 assert_eq!(events_3.len(), 1);
7420                 match events_3[0] {
7421                         Event::PaymentReceived { ref payment_hash, amt } => {
7422                                 assert_eq!(payment_hash_1, *payment_hash);
7423                                 assert_eq!(amt, 1000000);
7424                         },
7425                         _ => panic!("Unexpected event"),
7426                 }
7427
7428                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
7429
7430                 // Now set it to failed again...
7431                 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
7432                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7433                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
7434                 check_added_monitors!(nodes[0], 1);
7435
7436                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7437                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7438                 assert_eq!(nodes[0].node.list_channels().len(), 1);
7439
7440                 if disconnect {
7441                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7442                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7443                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7444                 }
7445
7446                 // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
7447                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
7448                 nodes[0].node.test_restore_channel_monitor();
7449                 check_added_monitors!(nodes[0], 1);
7450
7451                 let events_5 = nodes[0].node.get_and_clear_pending_msg_events();
7452                 assert_eq!(events_5.len(), 1);
7453                 match events_5[0] {
7454                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7455                         _ => panic!("Unexpected event"),
7456                 }
7457
7458                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
7459                 // PaymentFailed event
7460
7461                 assert_eq!(nodes[0].node.list_channels().len(), 0);
7462         }
7463
7464         #[test]
7465         fn test_simple_monitor_temporary_update_fail() {
7466                 do_test_simple_monitor_temporary_update_fail(false);
7467                 do_test_simple_monitor_temporary_update_fail(true);
7468         }
7469
7470         fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
7471                 let disconnect_flags = 8 | 16;
7472
7473                 // Test that we can recover from a temporary monitor update failure with some in-flight
7474                 // HTLCs going on at the same time potentially with some disconnection thrown in.
7475                 // * First we route a payment, then get a temporary monitor update failure when trying to
7476                 //   route a second payment. We then claim the first payment.
7477                 // * If disconnect_count is set, we will disconnect at this point (which is likely as
7478                 //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
7479                 //   the ChannelMonitor on a watchtower).
7480                 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
7481                 //   immediately, otherwise we wait sconnect and deliver them via the reconnect
7482                 //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
7483                 //   disconnect_count & !disconnect_flags is 0).
7484                 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
7485                 //   through message sending, potentially disconnect/reconnecting multiple times based on
7486                 //   disconnect_count, to get the update_fulfill_htlc through.
7487                 // * We then walk through more message exchanges to get the original update_add_htlc
7488                 //   through, swapping message ordering based on disconnect_count & 8 and optionally
7489                 //   disconnect/reconnecting based on disconnect_count.
7490                 let mut nodes = create_network(2);
7491                 create_announced_chan_between_nodes(&nodes, 0, 1);
7492
7493                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7494
7495                 // Now try to send a second payment which will fail to send
7496                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7497                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
7498
7499                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7500                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
7501                 check_added_monitors!(nodes[0], 1);
7502
7503                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7504                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7505                 assert_eq!(nodes[0].node.list_channels().len(), 1);
7506
7507                 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
7508                 // but nodes[0] won't respond since it is frozen.
7509                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
7510                 check_added_monitors!(nodes[1], 1);
7511                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7512                 assert_eq!(events_2.len(), 1);
7513                 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
7514                         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 } } => {
7515                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7516                                 assert!(update_add_htlcs.is_empty());
7517                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7518                                 assert!(update_fail_htlcs.is_empty());
7519                                 assert!(update_fail_malformed_htlcs.is_empty());
7520                                 assert!(update_fee.is_none());
7521
7522                                 if (disconnect_count & 16) == 0 {
7523                                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
7524                                         let events_3 = nodes[0].node.get_and_clear_pending_events();
7525                                         assert_eq!(events_3.len(), 1);
7526                                         match events_3[0] {
7527                                                 Event::PaymentSent { ref payment_preimage } => {
7528                                                         assert_eq!(*payment_preimage, payment_preimage_1);
7529                                                 },
7530                                                 _ => panic!("Unexpected event"),
7531                                         }
7532
7533                                         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) {
7534                                                 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
7535                                         } else { panic!(); }
7536                                 }
7537
7538                                 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
7539                         },
7540                         _ => panic!("Unexpected event"),
7541                 };
7542
7543                 if disconnect_count & !disconnect_flags > 0 {
7544                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7545                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7546                 }
7547
7548                 // Now fix monitor updating...
7549                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
7550                 nodes[0].node.test_restore_channel_monitor();
7551                 check_added_monitors!(nodes[0], 1);
7552
7553                 macro_rules! disconnect_reconnect_peers { () => { {
7554                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7555                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7556
7557                         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7558                         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7559                         assert_eq!(reestablish_1.len(), 1);
7560                         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7561                         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7562                         assert_eq!(reestablish_2.len(), 1);
7563
7564                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7565                         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7566                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7567                         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7568
7569                         assert!(as_resp.0.is_none());
7570                         assert!(bs_resp.0.is_none());
7571
7572                         (reestablish_1, reestablish_2, as_resp, bs_resp)
7573                 } } }
7574
7575                 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
7576                         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7577                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7578
7579                         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7580                         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7581                         assert_eq!(reestablish_1.len(), 1);
7582                         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7583                         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7584                         assert_eq!(reestablish_2.len(), 1);
7585
7586                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7587                         check_added_monitors!(nodes[0], 0);
7588                         let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7589                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7590                         check_added_monitors!(nodes[1], 0);
7591                         let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7592
7593                         assert!(as_resp.0.is_none());
7594                         assert!(bs_resp.0.is_none());
7595
7596                         assert!(bs_resp.1.is_none());
7597                         if (disconnect_count & 16) == 0 {
7598                                 assert!(bs_resp.2.is_none());
7599
7600                                 assert!(as_resp.1.is_some());
7601                                 assert!(as_resp.2.is_some());
7602                                 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
7603                         } else {
7604                                 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
7605                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
7606                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
7607                                 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
7608                                 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
7609                                 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
7610
7611                                 assert!(as_resp.1.is_none());
7612
7613                                 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();
7614                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
7615                                 assert_eq!(events_3.len(), 1);
7616                                 match events_3[0] {
7617                                         Event::PaymentSent { ref payment_preimage } => {
7618                                                 assert_eq!(*payment_preimage, payment_preimage_1);
7619                                         },
7620                                         _ => panic!("Unexpected event"),
7621                                 }
7622
7623                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
7624                                 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7625                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7626                                 check_added_monitors!(nodes[0], 1);
7627
7628                                 as_resp.1 = Some(as_resp_raa);
7629                                 bs_resp.2 = None;
7630                         }
7631
7632                         if disconnect_count & !disconnect_flags > 1 {
7633                                 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
7634
7635                                 if (disconnect_count & 16) == 0 {
7636                                         assert!(reestablish_1 == second_reestablish_1);
7637                                         assert!(reestablish_2 == second_reestablish_2);
7638                                 }
7639                                 assert!(as_resp == second_as_resp);
7640                                 assert!(bs_resp == second_bs_resp);
7641                         }
7642
7643                         (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
7644                 } else {
7645                         let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
7646                         assert_eq!(events_4.len(), 2);
7647                         (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
7648                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
7649                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7650                                         msg.clone()
7651                                 },
7652                                 _ => panic!("Unexpected event"),
7653                         })
7654                 };
7655
7656                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
7657
7658                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
7659                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
7660                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7661                 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
7662                 check_added_monitors!(nodes[1], 1);
7663
7664                 if disconnect_count & !disconnect_flags > 2 {
7665                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7666
7667                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
7668                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
7669
7670                         assert!(as_resp.2.is_none());
7671                         assert!(bs_resp.2.is_none());
7672                 }
7673
7674                 let as_commitment_update;
7675                 let bs_second_commitment_update;
7676
7677                 macro_rules! handle_bs_raa { () => {
7678                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
7679                         as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7680                         assert!(as_commitment_update.update_add_htlcs.is_empty());
7681                         assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
7682                         assert!(as_commitment_update.update_fail_htlcs.is_empty());
7683                         assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
7684                         assert!(as_commitment_update.update_fee.is_none());
7685                         check_added_monitors!(nodes[0], 1);
7686                 } }
7687
7688                 macro_rules! handle_initial_raa { () => {
7689                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
7690                         bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7691                         assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
7692                         assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
7693                         assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
7694                         assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
7695                         assert!(bs_second_commitment_update.update_fee.is_none());
7696                         check_added_monitors!(nodes[1], 1);
7697                 } }
7698
7699                 if (disconnect_count & 8) == 0 {
7700                         handle_bs_raa!();
7701
7702                         if disconnect_count & !disconnect_flags > 3 {
7703                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7704
7705                                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
7706                                 assert!(bs_resp.1.is_none());
7707
7708                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7709                                 assert!(bs_resp.2.is_none());
7710
7711                                 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
7712                         }
7713
7714                         handle_initial_raa!();
7715
7716                         if disconnect_count & !disconnect_flags > 4 {
7717                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7718
7719                                 assert!(as_resp.1.is_none());
7720                                 assert!(bs_resp.1.is_none());
7721
7722                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7723                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7724                         }
7725                 } else {
7726                         handle_initial_raa!();
7727
7728                         if disconnect_count & !disconnect_flags > 3 {
7729                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7730
7731                                 assert!(as_resp.1.is_none());
7732                                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
7733
7734                                 assert!(as_resp.2.is_none());
7735                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7736
7737                                 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
7738                         }
7739
7740                         handle_bs_raa!();
7741
7742                         if disconnect_count & !disconnect_flags > 4 {
7743                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7744
7745                                 assert!(as_resp.1.is_none());
7746                                 assert!(bs_resp.1.is_none());
7747
7748                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7749                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7750                         }
7751                 }
7752
7753                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
7754                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7755                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7756                 check_added_monitors!(nodes[0], 1);
7757
7758                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
7759                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7760                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7761                 check_added_monitors!(nodes[1], 1);
7762
7763                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
7764                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7765                 check_added_monitors!(nodes[1], 1);
7766
7767                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
7768                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7769                 check_added_monitors!(nodes[0], 1);
7770
7771                 expect_pending_htlcs_forwardable!(nodes[1]);
7772
7773                 let events_5 = nodes[1].node.get_and_clear_pending_events();
7774                 assert_eq!(events_5.len(), 1);
7775                 match events_5[0] {
7776                         Event::PaymentReceived { ref payment_hash, amt } => {
7777                                 assert_eq!(payment_hash_2, *payment_hash);
7778                                 assert_eq!(amt, 1000000);
7779                         },
7780                         _ => panic!("Unexpected event"),
7781                 }
7782
7783                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
7784         }
7785
7786         #[test]
7787         fn test_monitor_temporary_update_fail_a() {
7788                 do_test_monitor_temporary_update_fail(0);
7789                 do_test_monitor_temporary_update_fail(1);
7790                 do_test_monitor_temporary_update_fail(2);
7791                 do_test_monitor_temporary_update_fail(3);
7792                 do_test_monitor_temporary_update_fail(4);
7793                 do_test_monitor_temporary_update_fail(5);
7794         }
7795
7796         #[test]
7797         fn test_monitor_temporary_update_fail_b() {
7798                 do_test_monitor_temporary_update_fail(2 | 8);
7799                 do_test_monitor_temporary_update_fail(3 | 8);
7800                 do_test_monitor_temporary_update_fail(4 | 8);
7801                 do_test_monitor_temporary_update_fail(5 | 8);
7802         }
7803
7804         #[test]
7805         fn test_monitor_temporary_update_fail_c() {
7806                 do_test_monitor_temporary_update_fail(1 | 16);
7807                 do_test_monitor_temporary_update_fail(2 | 16);
7808                 do_test_monitor_temporary_update_fail(3 | 16);
7809                 do_test_monitor_temporary_update_fail(2 | 8 | 16);
7810                 do_test_monitor_temporary_update_fail(3 | 8 | 16);
7811         }
7812
7813         #[test]
7814         fn test_monitor_update_fail_cs() {
7815                 // Tests handling of a monitor update failure when processing an incoming commitment_signed
7816                 let mut nodes = create_network(2);
7817                 create_announced_chan_between_nodes(&nodes, 0, 1);
7818
7819                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7820                 let (payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7821                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
7822                 check_added_monitors!(nodes[0], 1);
7823
7824                 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7825                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
7826
7827                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7828                 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg).unwrap_err() {
7829                         assert_eq!(err, "Failed to update ChannelMonitor");
7830                 } else { panic!(); }
7831                 check_added_monitors!(nodes[1], 1);
7832                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7833
7834                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
7835                 nodes[1].node.test_restore_channel_monitor();
7836                 check_added_monitors!(nodes[1], 1);
7837                 let responses = nodes[1].node.get_and_clear_pending_msg_events();
7838                 assert_eq!(responses.len(), 2);
7839
7840                 match responses[0] {
7841                         MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
7842                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7843                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg).unwrap();
7844                                 check_added_monitors!(nodes[0], 1);
7845                         },
7846                         _ => panic!("Unexpected event"),
7847                 }
7848                 match responses[1] {
7849                         MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
7850                                 assert!(updates.update_add_htlcs.is_empty());
7851                                 assert!(updates.update_fulfill_htlcs.is_empty());
7852                                 assert!(updates.update_fail_htlcs.is_empty());
7853                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7854                                 assert!(updates.update_fee.is_none());
7855                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7856
7857                                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7858                                 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed).unwrap_err() {
7859                                         assert_eq!(err, "Failed to update ChannelMonitor");
7860                                 } else { panic!(); }
7861                                 check_added_monitors!(nodes[0], 1);
7862                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7863                         },
7864                         _ => panic!("Unexpected event"),
7865                 }
7866
7867                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
7868                 nodes[0].node.test_restore_channel_monitor();
7869                 check_added_monitors!(nodes[0], 1);
7870
7871                 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7872                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa).unwrap();
7873                 check_added_monitors!(nodes[1], 1);
7874
7875                 let mut events = nodes[1].node.get_and_clear_pending_events();
7876                 assert_eq!(events.len(), 1);
7877                 match events[0] {
7878                         Event::PendingHTLCsForwardable { .. } => { },
7879                         _ => panic!("Unexpected event"),
7880                 };
7881                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
7882                 nodes[1].node.process_pending_htlc_forwards();
7883
7884                 events = nodes[1].node.get_and_clear_pending_events();
7885                 assert_eq!(events.len(), 1);
7886                 match events[0] {
7887                         Event::PaymentReceived { payment_hash, amt } => {
7888                                 assert_eq!(payment_hash, our_payment_hash);
7889                                 assert_eq!(amt, 1000000);
7890                         },
7891                         _ => panic!("Unexpected event"),
7892                 };
7893
7894                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
7895         }
7896
7897         fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
7898                 // Tests handling of a monitor update failure when processing an incoming RAA
7899                 let mut nodes = create_network(3);
7900                 create_announced_chan_between_nodes(&nodes, 0, 1);
7901                 create_announced_chan_between_nodes(&nodes, 1, 2);
7902
7903                 // Rebalance a bit so that we can send backwards from 2 to 1.
7904                 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
7905
7906                 // Route a first payment that we'll fail backwards
7907                 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
7908
7909                 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
7910                 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1, PaymentFailReason::PreimageUnknown));
7911                 check_added_monitors!(nodes[2], 1);
7912
7913                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
7914                 assert!(updates.update_add_htlcs.is_empty());
7915                 assert!(updates.update_fulfill_htlcs.is_empty());
7916                 assert_eq!(updates.update_fail_htlcs.len(), 1);
7917                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7918                 assert!(updates.update_fee.is_none());
7919                 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
7920
7921                 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
7922                 check_added_monitors!(nodes[0], 0);
7923
7924                 // While the second channel is AwaitingRAA, forward a second payment to get it into the
7925                 // holding cell.
7926                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
7927                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7928                 nodes[0].node.send_payment(route, payment_hash_2).unwrap();
7929                 check_added_monitors!(nodes[0], 1);
7930
7931                 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7932                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
7933                 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
7934
7935                 let events_1 = nodes[1].node.get_and_clear_pending_events();
7936                 assert_eq!(events_1.len(), 1);
7937                 match events_1[0] {
7938                         Event::PendingHTLCsForwardable { .. } => { },
7939                         _ => panic!("Unexpected event"),
7940                 };
7941
7942                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
7943                 nodes[1].node.process_pending_htlc_forwards();
7944                 check_added_monitors!(nodes[1], 0);
7945                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7946
7947                 // Now fail monitor updating.
7948                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7949                 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap_err() {
7950                         assert_eq!(err, "Failed to update ChannelMonitor");
7951                 } else { panic!(); }
7952                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
7953                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7954                 check_added_monitors!(nodes[1], 1);
7955
7956                 // Attempt to forward a third payment but fail due to the second channel being unavailable
7957                 // for forwarding.
7958
7959                 let (_, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
7960                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7961                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
7962                 check_added_monitors!(nodes[0], 1);
7963
7964                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(()); // We succeed in updating the monitor for the first channel
7965                 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7966                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
7967                 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
7968                 check_added_monitors!(nodes[1], 0);
7969
7970                 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7971                 assert_eq!(events_2.len(), 1);
7972                 match events_2.remove(0) {
7973                         MessageSendEvent::UpdateHTLCs { node_id, updates } => {
7974                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7975                                 assert!(updates.update_fulfill_htlcs.is_empty());
7976                                 assert_eq!(updates.update_fail_htlcs.len(), 1);
7977                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7978                                 assert!(updates.update_add_htlcs.is_empty());
7979                                 assert!(updates.update_fee.is_none());
7980
7981                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
7982                                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
7983
7984                                 let events = nodes[0].node.get_and_clear_pending_events();
7985                                 assert_eq!(events.len(), 1);
7986                                 if let Event::PaymentFailed { payment_hash, rejected_by_dest } = events[0] {
7987                                         assert_eq!(payment_hash, payment_hash_3);
7988                                         assert!(!rejected_by_dest);
7989                                 } else { panic!("Unexpected event!"); }
7990                         },
7991                         _ => panic!("Unexpected event type!"),
7992                 };
7993
7994                 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
7995                         // Try to route another payment backwards from 2 to make sure 1 holds off on responding
7996                         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[0]);
7997                         let route = nodes[2].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7998                         nodes[2].node.send_payment(route, payment_hash_4).unwrap();
7999                         check_added_monitors!(nodes[2], 1);
8000
8001                         send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
8002                         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
8003                         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::IgnoreError) }) = nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg) {
8004                                 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
8005                         } else { panic!(); }
8006                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8007                         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
8008                         (Some(payment_preimage_4), Some(payment_hash_4))
8009                 } else { (None, None) };
8010
8011                 // Restore monitor updating, ensuring we immediately get a fail-back update and a
8012                 // update_add update.
8013                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
8014                 nodes[1].node.test_restore_channel_monitor();
8015                 check_added_monitors!(nodes[1], 2);
8016
8017                 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
8018                 if test_ignore_second_cs {
8019                         assert_eq!(events_3.len(), 3);
8020                 } else {
8021                         assert_eq!(events_3.len(), 2);
8022                 }
8023
8024                 // Note that the ordering of the events for different nodes is non-prescriptive, though the
8025                 // ordering of the two events that both go to nodes[2] have to stay in the same order.
8026                 let messages_a = match events_3.pop().unwrap() {
8027                         MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
8028                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8029                                 assert!(updates.update_fulfill_htlcs.is_empty());
8030                                 assert_eq!(updates.update_fail_htlcs.len(), 1);
8031                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
8032                                 assert!(updates.update_add_htlcs.is_empty());
8033                                 assert!(updates.update_fee.is_none());
8034                                 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
8035                         },
8036                         _ => panic!("Unexpected event type!"),
8037                 };
8038                 let raa = if test_ignore_second_cs {
8039                         match events_3.remove(1) {
8040                                 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
8041                                         assert_eq!(node_id, nodes[2].node.get_our_node_id());
8042                                         Some(msg.clone())
8043                                 },
8044                                 _ => panic!("Unexpected event"),
8045                         }
8046                 } else { None };
8047                 let send_event_b = SendEvent::from_event(events_3.remove(0));
8048                 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
8049
8050                 // Now deliver the new messages...
8051
8052                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0).unwrap();
8053                 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
8054                 let events_4 = nodes[0].node.get_and_clear_pending_events();
8055                 assert_eq!(events_4.len(), 1);
8056                 if let Event::PaymentFailed { payment_hash, rejected_by_dest } = events_4[0] {
8057                         assert_eq!(payment_hash, payment_hash_1);
8058                         assert!(rejected_by_dest);
8059                 } else { panic!("Unexpected event!"); }
8060
8061                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]).unwrap();
8062                 if test_ignore_second_cs {
8063                         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg).unwrap();
8064                         check_added_monitors!(nodes[2], 1);
8065                         let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
8066                         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap()).unwrap();
8067                         check_added_monitors!(nodes[2], 1);
8068                         let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8069                         assert!(bs_cs.update_add_htlcs.is_empty());
8070                         assert!(bs_cs.update_fail_htlcs.is_empty());
8071                         assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
8072                         assert!(bs_cs.update_fulfill_htlcs.is_empty());
8073                         assert!(bs_cs.update_fee.is_none());
8074
8075                         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
8076                         check_added_monitors!(nodes[1], 1);
8077                         let as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
8078                         assert!(as_cs.update_add_htlcs.is_empty());
8079                         assert!(as_cs.update_fail_htlcs.is_empty());
8080                         assert!(as_cs.update_fail_malformed_htlcs.is_empty());
8081                         assert!(as_cs.update_fulfill_htlcs.is_empty());
8082                         assert!(as_cs.update_fee.is_none());
8083
8084                         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed).unwrap();
8085                         check_added_monitors!(nodes[1], 1);
8086                         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
8087
8088                         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
8089                         check_added_monitors!(nodes[2], 1);
8090                         let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
8091
8092                         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
8093                         check_added_monitors!(nodes[2], 1);
8094                         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
8095
8096                         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa).unwrap();
8097                         check_added_monitors!(nodes[1], 1);
8098                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8099                 } else {
8100                         commitment_signed_dance!(nodes[2], nodes[1], send_event_b.commitment_msg, false);
8101                 }
8102
8103                 let events_5 = nodes[2].node.get_and_clear_pending_events();
8104                 assert_eq!(events_5.len(), 1);
8105                 match events_5[0] {
8106                         Event::PendingHTLCsForwardable { .. } => { },
8107                         _ => panic!("Unexpected event"),
8108                 };
8109
8110                 nodes[2].node.channel_state.lock().unwrap().next_forward = Instant::now();
8111                 nodes[2].node.process_pending_htlc_forwards();
8112
8113                 let events_6 = nodes[2].node.get_and_clear_pending_events();
8114                 assert_eq!(events_6.len(), 1);
8115                 match events_6[0] {
8116                         Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
8117                         _ => panic!("Unexpected event"),
8118                 };
8119
8120                 if test_ignore_second_cs {
8121                         let events_7 = nodes[1].node.get_and_clear_pending_events();
8122                         assert_eq!(events_7.len(), 1);
8123                         match events_7[0] {
8124                                 Event::PendingHTLCsForwardable { .. } => { },
8125                                 _ => panic!("Unexpected event"),
8126                         };
8127
8128                         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
8129                         nodes[1].node.process_pending_htlc_forwards();
8130                         check_added_monitors!(nodes[1], 1);
8131
8132                         send_event = SendEvent::from_node(&nodes[1]);
8133                         assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
8134                         assert_eq!(send_event.msgs.len(), 1);
8135                         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
8136                         commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
8137
8138                         let events_8 = nodes[0].node.get_and_clear_pending_events();
8139                         assert_eq!(events_8.len(), 1);
8140                         match events_8[0] {
8141                                 Event::PendingHTLCsForwardable { .. } => { },
8142                                 _ => panic!("Unexpected event"),
8143                         };
8144
8145                         nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
8146                         nodes[0].node.process_pending_htlc_forwards();
8147
8148                         let events_9 = nodes[0].node.get_and_clear_pending_events();
8149                         assert_eq!(events_9.len(), 1);
8150                         match events_9[0] {
8151                                 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
8152                                 _ => panic!("Unexpected event"),
8153                         };
8154                         claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
8155                 }
8156
8157                 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
8158         }
8159
8160         #[test]
8161         fn test_monitor_update_fail_raa() {
8162                 do_test_monitor_update_fail_raa(false);
8163                 do_test_monitor_update_fail_raa(true);
8164         }
8165
8166         #[test]
8167         fn test_monitor_update_fail_reestablish() {
8168                 // Simple test for message retransmission after monitor update failure on
8169                 // channel_reestablish generating a monitor update (which comes from freeing holding cell
8170                 // HTLCs).
8171                 let mut nodes = create_network(3);
8172                 create_announced_chan_between_nodes(&nodes, 0, 1);
8173                 create_announced_chan_between_nodes(&nodes, 1, 2);
8174
8175                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
8176
8177                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8178                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8179
8180                 assert!(nodes[2].node.claim_funds(our_payment_preimage));
8181                 check_added_monitors!(nodes[2], 1);
8182                 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8183                 assert!(updates.update_add_htlcs.is_empty());
8184                 assert!(updates.update_fail_htlcs.is_empty());
8185                 assert!(updates.update_fail_malformed_htlcs.is_empty());
8186                 assert!(updates.update_fee.is_none());
8187                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8188                 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
8189                 check_added_monitors!(nodes[1], 1);
8190                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8191                 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
8192
8193                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
8194                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
8195                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
8196
8197                 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
8198                 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8199
8200                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
8201
8202                 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish).unwrap_err() {
8203                         assert_eq!(err, "Failed to update ChannelMonitor");
8204                 } else { panic!(); }
8205                 check_added_monitors!(nodes[1], 1);
8206
8207                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8208                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8209
8210                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
8211                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
8212
8213                 assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
8214                 assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
8215
8216                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
8217
8218                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish).unwrap();
8219                 check_added_monitors!(nodes[1], 0);
8220                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8221
8222                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
8223                 nodes[1].node.test_restore_channel_monitor();
8224                 check_added_monitors!(nodes[1], 1);
8225
8226                 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8227                 assert!(updates.update_add_htlcs.is_empty());
8228                 assert!(updates.update_fail_htlcs.is_empty());
8229                 assert!(updates.update_fail_malformed_htlcs.is_empty());
8230                 assert!(updates.update_fee.is_none());
8231                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8232                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
8233                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
8234
8235                 let events = nodes[0].node.get_and_clear_pending_events();
8236                 assert_eq!(events.len(), 1);
8237                 match events[0] {
8238                         Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
8239                         _ => panic!("Unexpected event"),
8240                 }
8241         }
8242
8243         #[test]
8244         fn test_invalid_channel_announcement() {
8245                 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
8246                 let secp_ctx = Secp256k1::new();
8247                 let nodes = create_network(2);
8248
8249                 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
8250
8251                 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8252                 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
8253                 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
8254                 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
8255
8256                 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 } );
8257
8258                 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
8259                 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
8260
8261                 let as_network_key = nodes[0].node.get_our_node_id();
8262                 let bs_network_key = nodes[1].node.get_our_node_id();
8263
8264                 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
8265
8266                 let mut chan_announcement;
8267
8268                 macro_rules! dummy_unsigned_msg {
8269                         () => {
8270                                 msgs::UnsignedChannelAnnouncement {
8271                                         features: msgs::GlobalFeatures::new(),
8272                                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
8273                                         short_channel_id: as_chan.get_short_channel_id().unwrap(),
8274                                         node_id_1: if were_node_one { as_network_key } else { bs_network_key },
8275                                         node_id_2: if were_node_one { bs_network_key } else { as_network_key },
8276                                         bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
8277                                         bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
8278                                         excess_data: Vec::new(),
8279                                 };
8280                         }
8281                 }
8282
8283                 macro_rules! sign_msg {
8284                         ($unsigned_msg: expr) => {
8285                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
8286                                 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
8287                                 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
8288                                 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
8289                                 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
8290                                 chan_announcement = msgs::ChannelAnnouncement {
8291                                         node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
8292                                         node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
8293                                         bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
8294                                         bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
8295                                         contents: $unsigned_msg
8296                                 }
8297                         }
8298                 }
8299
8300                 let unsigned_msg = dummy_unsigned_msg!();
8301                 sign_msg!(unsigned_msg);
8302                 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
8303                 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 } );
8304
8305                 // Configured with Network::Testnet
8306                 let mut unsigned_msg = dummy_unsigned_msg!();
8307                 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
8308                 sign_msg!(unsigned_msg);
8309                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
8310
8311                 let mut unsigned_msg = dummy_unsigned_msg!();
8312                 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
8313                 sign_msg!(unsigned_msg);
8314                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
8315         }
8316
8317         struct VecWriter(Vec<u8>);
8318         impl Writer for VecWriter {
8319                 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
8320                         self.0.extend_from_slice(buf);
8321                         Ok(())
8322                 }
8323                 fn size_hint(&mut self, size: usize) {
8324                         self.0.reserve_exact(size);
8325                 }
8326         }
8327
8328         #[test]
8329         fn test_no_txn_manager_serialize_deserialize() {
8330                 let mut nodes = create_network(2);
8331
8332                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
8333
8334                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8335
8336                 let nodes_0_serialized = nodes[0].node.encode();
8337                 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
8338                 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
8339
8340                 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())));
8341                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
8342                 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
8343                 assert!(chan_0_monitor_read.is_empty());
8344
8345                 let mut nodes_0_read = &nodes_0_serialized[..];
8346                 let config = UserConfig::new();
8347                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
8348                 let (_, nodes_0_deserialized) = {
8349                         let mut channel_monitors = HashMap::new();
8350                         channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
8351                         <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
8352                                 default_config: config,
8353                                 keys_manager,
8354                                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
8355                                 monitor: nodes[0].chan_monitor.clone(),
8356                                 chain_monitor: nodes[0].chain_monitor.clone(),
8357                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
8358                                 logger: Arc::new(test_utils::TestLogger::new()),
8359                                 channel_monitors: &channel_monitors,
8360                         }).unwrap()
8361                 };
8362                 assert!(nodes_0_read.is_empty());
8363
8364                 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
8365                 nodes[0].node = Arc::new(nodes_0_deserialized);
8366                 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
8367                 nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
8368                 assert_eq!(nodes[0].node.list_channels().len(), 1);
8369                 check_added_monitors!(nodes[0], 1);
8370
8371                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
8372                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
8373                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
8374                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
8375
8376                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
8377                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8378                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
8379                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
8380
8381                 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8382                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8383                 for node in nodes.iter() {
8384                         assert!(node.router.handle_channel_announcement(&announcement).unwrap());
8385                         node.router.handle_channel_update(&as_update).unwrap();
8386                         node.router.handle_channel_update(&bs_update).unwrap();
8387                 }
8388
8389                 send_payment(&nodes[0], &[&nodes[1]], 1000000);
8390         }
8391
8392         #[test]
8393         fn test_simple_manager_serialize_deserialize() {
8394                 let mut nodes = create_network(2);
8395                 create_announced_chan_between_nodes(&nodes, 0, 1);
8396
8397                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
8398                 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
8399
8400                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8401
8402                 let nodes_0_serialized = nodes[0].node.encode();
8403                 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
8404                 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
8405
8406                 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())));
8407                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
8408                 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
8409                 assert!(chan_0_monitor_read.is_empty());
8410
8411                 let mut nodes_0_read = &nodes_0_serialized[..];
8412                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
8413                 let (_, nodes_0_deserialized) = {
8414                         let mut channel_monitors = HashMap::new();
8415                         channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
8416                         <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
8417                                 default_config: UserConfig::new(),
8418                                 keys_manager,
8419                                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
8420                                 monitor: nodes[0].chan_monitor.clone(),
8421                                 chain_monitor: nodes[0].chain_monitor.clone(),
8422                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
8423                                 logger: Arc::new(test_utils::TestLogger::new()),
8424                                 channel_monitors: &channel_monitors,
8425                         }).unwrap()
8426                 };
8427                 assert!(nodes_0_read.is_empty());
8428
8429                 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
8430                 nodes[0].node = Arc::new(nodes_0_deserialized);
8431                 check_added_monitors!(nodes[0], 1);
8432
8433                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
8434
8435                 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
8436                 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
8437         }
8438
8439         #[test]
8440         fn test_manager_serialize_deserialize_inconsistent_monitor() {
8441                 // Test deserializing a ChannelManager with a out-of-date ChannelMonitor
8442                 let mut nodes = create_network(4);
8443                 create_announced_chan_between_nodes(&nodes, 0, 1);
8444                 create_announced_chan_between_nodes(&nodes, 2, 0);
8445                 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
8446
8447                 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
8448
8449                 // Serialize the ChannelManager here, but the monitor we keep up-to-date
8450                 let nodes_0_serialized = nodes[0].node.encode();
8451
8452                 route_payment(&nodes[0], &[&nodes[3]], 1000000);
8453                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8454                 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8455                 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8456
8457                 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
8458                 // nodes[3])
8459                 let mut node_0_monitors_serialized = Vec::new();
8460                 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
8461                         let mut writer = VecWriter(Vec::new());
8462                         monitor.1.write_for_disk(&mut writer).unwrap();
8463                         node_0_monitors_serialized.push(writer.0);
8464                 }
8465
8466                 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())));
8467                 let mut node_0_monitors = Vec::new();
8468                 for serialized in node_0_monitors_serialized.iter() {
8469                         let mut read = &serialized[..];
8470                         let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
8471                         assert!(read.is_empty());
8472                         node_0_monitors.push(monitor);
8473                 }
8474
8475                 let mut nodes_0_read = &nodes_0_serialized[..];
8476                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
8477                 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
8478                         default_config: UserConfig::new(),
8479                         keys_manager,
8480                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
8481                         monitor: nodes[0].chan_monitor.clone(),
8482                         chain_monitor: nodes[0].chain_monitor.clone(),
8483                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
8484                         logger: Arc::new(test_utils::TestLogger::new()),
8485                         channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
8486                 }).unwrap();
8487                 assert!(nodes_0_read.is_empty());
8488
8489                 { // Channel close should result in a commitment tx and an HTLC tx
8490                         let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8491                         assert_eq!(txn.len(), 2);
8492                         assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
8493                         assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
8494                 }
8495
8496                 for monitor in node_0_monitors.drain(..) {
8497                         assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
8498                         check_added_monitors!(nodes[0], 1);
8499                 }
8500                 nodes[0].node = Arc::new(nodes_0_deserialized);
8501
8502                 // nodes[1] and nodes[2] have no lost state with nodes[0]...
8503                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
8504                 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
8505                 //... and we can even still claim the payment!
8506                 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
8507
8508                 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
8509                 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8510                 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
8511                 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) {
8512                         assert_eq!(msg.channel_id, channel_id);
8513                 } else { panic!("Unexpected result"); }
8514         }
8515
8516         macro_rules! check_spendable_outputs {
8517                 ($node: expr, $der_idx: expr) => {
8518                         {
8519                                 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
8520                                 let mut txn = Vec::new();
8521                                 for event in events {
8522                                         match event {
8523                                                 Event::SpendableOutputs { ref outputs } => {
8524                                                         for outp in outputs {
8525                                                                 match *outp {
8526                                                                         SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
8527                                                                                 let input = TxIn {
8528                                                                                         previous_output: outpoint.clone(),
8529                                                                                         script_sig: Script::new(),
8530                                                                                         sequence: 0,
8531                                                                                         witness: Vec::new(),
8532                                                                                 };
8533                                                                                 let outp = TxOut {
8534                                                                                         script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
8535                                                                                         value: output.value,
8536                                                                                 };
8537                                                                                 let mut spend_tx = Transaction {
8538                                                                                         version: 2,
8539                                                                                         lock_time: 0,
8540                                                                                         input: vec![input],
8541                                                                                         output: vec![outp],
8542                                                                                 };
8543                                                                                 let secp_ctx = Secp256k1::new();
8544                                                                                 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
8545                                                                                 let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
8546                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
8547                                                                                 let remotesig = secp_ctx.sign(&sighash, key);
8548                                                                                 spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
8549                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
8550                                                                                 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
8551                                                                                 txn.push(spend_tx);
8552                                                                         },
8553                                                                         SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
8554                                                                                 let input = TxIn {
8555                                                                                         previous_output: outpoint.clone(),
8556                                                                                         script_sig: Script::new(),
8557                                                                                         sequence: *to_self_delay as u32,
8558                                                                                         witness: Vec::new(),
8559                                                                                 };
8560                                                                                 let outp = TxOut {
8561                                                                                         script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
8562                                                                                         value: output.value,
8563                                                                                 };
8564                                                                                 let mut spend_tx = Transaction {
8565                                                                                         version: 2,
8566                                                                                         lock_time: 0,
8567                                                                                         input: vec![input],
8568                                                                                         output: vec![outp],
8569                                                                                 };
8570                                                                                 let secp_ctx = Secp256k1::new();
8571                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
8572                                                                                 let local_delaysig = secp_ctx.sign(&sighash, key);
8573                                                                                 spend_tx.input[0].witness.push(local_delaysig.serialize_der(&secp_ctx).to_vec());
8574                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
8575                                                                                 spend_tx.input[0].witness.push(vec!(0));
8576                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
8577                                                                                 txn.push(spend_tx);
8578                                                                         },
8579                                                                         SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
8580                                                                                 let secp_ctx = Secp256k1::new();
8581                                                                                 let input = TxIn {
8582                                                                                         previous_output: outpoint.clone(),
8583                                                                                         script_sig: Script::new(),
8584                                                                                         sequence: 0,
8585                                                                                         witness: Vec::new(),
8586                                                                                 };
8587                                                                                 let outp = TxOut {
8588                                                                                         script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
8589                                                                                         value: output.value,
8590                                                                                 };
8591                                                                                 let mut spend_tx = Transaction {
8592                                                                                         version: 2,
8593                                                                                         lock_time: 0,
8594                                                                                         input: vec![input],
8595                                                                                         output: vec![outp.clone()],
8596                                                                                 };
8597                                                                                 let secret = {
8598                                                                                         match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node.node_seed) {
8599                                                                                                 Ok(master_key) => {
8600                                                                                                         match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
8601                                                                                                                 Ok(key) => key,
8602                                                                                                                 Err(_) => panic!("Your RNG is busted"),
8603                                                                                                         }
8604                                                                                                 }
8605                                                                                                 Err(_) => panic!("Your rng is busted"),
8606                                                                                         }
8607                                                                                 };
8608                                                                                 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
8609                                                                                 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
8610                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
8611                                                                                 let sig = secp_ctx.sign(&sighash, &secret.secret_key);
8612                                                                                 spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
8613                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
8614                                                                                 spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
8615                                                                                 txn.push(spend_tx);
8616                                                                         },
8617                                                                 }
8618                                                         }
8619                                                 },
8620                                                 _ => panic!("Unexpected event"),
8621                                         };
8622                                 }
8623                                 txn
8624                         }
8625                 }
8626         }
8627
8628         #[test]
8629         fn test_claim_sizeable_push_msat() {
8630                 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
8631                 let nodes = create_network(2);
8632
8633                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
8634                 nodes[1].node.force_close_channel(&chan.2);
8635                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8636                 match events[0] {
8637                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8638                         _ => panic!("Unexpected event"),
8639                 }
8640                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8641                 assert_eq!(node_txn.len(), 1);
8642                 check_spends!(node_txn[0], chan.3.clone());
8643                 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
8644
8645                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8646                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
8647                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8648                 assert_eq!(spend_txn.len(), 1);
8649                 check_spends!(spend_txn[0], node_txn[0].clone());
8650         }
8651
8652         #[test]
8653         fn test_claim_on_remote_sizeable_push_msat() {
8654                 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
8655                 // to_remote output is encumbered by a P2WPKH
8656
8657                 let nodes = create_network(2);
8658
8659                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
8660                 nodes[0].node.force_close_channel(&chan.2);
8661                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8662                 match events[0] {
8663                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8664                         _ => panic!("Unexpected event"),
8665                 }
8666                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8667                 assert_eq!(node_txn.len(), 1);
8668                 check_spends!(node_txn[0], chan.3.clone());
8669                 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
8670
8671                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8672                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
8673                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8674                 match events[0] {
8675                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8676                         _ => panic!("Unexpected event"),
8677                 }
8678                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8679                 assert_eq!(spend_txn.len(), 2);
8680                 assert_eq!(spend_txn[0], spend_txn[1]);
8681                 check_spends!(spend_txn[0], node_txn[0].clone());
8682         }
8683
8684         #[test]
8685         fn test_claim_on_remote_revoked_sizeable_push_msat() {
8686                 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
8687                 // to_remote output is encumbered by a P2WPKH
8688
8689                 let nodes = create_network(2);
8690
8691                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
8692                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8693                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
8694                 assert_eq!(revoked_local_txn[0].input.len(), 1);
8695                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8696
8697                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8698                 let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8699                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8700                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8701                 match events[0] {
8702                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8703                         _ => panic!("Unexpected event"),
8704                 }
8705                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8706                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8707                 assert_eq!(spend_txn.len(), 4);
8708                 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
8709                 check_spends!(spend_txn[0], revoked_local_txn[0].clone());
8710                 assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
8711                 check_spends!(spend_txn[1], node_txn[0].clone());
8712         }
8713
8714         #[test]
8715         fn test_static_spendable_outputs_preimage_tx() {
8716                 let nodes = create_network(2);
8717
8718                 // Create some initial channels
8719                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8720
8721                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8722
8723                 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8724                 assert_eq!(commitment_tx[0].input.len(), 1);
8725                 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
8726
8727                 // Settle A's commitment tx on B's chain
8728                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8729                 assert!(nodes[1].node.claim_funds(payment_preimage));
8730                 check_added_monitors!(nodes[1], 1);
8731                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
8732                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8733                 match events[0] {
8734                         MessageSendEvent::UpdateHTLCs { .. } => {},
8735                         _ => panic!("Unexpected event"),
8736                 }
8737                 match events[1] {
8738                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8739                         _ => panic!("Unexepected event"),
8740                 }
8741
8742                 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
8743                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
8744                 check_spends!(node_txn[0], commitment_tx[0].clone());
8745                 assert_eq!(node_txn[0], node_txn[2]);
8746                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8747                 check_spends!(node_txn[1], chan_1.3.clone());
8748
8749                 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
8750                 assert_eq!(spend_txn.len(), 2);
8751                 assert_eq!(spend_txn[0], spend_txn[1]);
8752                 check_spends!(spend_txn[0], node_txn[0].clone());
8753         }
8754
8755         #[test]
8756         fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
8757                 let nodes = create_network(2);
8758
8759                 // Create some initial channels
8760                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8761
8762                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8763                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
8764                 assert_eq!(revoked_local_txn[0].input.len(), 1);
8765                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
8766
8767                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8768
8769                 let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8770                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8771                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8772                 match events[0] {
8773                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8774                         _ => panic!("Unexpected event"),
8775                 }
8776                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8777                 assert_eq!(node_txn.len(), 3);
8778                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
8779                 assert_eq!(node_txn[0].input.len(), 2);
8780                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
8781
8782                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8783                 assert_eq!(spend_txn.len(), 2);
8784                 assert_eq!(spend_txn[0], spend_txn[1]);
8785                 check_spends!(spend_txn[0], node_txn[0].clone());
8786         }
8787
8788         #[test]
8789         fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
8790                 let nodes = create_network(2);
8791
8792                 // Create some initial channels
8793                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8794
8795                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8796                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8797                 assert_eq!(revoked_local_txn[0].input.len(), 1);
8798                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
8799
8800                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8801
8802                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8803                 // A will generate HTLC-Timeout from revoked commitment tx
8804                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8805                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8806                 match events[0] {
8807                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8808                         _ => panic!("Unexpected event"),
8809                 }
8810                 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8811                 assert_eq!(revoked_htlc_txn.len(), 3);
8812                 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
8813                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8814                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8815                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
8816                 check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
8817
8818                 // B will generate justice tx from A's revoked commitment/HTLC tx
8819                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
8820                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8821                 match events[0] {
8822                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8823                         _ => panic!("Unexpected event"),
8824                 }
8825
8826                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8827                 assert_eq!(node_txn.len(), 4);
8828                 assert_eq!(node_txn[3].input.len(), 1);
8829                 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
8830
8831                 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
8832                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8833                 assert_eq!(spend_txn.len(), 3);
8834                 assert_eq!(spend_txn[0], spend_txn[1]);
8835                 check_spends!(spend_txn[0], node_txn[0].clone());
8836                 check_spends!(spend_txn[2], node_txn[3].clone());
8837         }
8838
8839         #[test]
8840         fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
8841                 let nodes = create_network(2);
8842
8843                 // Create some initial channels
8844                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8845
8846                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8847                 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8848                 assert_eq!(revoked_local_txn[0].input.len(), 1);
8849                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
8850
8851                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8852
8853                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8854                 // B will generate HTLC-Success from revoked commitment tx
8855                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8856                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8857                 match events[0] {
8858                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8859                         _ => panic!("Unexpected event"),
8860                 }
8861                 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8862
8863                 assert_eq!(revoked_htlc_txn.len(), 3);
8864                 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
8865                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8866                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8867                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
8868
8869                 // A will generate justice tx from B's revoked commitment/HTLC tx
8870                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
8871                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8872                 match events[0] {
8873                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8874                         _ => panic!("Unexpected event"),
8875                 }
8876
8877                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8878                 assert_eq!(node_txn.len(), 4);
8879                 assert_eq!(node_txn[3].input.len(), 1);
8880                 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
8881
8882                 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
8883                 let spend_txn = check_spendable_outputs!(nodes[0], 1);
8884                 assert_eq!(spend_txn.len(), 5);
8885                 assert_eq!(spend_txn[0], spend_txn[2]);
8886                 assert_eq!(spend_txn[1], spend_txn[3]);
8887                 check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
8888                 check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
8889                 check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
8890         }
8891
8892         #[test]
8893         fn test_onchain_to_onchain_claim() {
8894                 // Test that in case of channel closure, we detect the state of output thanks to
8895                 // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
8896                 // First, have C claim an HTLC against its own latest commitment transaction.
8897                 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
8898                 // channel.
8899                 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
8900                 // gets broadcast.
8901
8902                 let nodes = create_network(3);
8903
8904                 // Create some initial channels
8905                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8906                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
8907
8908                 // Rebalance the network a bit by relaying one payment through all the channels ...
8909                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
8910                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
8911
8912                 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
8913                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8914                 let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
8915                 check_spends!(commitment_tx[0], chan_2.3.clone());
8916                 nodes[2].node.claim_funds(payment_preimage);
8917                 check_added_monitors!(nodes[2], 1);
8918                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8919                 assert!(updates.update_add_htlcs.is_empty());
8920                 assert!(updates.update_fail_htlcs.is_empty());
8921                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8922                 assert!(updates.update_fail_malformed_htlcs.is_empty());
8923
8924                 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
8925                 let events = nodes[2].node.get_and_clear_pending_msg_events();
8926                 assert_eq!(events.len(), 1);
8927                 match events[0] {
8928                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8929                         _ => panic!("Unexpected event"),
8930                 }
8931
8932                 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
8933                 assert_eq!(c_txn.len(), 3);
8934                 assert_eq!(c_txn[0], c_txn[2]);
8935                 assert_eq!(commitment_tx[0], c_txn[1]);
8936                 check_spends!(c_txn[1], chan_2.3.clone());
8937                 check_spends!(c_txn[2], c_txn[1].clone());
8938                 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
8939                 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8940                 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
8941                 assert_eq!(c_txn[0].lock_time, 0); // Success tx
8942
8943                 // So we broadcast C's commitment tx and HTLC-Success on B's chain, we should successfully be able to extract preimage and update downstream monitor
8944                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
8945                 {
8946                         let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8947                         assert_eq!(b_txn.len(), 4);
8948                         assert_eq!(b_txn[0], b_txn[3]);
8949                         check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
8950                         check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
8951                         assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8952                         assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
8953                         assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
8954                         check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
8955                         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8956                         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
8957                         assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
8958                         b_txn.clear();
8959                 }
8960                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
8961                 check_added_monitors!(nodes[1], 1);
8962                 match msg_events[0] {
8963                         MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
8964                         _ => panic!("Unexpected event"),
8965                 }
8966                 match msg_events[1] {
8967                         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, .. } } => {
8968                                 assert!(update_add_htlcs.is_empty());
8969                                 assert!(update_fail_htlcs.is_empty());
8970                                 assert_eq!(update_fulfill_htlcs.len(), 1);
8971                                 assert!(update_fail_malformed_htlcs.is_empty());
8972                                 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
8973                         },
8974                         _ => panic!("Unexpected event"),
8975                 };
8976                 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
8977                 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8978                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
8979                 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8980                 assert_eq!(b_txn.len(), 3);
8981                 check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
8982                 assert_eq!(b_txn[0], b_txn[2]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
8983                 check_spends!(b_txn[0], commitment_tx[0].clone());
8984                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8985                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
8986                 assert_eq!(b_txn[2].lock_time, 0); // Success tx
8987                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
8988                 match msg_events[0] {
8989                         MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
8990                         _ => panic!("Unexpected event"),
8991                 }
8992         }
8993
8994         #[test]
8995         fn test_duplicate_payment_hash_one_failure_one_success() {
8996                 // Topology : A --> B --> C
8997                 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
8998                 let mut nodes = create_network(3);
8999
9000                 create_announced_chan_between_nodes(&nodes, 0, 1);
9001                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
9002
9003                 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
9004                 *nodes[0].network_payment_count.borrow_mut() -= 1;
9005                 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
9006
9007                 let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
9008                 assert_eq!(commitment_txn[0].input.len(), 1);
9009                 check_spends!(commitment_txn[0], chan_2.3.clone());
9010
9011                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9012                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
9013                 let htlc_timeout_tx;
9014                 { // Extract one of the two HTLC-Timeout transaction
9015                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9016                         assert_eq!(node_txn.len(), 7);
9017                         assert_eq!(node_txn[0], node_txn[5]);
9018                         assert_eq!(node_txn[1], node_txn[6]);
9019                         check_spends!(node_txn[0], commitment_txn[0].clone());
9020                         assert_eq!(node_txn[0].input.len(), 1);
9021                         check_spends!(node_txn[1], commitment_txn[0].clone());
9022                         assert_eq!(node_txn[1].input.len(), 1);
9023                         assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
9024                         check_spends!(node_txn[2], chan_2.3.clone());
9025                         check_spends!(node_txn[3], node_txn[2].clone());
9026                         check_spends!(node_txn[4], node_txn[2].clone());
9027                         htlc_timeout_tx = node_txn[1].clone();
9028                 }
9029
9030                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9031                 match events[0] {
9032                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
9033                         _ => panic!("Unexepected event"),
9034                 }
9035
9036                 nodes[2].node.claim_funds(our_payment_preimage);
9037                 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
9038                 check_added_monitors!(nodes[2], 2);
9039                 let events = nodes[2].node.get_and_clear_pending_msg_events();
9040                 match events[0] {
9041                         MessageSendEvent::UpdateHTLCs { .. } => {},
9042                         _ => panic!("Unexpected event"),
9043                 }
9044                 match events[1] {
9045                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
9046                         _ => panic!("Unexepected event"),
9047                 }
9048                 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9049                 assert_eq!(htlc_success_txn.len(), 5);
9050                 check_spends!(htlc_success_txn[2], chan_2.3.clone());
9051                 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
9052                 assert_eq!(htlc_success_txn[0].input.len(), 1);
9053                 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
9054                 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
9055                 assert_eq!(htlc_success_txn[1].input.len(), 1);
9056                 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
9057                 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
9058                 check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
9059                 check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
9060
9061                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
9062                 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9063                 assert!(htlc_updates.update_add_htlcs.is_empty());
9064                 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
9065                 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
9066                 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
9067                 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
9068                 check_added_monitors!(nodes[1], 1);
9069
9070                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]).unwrap();
9071                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
9072                 {
9073                         commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
9074                         let events = nodes[0].node.get_and_clear_pending_msg_events();
9075                         assert_eq!(events.len(), 1);
9076                         match events[0] {
9077                                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
9078                                 },
9079                                 _ => { panic!("Unexpected event"); }
9080                         }
9081                 }
9082                 let events = nodes[0].node.get_and_clear_pending_events();
9083                 match events[0] {
9084                         Event::PaymentFailed { ref payment_hash, .. } => {
9085                                 assert_eq!(*payment_hash, duplicate_payment_hash);
9086                         }
9087                         _ => panic!("Unexpected event"),
9088                 }
9089
9090                 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
9091                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
9092                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9093                 assert!(updates.update_add_htlcs.is_empty());
9094                 assert!(updates.update_fail_htlcs.is_empty());
9095                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
9096                 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
9097                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9098                 check_added_monitors!(nodes[1], 1);
9099
9100                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
9101                 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
9102
9103                 let events = nodes[0].node.get_and_clear_pending_events();
9104                 match events[0] {
9105                         Event::PaymentSent { ref payment_preimage } => {
9106                                 assert_eq!(*payment_preimage, our_payment_preimage);
9107                         }
9108                         _ => panic!("Unexpected event"),
9109                 }
9110         }
9111
9112         #[test]
9113         fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
9114                 let nodes = create_network(2);
9115
9116                 // Create some initial channels
9117                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
9118
9119                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
9120                 let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
9121                 assert_eq!(local_txn[0].input.len(), 1);
9122                 check_spends!(local_txn[0], chan_1.3.clone());
9123
9124                 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
9125                 nodes[1].node.claim_funds(payment_preimage);
9126                 check_added_monitors!(nodes[1], 1);
9127                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9128                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
9129                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9130                 match events[0] {
9131                         MessageSendEvent::UpdateHTLCs { .. } => {},
9132                         _ => panic!("Unexpected event"),
9133                 }
9134                 match events[1] {
9135                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
9136                         _ => panic!("Unexepected event"),
9137                 }
9138                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9139                 assert_eq!(node_txn[0].input.len(), 1);
9140                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
9141                 check_spends!(node_txn[0], local_txn[0].clone());
9142
9143                 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
9144                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
9145                 assert_eq!(spend_txn.len(), 2);
9146                 check_spends!(spend_txn[0], node_txn[0].clone());
9147                 check_spends!(spend_txn[1], node_txn[2].clone());
9148         }
9149
9150         #[test]
9151         fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
9152                 let nodes = create_network(2);
9153
9154                 // Create some initial channels
9155                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
9156
9157                 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
9158                 let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
9159                 assert_eq!(local_txn[0].input.len(), 1);
9160                 check_spends!(local_txn[0], chan_1.3.clone());
9161
9162                 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
9163                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9164                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
9165                 let events = nodes[0].node.get_and_clear_pending_msg_events();
9166                 match events[0] {
9167                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
9168                         _ => panic!("Unexepected event"),
9169                 }
9170                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
9171                 assert_eq!(node_txn[0].input.len(), 1);
9172                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
9173                 check_spends!(node_txn[0], local_txn[0].clone());
9174
9175                 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
9176                 let spend_txn = check_spendable_outputs!(nodes[0], 1);
9177                 assert_eq!(spend_txn.len(), 8);
9178                 assert_eq!(spend_txn[0], spend_txn[2]);
9179                 assert_eq!(spend_txn[0], spend_txn[4]);
9180                 assert_eq!(spend_txn[0], spend_txn[6]);
9181                 assert_eq!(spend_txn[1], spend_txn[3]);
9182                 assert_eq!(spend_txn[1], spend_txn[5]);
9183                 assert_eq!(spend_txn[1], spend_txn[7]);
9184                 check_spends!(spend_txn[0], local_txn[0].clone());
9185                 check_spends!(spend_txn[1], node_txn[0].clone());
9186         }
9187
9188         #[test]
9189         fn test_static_output_closing_tx() {
9190                 let nodes = create_network(2);
9191
9192                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9193
9194                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
9195                 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
9196
9197                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
9198                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
9199                 let spend_txn = check_spendable_outputs!(nodes[0], 2);
9200                 assert_eq!(spend_txn.len(), 1);
9201                 check_spends!(spend_txn[0], closing_tx.clone());
9202
9203                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
9204                 let spend_txn = check_spendable_outputs!(nodes[1], 2);
9205                 assert_eq!(spend_txn.len(), 1);
9206                 check_spends!(spend_txn[0], closing_tx);
9207         }
9208 }