Merge pull request #434 from TheBlueMatt/2019-12-var-len-onion
[rust-lightning] / 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;
16
17 use bitcoin_hashes::{Hash, HashEngine};
18 use bitcoin_hashes::hmac::{Hmac, HmacEngine};
19 use bitcoin_hashes::sha256::Hash as Sha256;
20 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
21 use bitcoin_hashes::cmp::fixed_time_eq;
22
23 use secp256k1::key::{SecretKey,PublicKey};
24 use secp256k1::Secp256k1;
25 use secp256k1::ecdh::SharedSecret;
26 use secp256k1;
27
28 use chain::chaininterface::{BroadcasterInterface,ChainListener,FeeEstimator};
29 use chain::transaction::OutPoint;
30 use ln::channel::{Channel, ChannelError};
31 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
32 use ln::router::Route;
33 use ln::features::InitFeatures;
34 use ln::msgs;
35 use ln::onion_utils;
36 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
37 use chain::keysinterface::{ChannelKeys, KeysInterface, InMemoryChannelKeys};
38 use util::config::UserConfig;
39 use util::{byte_utils, events};
40 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
41 use util::chacha20::{ChaCha20, ChaChaReader};
42 use util::logger::Logger;
43 use util::errors::APIError;
44
45 use std::{cmp, mem};
46 use std::collections::{HashMap, hash_map, HashSet};
47 use std::io::{Cursor, Read};
48 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
49 use std::sync::atomic::{AtomicUsize, Ordering};
50 use std::time::Duration;
51 use std::marker::{Sync, Send};
52 use std::ops::Deref;
53
54 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
55 //
56 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
57 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
58 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
59 //
60 // When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo
61 // which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData
62 // filled in to indicate where it came from (which we can use to either fail-backwards or fulfill
63 // the HTLC backwards along the relevant path).
64 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
65 // our payment, which we can use to decode errors or inform the user that the payment was sent.
66 /// Stores the info we will need to send when we want to forward an HTLC onwards
67 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
68 pub(super) struct PendingForwardHTLCInfo {
69         onion_packet: Option<msgs::OnionPacket>,
70         incoming_shared_secret: [u8; 32],
71         payment_hash: PaymentHash,
72         short_channel_id: u64,
73         pub(super) amt_to_forward: u64,
74         pub(super) outgoing_cltv_value: u32,
75 }
76
77 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
78 pub(super) enum HTLCFailureMsg {
79         Relay(msgs::UpdateFailHTLC),
80         Malformed(msgs::UpdateFailMalformedHTLC),
81 }
82
83 /// Stores whether we can't forward an HTLC or relevant forwarding info
84 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
85 pub(super) enum PendingHTLCStatus {
86         Forward(PendingForwardHTLCInfo),
87         Fail(HTLCFailureMsg),
88 }
89
90 /// Tracks the inbound corresponding to an outbound HTLC
91 #[derive(Clone, PartialEq)]
92 pub(super) struct HTLCPreviousHopData {
93         short_channel_id: u64,
94         htlc_id: u64,
95         incoming_packet_shared_secret: [u8; 32],
96 }
97
98 /// Tracks the inbound corresponding to an outbound HTLC
99 #[derive(Clone, PartialEq)]
100 pub(super) enum HTLCSource {
101         PreviousHopData(HTLCPreviousHopData),
102         OutboundRoute {
103                 route: Route,
104                 session_priv: SecretKey,
105                 /// Technically we can recalculate this from the route, but we cache it here to avoid
106                 /// doing a double-pass on route when we get a failure back
107                 first_hop_htlc_msat: u64,
108         },
109 }
110 #[cfg(test)]
111 impl HTLCSource {
112         pub fn dummy() -> Self {
113                 HTLCSource::OutboundRoute {
114                         route: Route { hops: Vec::new() },
115                         session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
116                         first_hop_htlc_msat: 0,
117                 }
118         }
119 }
120
121 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
122 pub(super) enum HTLCFailReason {
123         LightningError {
124                 err: msgs::OnionErrorPacket,
125         },
126         Reason {
127                 failure_code: u16,
128                 data: Vec<u8>,
129         }
130 }
131
132 /// payment_hash type, use to cross-lock hop
133 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
134 pub struct PaymentHash(pub [u8;32]);
135 /// payment_preimage type, use to route payment between hop
136 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
137 pub struct PaymentPreimage(pub [u8;32]);
138
139 type ShutdownResult = (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>);
140
141 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
142 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
143 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
144 /// channel_state lock. We then return the set of things that need to be done outside the lock in
145 /// this struct and call handle_error!() on it.
146
147 struct MsgHandleErrInternal {
148         err: msgs::LightningError,
149         shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
150 }
151 impl MsgHandleErrInternal {
152         #[inline]
153         fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
154                 Self {
155                         err: LightningError {
156                                 err,
157                                 action: msgs::ErrorAction::SendErrorMessage {
158                                         msg: msgs::ErrorMessage {
159                                                 channel_id,
160                                                 data: err.to_string()
161                                         },
162                                 },
163                         },
164                         shutdown_finish: None,
165                 }
166         }
167         #[inline]
168         fn ignore_no_close(err: &'static str) -> Self {
169                 Self {
170                         err: LightningError {
171                                 err,
172                                 action: msgs::ErrorAction::IgnoreError,
173                         },
174                         shutdown_finish: None,
175                 }
176         }
177         #[inline]
178         fn from_no_close(err: msgs::LightningError) -> Self {
179                 Self { err, shutdown_finish: None }
180         }
181         #[inline]
182         fn from_finish_shutdown(err: &'static str, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
183                 Self {
184                         err: LightningError {
185                                 err,
186                                 action: msgs::ErrorAction::SendErrorMessage {
187                                         msg: msgs::ErrorMessage {
188                                                 channel_id,
189                                                 data: err.to_string()
190                                         },
191                                 },
192                         },
193                         shutdown_finish: Some((shutdown_res, channel_update)),
194                 }
195         }
196         #[inline]
197         fn from_chan_no_close<ChanSigner: ChannelKeys>(err: ChannelError<ChanSigner>, channel_id: [u8; 32]) -> Self {
198                 Self {
199                         err: match err {
200                                 ChannelError::Ignore(msg) => LightningError {
201                                         err: msg,
202                                         action: msgs::ErrorAction::IgnoreError,
203                                 },
204                                 ChannelError::Close(msg) => LightningError {
205                                         err: msg,
206                                         action: msgs::ErrorAction::SendErrorMessage {
207                                                 msg: msgs::ErrorMessage {
208                                                         channel_id,
209                                                         data: msg.to_string()
210                                                 },
211                                         },
212                                 },
213                                 ChannelError::CloseDelayBroadcast { msg, .. } => LightningError {
214                                         err: msg,
215                                         action: msgs::ErrorAction::SendErrorMessage {
216                                                 msg: msgs::ErrorMessage {
217                                                         channel_id,
218                                                         data: msg.to_string()
219                                                 },
220                                         },
221                                 },
222                         },
223                         shutdown_finish: None,
224                 }
225         }
226 }
227
228 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
229 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
230 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
231 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
232 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
233
234 pub(super) enum HTLCForwardInfo {
235         AddHTLC {
236                 prev_short_channel_id: u64,
237                 prev_htlc_id: u64,
238                 forward_info: PendingForwardHTLCInfo,
239         },
240         FailHTLC {
241                 htlc_id: u64,
242                 err_packet: msgs::OnionErrorPacket,
243         },
244 }
245
246 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
247 /// be sent in the order they appear in the return value, however sometimes the order needs to be
248 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
249 /// they were originally sent). In those cases, this enum is also returned.
250 #[derive(Clone, PartialEq)]
251 pub(super) enum RAACommitmentOrder {
252         /// Send the CommitmentUpdate messages first
253         CommitmentFirst,
254         /// Send the RevokeAndACK message first
255         RevokeAndACKFirst,
256 }
257
258 // Note this is only exposed in cfg(test):
259 pub(super) struct ChannelHolder<ChanSigner: ChannelKeys> {
260         pub(super) by_id: HashMap<[u8; 32], Channel<ChanSigner>>,
261         pub(super) short_to_id: HashMap<u64, [u8; 32]>,
262         /// short channel id -> forward infos. Key of 0 means payments received
263         /// Note that while this is held in the same mutex as the channels themselves, no consistency
264         /// guarantees are made about the existence of a channel with the short id here, nor the short
265         /// ids in the PendingForwardHTLCInfo!
266         pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
267         /// payment_hash -> Vec<(amount_received, htlc_source)> for tracking things that were to us and
268         /// can be failed/claimed by the user
269         /// Note that while this is held in the same mutex as the channels themselves, no consistency
270         /// guarantees are made about the channels given here actually existing anymore by the time you
271         /// go to read them!
272         pub(super) claimable_htlcs: HashMap<PaymentHash, Vec<(u64, HTLCPreviousHopData)>>,
273         /// Messages to send to peers - pushed to in the same lock that they are generated in (except
274         /// for broadcast messages, where ordering isn't as strict).
275         pub(super) pending_msg_events: Vec<events::MessageSendEvent>,
276 }
277
278 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
279 /// the latest Init features we heard from the peer.
280 struct PeerState {
281         latest_features: InitFeatures,
282 }
283
284 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
285 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
286
287 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
288 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
289 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
290 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
291 /// issues such as overly long function definitions.
292 pub type SimpleArcChannelManager<M> = Arc<ChannelManager<InMemoryChannelKeys, Arc<M>>>;
293
294 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
295 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
296 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
297 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
298 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
299 /// helps with issues such as long function definitions.
300 pub type SimpleRefChannelManager<'a, M> = ChannelManager<InMemoryChannelKeys, &'a M>;
301
302 /// Manager which keeps track of a number of channels and sends messages to the appropriate
303 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
304 ///
305 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
306 /// to individual Channels.
307 ///
308 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
309 /// all peers during write/read (though does not modify this instance, only the instance being
310 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
311 /// called funding_transaction_generated for outbound channels).
312 ///
313 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
314 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
315 /// returning from ManyChannelMonitor::add_update_monitor, with ChannelManagers, writing updates
316 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
317 /// the serialization process). If the deserialized version is out-of-date compared to the
318 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
319 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
320 ///
321 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
322 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
323 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
324 /// block_connected() to step towards your best block) upon deserialization before using the
325 /// object!
326 ///
327 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
328 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
329 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
330 /// offline for a full minute. In order to track this, you must call
331 /// timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfect.
332 ///
333 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
334 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
335 /// essentially you should default to using a SimpleRefChannelManager, and use a
336 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
337 /// you're using lightning-net-tokio.
338 pub struct ChannelManager<ChanSigner: ChannelKeys, M: Deref> where M::Target: ManyChannelMonitor<ChanSigner> {
339         default_configuration: UserConfig,
340         genesis_hash: Sha256dHash,
341         fee_estimator: Arc<FeeEstimator>,
342         monitor: M,
343         tx_broadcaster: Arc<BroadcasterInterface>,
344
345         #[cfg(test)]
346         pub(super) latest_block_height: AtomicUsize,
347         #[cfg(not(test))]
348         latest_block_height: AtomicUsize,
349         last_block_hash: Mutex<Sha256dHash>,
350         secp_ctx: Secp256k1<secp256k1::All>,
351
352         #[cfg(test)]
353         pub(super) channel_state: Mutex<ChannelHolder<ChanSigner>>,
354         #[cfg(not(test))]
355         channel_state: Mutex<ChannelHolder<ChanSigner>>,
356         our_network_key: SecretKey,
357
358         /// The bulk of our storage will eventually be here (channels and message queues and the like).
359         /// If we are connected to a peer we always at least have an entry here, even if no channels
360         /// are currently open with that peer.
361         /// Because adding or removing an entry is rare, we usually take an outer read lock and then
362         /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
363         /// new channel.
364         per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
365
366         pending_events: Mutex<Vec<events::Event>>,
367         /// Used when we have to take a BIG lock to make sure everything is self-consistent.
368         /// Essentially just when we're serializing ourselves out.
369         /// Taken first everywhere where we are making changes before any other locks.
370         total_consistency_lock: RwLock<()>,
371
372         keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>,
373
374         logger: Arc<Logger>,
375 }
376
377 /// The amount of time we require our counterparty wait to claim their money (ie time between when
378 /// we, or our watchtower, must check for them having broadcast a theft transaction).
379 pub(crate) const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
380 /// The amount of time we're willing to wait to claim money back to us
381 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7;
382
383 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
384 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
385 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
386 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
387 /// CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
388 const CLTV_EXPIRY_DELTA: u16 = 6 * 12; //TODO?
389 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
390
391 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
392 // ie that if the next-hop peer fails the HTLC within
393 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
394 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
395 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
396 // LATENCY_GRACE_PERIOD_BLOCKS.
397 #[deny(const_err)]
398 #[allow(dead_code)]
399 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - CLTV_CLAIM_BUFFER - ANTI_REORG_DELAY - LATENCY_GRACE_PERIOD_BLOCKS;
400
401 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
402 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
403 #[deny(const_err)]
404 #[allow(dead_code)]
405 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
406
407 macro_rules! secp_call {
408         ( $res: expr, $err: expr ) => {
409                 match $res {
410                         Ok(key) => key,
411                         Err(_) => return Err($err),
412                 }
413         };
414 }
415
416 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
417 pub struct ChannelDetails {
418         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
419         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
420         /// Note that this means this value is *not* persistent - it can change once during the
421         /// lifetime of the channel.
422         pub channel_id: [u8; 32],
423         /// The position of the funding transaction in the chain. None if the funding transaction has
424         /// not yet been confirmed and the channel fully opened.
425         pub short_channel_id: Option<u64>,
426         /// The node_id of our counterparty
427         pub remote_network_id: PublicKey,
428         /// The Features the channel counterparty provided upon last connection.
429         /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
430         /// many routing-relevant features are present in the init context.
431         pub counterparty_features: InitFeatures,
432         /// The value, in satoshis, of this channel as appears in the funding output
433         pub channel_value_satoshis: u64,
434         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
435         pub user_id: u64,
436         /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
437         /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
438         /// available for inclusion in new outbound HTLCs). This further does not include any pending
439         /// outgoing HTLCs which are awaiting some other resolution to be sent.
440         pub outbound_capacity_msat: u64,
441         /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
442         /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
443         /// available for inclusion in new inbound HTLCs).
444         /// Note that there are some corner cases not fully handled here, so the actual available
445         /// inbound capacity may be slightly higher than this.
446         pub inbound_capacity_msat: u64,
447         /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
448         /// the peer is connected, and (c) no monitor update failure is pending resolution.
449         pub is_live: bool,
450 }
451
452 macro_rules! handle_error {
453         ($self: ident, $internal: expr, $their_node_id: expr, $locked_channel_state: expr) => {
454                 match $internal {
455                         Ok(msg) => Ok(msg),
456                         Err(MsgHandleErrInternal { err, shutdown_finish }) => {
457                                 if let Some((shutdown_res, update_option)) = shutdown_finish {
458                                         $self.finish_force_close_channel(shutdown_res);
459                                         if let Some(update) = update_option {
460                                                 $locked_channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
461                                                         msg: update
462                                                 });
463                                         }
464                                 }
465                                 log_error!($self, "{}", err.err);
466                                 if let msgs::ErrorAction::IgnoreError = err.action {
467                                 } else { $locked_channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError { node_id: $their_node_id, action: err.action.clone() }); }
468                                 // Return error in case higher-API need one
469                                 Err(err)
470                         },
471                 }
472         }
473 }
474
475 macro_rules! break_chan_entry {
476         ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
477                 match $res {
478                         Ok(res) => res,
479                         Err(ChannelError::Ignore(msg)) => {
480                                 break Err(MsgHandleErrInternal::from_chan_no_close::<ChanSigner>(ChannelError::Ignore(msg), $entry.key().clone()))
481                         },
482                         Err(ChannelError::Close(msg)) => {
483                                 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
484                                 let (channel_id, mut chan) = $entry.remove_entry();
485                                 if let Some(short_id) = chan.get_short_channel_id() {
486                                         $channel_state.short_to_id.remove(&short_id);
487                                 }
488                                 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
489                         },
490                         Err(ChannelError::CloseDelayBroadcast { .. }) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
491                 }
492         }
493 }
494
495 macro_rules! try_chan_entry {
496         ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
497                 match $res {
498                         Ok(res) => res,
499                         Err(ChannelError::Ignore(msg)) => {
500                                 return Err(MsgHandleErrInternal::from_chan_no_close::<ChanSigner>(ChannelError::Ignore(msg), $entry.key().clone()))
501                         },
502                         Err(ChannelError::Close(msg)) => {
503                                 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
504                                 let (channel_id, mut chan) = $entry.remove_entry();
505                                 if let Some(short_id) = chan.get_short_channel_id() {
506                                         $channel_state.short_to_id.remove(&short_id);
507                                 }
508                                 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
509                         },
510                         Err(ChannelError::CloseDelayBroadcast { msg, update }) => {
511                                 log_error!($self, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
512                                 let (channel_id, mut chan) = $entry.remove_entry();
513                                 if let Some(short_id) = chan.get_short_channel_id() {
514                                         $channel_state.short_to_id.remove(&short_id);
515                                 }
516                                 if let Some(update) = update {
517                                         if let Err(e) = $self.monitor.add_update_monitor(update.get_funding_txo().unwrap(), update.clone()) {
518                                                 match e {
519                                                         // Upstream channel is dead, but we want at least to fail backward HTLCs to save
520                                                         // downstream channels. In case of PermanentFailure, we are not going to be able
521                                                         // to claim back to_remote output on remote commitment transaction. Doesn't
522                                                         // make a difference here, we are concern about HTLCs circuit, not onchain funds.
523                                                         ChannelMonitorUpdateErr::PermanentFailure => {},
524                                                         ChannelMonitorUpdateErr::TemporaryFailure => {},
525                                                 }
526                                         }
527                                 }
528                                 let mut shutdown_res = chan.force_shutdown();
529                                 if shutdown_res.0.len() >= 1 {
530                                         log_error!($self, "You have a toxic local commitment transaction {} avaible in channel monitor, read comment in ChannelMonitor::get_latest_local_commitment_txn to be informed of manual action to take", shutdown_res.0[0].txid());
531                                 }
532                                 shutdown_res.0.clear();
533                                 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
534                         }
535                 }
536         }
537 }
538
539 macro_rules! handle_monitor_err {
540         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
541                 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
542         };
543         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
544                 match $err {
545                         ChannelMonitorUpdateErr::PermanentFailure => {
546                                 log_error!($self, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
547                                 let (channel_id, mut chan) = $entry.remove_entry();
548                                 if let Some(short_id) = chan.get_short_channel_id() {
549                                         $channel_state.short_to_id.remove(&short_id);
550                                 }
551                                 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
552                                 // chain in a confused state! We need to move them into the ChannelMonitor which
553                                 // will be responsible for failing backwards once things confirm on-chain.
554                                 // It's ok that we drop $failed_forwards here - at this point we'd rather they
555                                 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
556                                 // us bother trying to claim it just to forward on to another peer. If we're
557                                 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
558                                 // given up the preimage yet, so might as well just wait until the payment is
559                                 // retried, avoiding the on-chain fees.
560                                 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()));
561                                 res
562                         },
563                         ChannelMonitorUpdateErr::TemporaryFailure => {
564                                 log_info!($self, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
565                                                 log_bytes!($entry.key()[..]),
566                                                 if $resend_commitment && $resend_raa {
567                                                                 match $action_type {
568                                                                         RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
569                                                                         RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
570                                                                 }
571                                                         } else if $resend_commitment { "commitment" }
572                                                         else if $resend_raa { "RAA" }
573                                                         else { "nothing" },
574                                                 (&$failed_forwards as &Vec<(PendingForwardHTLCInfo, u64)>).len(),
575                                                 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
576                                 if !$resend_commitment {
577                                         debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
578                                 }
579                                 if !$resend_raa {
580                                         debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
581                                 }
582                                 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
583                                 Err(MsgHandleErrInternal::from_chan_no_close::<ChanSigner>(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()))
584                         },
585                 }
586         }
587 }
588
589 macro_rules! return_monitor_err {
590         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
591                 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
592         };
593         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
594                 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
595         }
596 }
597
598 // Does not break in case of TemporaryFailure!
599 macro_rules! maybe_break_monitor_err {
600         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
601                 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
602                         (e, ChannelMonitorUpdateErr::PermanentFailure) => {
603                                 break e;
604                         },
605                         (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
606                 }
607         }
608 }
609
610 impl<ChanSigner: ChannelKeys, M: Deref> ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor<ChanSigner> {
611         /// Constructs a new ChannelManager to hold several channels and route between them.
612         ///
613         /// This is the main "logic hub" for all channel-related actions, and implements
614         /// ChannelMessageHandler.
615         ///
616         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
617         ///
618         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
619         ///
620         /// Users must provide the current blockchain height from which to track onchain channel
621         /// funding outpoints and send payments with reliable timelocks.
622         ///
623         /// Users need to notify the new ChannelManager when a new block is connected or
624         /// disconnected using its `block_connected` and `block_disconnected` methods.
625         /// However, rather than calling these methods directly, the user should register
626         /// the ChannelManager as a listener to the BlockNotifier and call the BlockNotifier's
627         /// `block_(dis)connected` methods, which will notify all registered listeners in one
628         /// go.
629         pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: M, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>, config: UserConfig, current_blockchain_height: usize) -> Result<ChannelManager<ChanSigner, M>, secp256k1::Error> {
630                 let secp_ctx = Secp256k1::new();
631
632                 let res = ChannelManager {
633                         default_configuration: config.clone(),
634                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
635                         fee_estimator: feeest.clone(),
636                         monitor,
637                         tx_broadcaster,
638
639                         latest_block_height: AtomicUsize::new(current_blockchain_height),
640                         last_block_hash: Mutex::new(Default::default()),
641                         secp_ctx,
642
643                         channel_state: Mutex::new(ChannelHolder{
644                                 by_id: HashMap::new(),
645                                 short_to_id: HashMap::new(),
646                                 forward_htlcs: HashMap::new(),
647                                 claimable_htlcs: HashMap::new(),
648                                 pending_msg_events: Vec::new(),
649                         }),
650                         our_network_key: keys_manager.get_node_secret(),
651
652                         per_peer_state: RwLock::new(HashMap::new()),
653
654                         pending_events: Mutex::new(Vec::new()),
655                         total_consistency_lock: RwLock::new(()),
656
657                         keys_manager,
658
659                         logger,
660                 };
661
662                 Ok(res)
663         }
664
665         /// Creates a new outbound channel to the given remote node and with the given value.
666         ///
667         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
668         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
669         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
670         /// may wish to avoid using 0 for user_id here.
671         ///
672         /// If successful, will generate a SendOpenChannel message event, so you should probably poll
673         /// PeerManager::process_events afterwards.
674         ///
675         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
676         /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
677         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
678                 if channel_value_satoshis < 1000 {
679                         return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
680                 }
681
682                 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)?;
683                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
684
685                 let _ = self.total_consistency_lock.read().unwrap();
686                 let mut channel_state = self.channel_state.lock().unwrap();
687                 match channel_state.by_id.entry(channel.channel_id()) {
688                         hash_map::Entry::Occupied(_) => {
689                                 if cfg!(feature = "fuzztarget") {
690                                         return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
691                                 } else {
692                                         panic!("RNG is bad???");
693                                 }
694                         },
695                         hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
696                 }
697                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
698                         node_id: their_network_key,
699                         msg: res,
700                 });
701                 Ok(())
702         }
703
704         fn list_channels_with_filter<F: FnMut(&(&[u8; 32], &Channel<ChanSigner>)) -> bool>(&self, f: F) -> Vec<ChannelDetails> {
705                 let mut res = Vec::new();
706                 {
707                         let channel_state = self.channel_state.lock().unwrap();
708                         res.reserve(channel_state.by_id.len());
709                         for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
710                                 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
711                                 res.push(ChannelDetails {
712                                         channel_id: (*channel_id).clone(),
713                                         short_channel_id: channel.get_short_channel_id(),
714                                         remote_network_id: channel.get_their_node_id(),
715                                         counterparty_features: InitFeatures::empty(),
716                                         channel_value_satoshis: channel.get_value_satoshis(),
717                                         inbound_capacity_msat,
718                                         outbound_capacity_msat,
719                                         user_id: channel.get_user_id(),
720                                         is_live: channel.is_live(),
721                                 });
722                         }
723                 }
724                 let per_peer_state = self.per_peer_state.read().unwrap();
725                 for chan in res.iter_mut() {
726                         if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
727                                 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
728                         }
729                 }
730                 res
731         }
732
733         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
734         /// more information.
735         pub fn list_channels(&self) -> Vec<ChannelDetails> {
736                 self.list_channels_with_filter(|_| true)
737         }
738
739         /// Gets the list of usable channels, in random order. Useful as an argument to
740         /// Router::get_route to ensure non-announced channels are used.
741         ///
742         /// These are guaranteed to have their is_live value set to true, see the documentation for
743         /// ChannelDetails::is_live for more info on exactly what the criteria are.
744         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
745                 // Note we use is_live here instead of usable which leads to somewhat confused
746                 // internal/external nomenclature, but that's ok cause that's probably what the user
747                 // really wanted anyway.
748                 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
749         }
750
751         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
752         /// will be accepted on the given channel, and after additional timeout/the closing of all
753         /// pending HTLCs, the channel will be closed on chain.
754         ///
755         /// May generate a SendShutdown message event on success, which should be relayed.
756         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
757                 let _ = self.total_consistency_lock.read().unwrap();
758
759                 let (mut failed_htlcs, chan_option) = {
760                         let mut channel_state_lock = self.channel_state.lock().unwrap();
761                         let channel_state = &mut *channel_state_lock;
762                         match channel_state.by_id.entry(channel_id.clone()) {
763                                 hash_map::Entry::Occupied(mut chan_entry) => {
764                                         let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
765                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
766                                                 node_id: chan_entry.get().get_their_node_id(),
767                                                 msg: shutdown_msg
768                                         });
769                                         if chan_entry.get().is_shutdown() {
770                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
771                                                         channel_state.short_to_id.remove(&short_id);
772                                                 }
773                                                 (failed_htlcs, Some(chan_entry.remove_entry().1))
774                                         } else { (failed_htlcs, None) }
775                                 },
776                                 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
777                         }
778                 };
779                 for htlc_source in failed_htlcs.drain(..) {
780                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
781                 }
782                 let chan_update = if let Some(chan) = chan_option {
783                         if let Ok(update) = self.get_channel_update(&chan) {
784                                 Some(update)
785                         } else { None }
786                 } else { None };
787
788                 if let Some(update) = chan_update {
789                         let mut channel_state = self.channel_state.lock().unwrap();
790                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
791                                 msg: update
792                         });
793                 }
794
795                 Ok(())
796         }
797
798         #[inline]
799         fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
800                 let (local_txn, mut failed_htlcs) = shutdown_res;
801                 log_trace!(self, "Finishing force-closure of channel with {} transactions to broadcast and {} HTLCs to fail", local_txn.len(), failed_htlcs.len());
802                 for htlc_source in failed_htlcs.drain(..) {
803                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
804                 }
805                 for tx in local_txn {
806                         log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
807                         self.tx_broadcaster.broadcast_transaction(&tx);
808                 }
809         }
810
811         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
812         /// the chain and rejecting new HTLCs on the given channel.
813         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
814                 let _ = self.total_consistency_lock.read().unwrap();
815
816                 let mut chan = {
817                         let mut channel_state_lock = self.channel_state.lock().unwrap();
818                         let channel_state = &mut *channel_state_lock;
819                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
820                                 if let Some(short_id) = chan.get_short_channel_id() {
821                                         channel_state.short_to_id.remove(&short_id);
822                                 }
823                                 chan
824                         } else {
825                                 return;
826                         }
827                 };
828                 log_trace!(self, "Force-closing channel {}", log_bytes!(channel_id[..]));
829                 self.finish_force_close_channel(chan.force_shutdown());
830                 if let Ok(update) = self.get_channel_update(&chan) {
831                         let mut channel_state = self.channel_state.lock().unwrap();
832                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
833                                 msg: update
834                         });
835                 }
836         }
837
838         /// Force close all channels, immediately broadcasting the latest local commitment transaction
839         /// for each to the chain and rejecting new HTLCs on each.
840         pub fn force_close_all_channels(&self) {
841                 for chan in self.list_channels() {
842                         self.force_close_channel(&chan.channel_id);
843                 }
844         }
845
846         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<ChanSigner>>) {
847                 macro_rules! return_malformed_err {
848                         ($msg: expr, $err_code: expr) => {
849                                 {
850                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
851                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
852                                                 channel_id: msg.channel_id,
853                                                 htlc_id: msg.htlc_id,
854                                                 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
855                                                 failure_code: $err_code,
856                                         })), self.channel_state.lock().unwrap());
857                                 }
858                         }
859                 }
860
861                 if let Err(_) = msg.onion_routing_packet.public_key {
862                         return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
863                 }
864
865                 let shared_secret = {
866                         let mut arr = [0; 32];
867                         arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
868                         arr
869                 };
870                 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
871
872                 if msg.onion_routing_packet.version != 0 {
873                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
874                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
875                         //the hash doesn't really serve any purpose - in the case of hashing all data, the
876                         //receiving node would have to brute force to figure out which version was put in the
877                         //packet by the node that send us the message, in the case of hashing the hop_data, the
878                         //node knows the HMAC matched, so they already know what is there...
879                         return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
880                 }
881
882                 let mut hmac = HmacEngine::<Sha256>::new(&mu);
883                 hmac.input(&msg.onion_routing_packet.hop_data);
884                 hmac.input(&msg.payment_hash.0[..]);
885                 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
886                         return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
887                 }
888
889                 let mut channel_state = None;
890                 macro_rules! return_err {
891                         ($msg: expr, $err_code: expr, $data: expr) => {
892                                 {
893                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
894                                         if channel_state.is_none() {
895                                                 channel_state = Some(self.channel_state.lock().unwrap());
896                                         }
897                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
898                                                 channel_id: msg.channel_id,
899                                                 htlc_id: msg.htlc_id,
900                                                 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
901                                         })), channel_state.unwrap());
902                                 }
903                         }
904                 }
905
906                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
907                 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
908                 let (next_hop_data, next_hop_hmac) = {
909                         match msgs::OnionHopData::read(&mut chacha_stream) {
910                                 Err(err) => {
911                                         let error_code = match err {
912                                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
913                                                 msgs::DecodeError::UnknownRequiredFeature|
914                                                 msgs::DecodeError::InvalidValue|
915                                                 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
916                                                 _ => 0x2000 | 2, // Should never happen
917                                         };
918                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
919                                 },
920                                 Ok(msg) => {
921                                         let mut hmac = [0; 32];
922                                         if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
923                                                 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
924                                         }
925                                         (msg, hmac)
926                                 },
927                         }
928                 };
929
930                 let pending_forward_info = if next_hop_hmac == [0; 32] {
931                                 #[cfg(test)]
932                                 {
933                                         // In tests, make sure that the initial onion pcket data is, at least, non-0.
934                                         // We could do some fancy randomness test here, but, ehh, whatever.
935                                         // This checks for the issue where you can calculate the path length given the
936                                         // onion data as all the path entries that the originator sent will be here
937                                         // as-is (and were originally 0s).
938                                         // Of course reverse path calculation is still pretty easy given naive routing
939                                         // algorithms, but this fixes the most-obvious case.
940                                         let mut next_bytes = [0; 32];
941                                         chacha_stream.read_exact(&mut next_bytes).unwrap();
942                                         assert_ne!(next_bytes[..], [0; 32][..]);
943                                         chacha_stream.read_exact(&mut next_bytes).unwrap();
944                                         assert_ne!(next_bytes[..], [0; 32][..]);
945                                 }
946
947                                 // OUR PAYMENT!
948                                 // final_expiry_too_soon
949                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
950                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
951                                 }
952                                 // final_incorrect_htlc_amount
953                                 if next_hop_data.amt_to_forward > msg.amount_msat {
954                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
955                                 }
956                                 // final_incorrect_cltv_expiry
957                                 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
958                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
959                                 }
960
961                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
962                                 // message, however that would leak that we are the recipient of this payment, so
963                                 // instead we stay symmetric with the forwarding case, only responding (after a
964                                 // delay) once they've send us a commitment_signed!
965
966                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
967                                         onion_packet: None,
968                                         payment_hash: msg.payment_hash.clone(),
969                                         short_channel_id: 0,
970                                         incoming_shared_secret: shared_secret,
971                                         amt_to_forward: next_hop_data.amt_to_forward,
972                                         outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
973                                 })
974                         } else {
975                                 let mut new_packet_data = [0; 20*65];
976                                 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
977                                 #[cfg(debug_assertions)]
978                                 {
979                                         // Check two things:
980                                         // a) that the behavior of our stream here will return Ok(0) even if the TLV
981                                         //    read above emptied out our buffer and the unwrap() wont needlessly panic
982                                         // b) that we didn't somehow magically end up with extra data.
983                                         let mut t = [0; 1];
984                                         debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
985                                 }
986                                 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
987                                 // fill the onion hop data we'll forward to our next-hop peer.
988                                 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
989
990                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
991
992                                 let blinding_factor = {
993                                         let mut sha = Sha256::engine();
994                                         sha.input(&new_pubkey.serialize()[..]);
995                                         sha.input(&shared_secret);
996                                         Sha256::from_engine(sha).into_inner()
997                                 };
998
999                                 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1000                                         Err(e)
1001                                 } else { Ok(new_pubkey) };
1002
1003                                 let outgoing_packet = msgs::OnionPacket {
1004                                         version: 0,
1005                                         public_key,
1006                                         hop_data: new_packet_data,
1007                                         hmac: next_hop_hmac.clone(),
1008                                 };
1009
1010                                 let short_channel_id = match next_hop_data.format {
1011                                         msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1012                                         msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1013                                         msgs::OnionHopDataFormat::FinalNode => {
1014                                                 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1015                                         },
1016                                 };
1017
1018                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1019                                         onion_packet: Some(outgoing_packet),
1020                                         payment_hash: msg.payment_hash.clone(),
1021                                         short_channel_id: short_channel_id,
1022                                         incoming_shared_secret: shared_secret,
1023                                         amt_to_forward: next_hop_data.amt_to_forward,
1024                                         outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1025                                 })
1026                         };
1027
1028                 channel_state = Some(self.channel_state.lock().unwrap());
1029                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1030                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1031                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1032                                 let forwarding_id = match id_option {
1033                                         None => { // unknown_next_peer
1034                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1035                                         },
1036                                         Some(id) => id.clone(),
1037                                 };
1038                                 if let Some((err, code, chan_update)) = loop {
1039                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1040
1041                                         // Note that we could technically not return an error yet here and just hope
1042                                         // that the connection is reestablished or monitor updated by the time we get
1043                                         // around to doing the actual forward, but better to fail early if we can and
1044                                         // hopefully an attacker trying to path-trace payments cannot make this occur
1045                                         // on a small/per-node/per-channel scale.
1046                                         if !chan.is_live() { // channel_disabled
1047                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1048                                         }
1049                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1050                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1051                                         }
1052                                         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) });
1053                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1054                                                 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())));
1055                                         }
1056                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1057                                                 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())));
1058                                         }
1059                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1060                                         // We want to have at least LATENCY_GRACE_PERIOD_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1061                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS as u32 { // expiry_too_soon
1062                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1063                                         }
1064                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1065                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1066                                         }
1067                                         break None;
1068                                 }
1069                                 {
1070                                         let mut res = Vec::with_capacity(8 + 128);
1071                                         if let Some(chan_update) = chan_update {
1072                                                 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1073                                                         res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1074                                                 }
1075                                                 else if code == 0x1000 | 13 {
1076                                                         res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1077                                                 }
1078                                                 else if code == 0x1000 | 20 {
1079                                                         res.extend_from_slice(&byte_utils::be16_to_array(chan_update.contents.flags));
1080                                                 }
1081                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1082                                         }
1083                                         return_err!(err, code, &res[..]);
1084                                 }
1085                         }
1086                 }
1087
1088                 (pending_forward_info, channel_state.unwrap())
1089         }
1090
1091         /// only fails if the channel does not yet have an assigned short_id
1092         /// May be called with channel_state already locked!
1093         fn get_channel_update(&self, chan: &Channel<ChanSigner>) -> Result<msgs::ChannelUpdate, LightningError> {
1094                 let short_channel_id = match chan.get_short_channel_id() {
1095                         None => return Err(LightningError{err: "Channel not yet established", action: msgs::ErrorAction::IgnoreError}),
1096                         Some(id) => id,
1097                 };
1098
1099                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1100
1101                 let unsigned = msgs::UnsignedChannelUpdate {
1102                         chain_hash: self.genesis_hash,
1103                         short_channel_id: short_channel_id,
1104                         timestamp: chan.get_channel_update_count(),
1105                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1106                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1107                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1108                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1109                         fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1110                         excess_data: Vec::new(),
1111                 };
1112
1113                 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1114                 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1115
1116                 Ok(msgs::ChannelUpdate {
1117                         signature: sig,
1118                         contents: unsigned
1119                 })
1120         }
1121
1122         /// Sends a payment along a given route.
1123         ///
1124         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1125         /// fields for more info.
1126         ///
1127         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1128         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1129         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1130         /// specified in the last hop in the route! Thus, you should probably do your own
1131         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1132         /// payment") and prevent double-sends yourself.
1133         ///
1134         /// May generate a SendHTLCs message event on success, which should be relayed.
1135         ///
1136         /// Raises APIError::RoutError when invalid route or forward parameter
1137         /// (cltv_delta, fee, node public key) is specified.
1138         /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1139         /// (including due to previous monitor update failure or new permanent monitor update failure).
1140         /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1141         /// relevant updates.
1142         ///
1143         /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1144         /// and you may wish to retry via a different route immediately.
1145         /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1146         /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1147         /// the payment via a different route unless you intend to pay twice!
1148         pub fn send_payment(&self, route: Route, payment_hash: PaymentHash) -> Result<(), APIError> {
1149                 if route.hops.len() < 1 || route.hops.len() > 20 {
1150                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1151                 }
1152                 let our_node_id = self.get_our_node_id();
1153                 for (idx, hop) in route.hops.iter().enumerate() {
1154                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1155                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1156                         }
1157                 }
1158
1159                 let (session_priv, prng_seed) = self.keys_manager.get_onion_rand();
1160
1161                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1162
1163                 let onion_keys = secp_call!(onion_utils::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1164                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1165                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height)?;
1166                 if onion_utils::route_size_insane(&onion_payloads) {
1167                         return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1168                 }
1169                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, &payment_hash);
1170
1171                 let _ = self.total_consistency_lock.read().unwrap();
1172
1173                 let mut channel_lock = self.channel_state.lock().unwrap();
1174                 let err: Result<(), _> = loop {
1175
1176                         let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1177                                 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1178                                 Some(id) => id.clone(),
1179                         };
1180
1181                         let channel_state = &mut *channel_lock;
1182                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1183                                 match {
1184                                         if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1185                                                 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1186                                         }
1187                                         if !chan.get().is_live() {
1188                                                 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1189                                         }
1190                                         break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1191                                                 route: route.clone(),
1192                                                 session_priv: session_priv.clone(),
1193                                                 first_hop_htlc_msat: htlc_msat,
1194                                         }, onion_packet), channel_state, chan)
1195                                 } {
1196                                         Some((update_add, commitment_signed, chan_monitor)) => {
1197                                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1198                                                         maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1199                                                         // Note that MonitorUpdateFailed here indicates (per function docs)
1200                                                         // that we will resent the commitment update once we unfree monitor
1201                                                         // updating, so we have to take special care that we don't return
1202                                                         // something else in case we will resend later!
1203                                                         return Err(APIError::MonitorUpdateFailed);
1204                                                 }
1205
1206                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1207                                                         node_id: route.hops.first().unwrap().pubkey,
1208                                                         updates: msgs::CommitmentUpdate {
1209                                                                 update_add_htlcs: vec![update_add],
1210                                                                 update_fulfill_htlcs: Vec::new(),
1211                                                                 update_fail_htlcs: Vec::new(),
1212                                                                 update_fail_malformed_htlcs: Vec::new(),
1213                                                                 update_fee: None,
1214                                                                 commitment_signed,
1215                                                         },
1216                                                 });
1217                                         },
1218                                         None => {},
1219                                 }
1220                         } else { unreachable!(); }
1221                         return Ok(());
1222                 };
1223
1224                 match handle_error!(self, err, route.hops.first().unwrap().pubkey, channel_lock) {
1225                         Ok(_) => unreachable!(),
1226                         Err(e) => { Err(APIError::ChannelUnavailable { err: e.err }) }
1227                 }
1228         }
1229
1230         /// Call this upon creation of a funding transaction for the given channel.
1231         ///
1232         /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1233         /// or your counterparty can steal your funds!
1234         ///
1235         /// Panics if a funding transaction has already been provided for this channel.
1236         ///
1237         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1238         /// be trivially prevented by using unique funding transaction keys per-channel).
1239         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1240                 let _ = self.total_consistency_lock.read().unwrap();
1241
1242                 let (mut chan, msg, chan_monitor) = {
1243                         let mut channel_state = self.channel_state.lock().unwrap();
1244                         let (res, chan) = match channel_state.by_id.remove(temporary_channel_id) {
1245                                 Some(mut chan) => {
1246                                         (chan.get_outbound_funding_created(funding_txo)
1247                                                 .map_err(|e| if let ChannelError::Close(msg) = e {
1248                                                         MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1249                                                 } else { unreachable!(); })
1250                                         , chan)
1251                                 },
1252                                 None => return
1253                         };
1254                         match handle_error!(self, res, chan.get_their_node_id(), channel_state) {
1255                                 Ok(funding_msg) => {
1256                                         (chan, funding_msg.0, funding_msg.1)
1257                                 },
1258                                 Err(_) => { return; }
1259                         }
1260                 };
1261                 // Because we have exclusive ownership of the channel here we can release the channel_state
1262                 // lock before add_update_monitor
1263                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1264                         match e {
1265                                 ChannelMonitorUpdateErr::PermanentFailure => {
1266                                         {
1267                                                 let mut channel_state = self.channel_state.lock().unwrap();
1268                                                 match handle_error!(self, Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", *temporary_channel_id, chan.force_shutdown(), None)), chan.get_their_node_id(), channel_state) {
1269                                                         Err(_) => { return; },
1270                                                         Ok(()) => unreachable!(),
1271                                                 }
1272                                         }
1273                                 },
1274                                 ChannelMonitorUpdateErr::TemporaryFailure => {
1275                                         // Its completely fine to continue with a FundingCreated until the monitor
1276                                         // update is persisted, as long as we don't generate the FundingBroadcastSafe
1277                                         // until the monitor has been safely persisted (as funding broadcast is not,
1278                                         // in fact, safe).
1279                                         chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1280                                 },
1281                         }
1282                 }
1283
1284                 let mut channel_state = self.channel_state.lock().unwrap();
1285                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1286                         node_id: chan.get_their_node_id(),
1287                         msg: msg,
1288                 });
1289                 match channel_state.by_id.entry(chan.channel_id()) {
1290                         hash_map::Entry::Occupied(_) => {
1291                                 panic!("Generated duplicate funding txid?");
1292                         },
1293                         hash_map::Entry::Vacant(e) => {
1294                                 e.insert(chan);
1295                         }
1296                 }
1297         }
1298
1299         fn get_announcement_sigs(&self, chan: &Channel<ChanSigner>) -> Option<msgs::AnnouncementSignatures> {
1300                 if !chan.should_announce() {
1301                         log_trace!(self, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
1302                         return None
1303                 }
1304
1305                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1306                         Ok(res) => res,
1307                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1308                 };
1309                 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1310                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1311
1312                 Some(msgs::AnnouncementSignatures {
1313                         channel_id: chan.channel_id(),
1314                         short_channel_id: chan.get_short_channel_id().unwrap(),
1315                         node_signature: our_node_sig,
1316                         bitcoin_signature: our_bitcoin_sig,
1317                 })
1318         }
1319
1320         /// Processes HTLCs which are pending waiting on random forward delay.
1321         ///
1322         /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1323         /// Will likely generate further events.
1324         pub fn process_pending_htlc_forwards(&self) {
1325                 let _ = self.total_consistency_lock.read().unwrap();
1326
1327                 let mut new_events = Vec::new();
1328                 let mut failed_forwards = Vec::new();
1329                 let mut handle_errors = Vec::new();
1330                 {
1331                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1332                         let channel_state = &mut *channel_state_lock;
1333
1334                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1335                                 if short_chan_id != 0 {
1336                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1337                                                 Some(chan_id) => chan_id.clone(),
1338                                                 None => {
1339                                                         failed_forwards.reserve(pending_forwards.len());
1340                                                         for forward_info in pending_forwards.drain(..) {
1341                                                                 match forward_info {
1342                                                                         HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1343                                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1344                                                                                         short_channel_id: prev_short_channel_id,
1345                                                                                         htlc_id: prev_htlc_id,
1346                                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1347                                                                                 });
1348                                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1349                                                                         },
1350                                                                         HTLCForwardInfo::FailHTLC { .. } => {
1351                                                                                 // Channel went away before we could fail it. This implies
1352                                                                                 // the channel is now on chain and our counterparty is
1353                                                                                 // trying to broadcast the HTLC-Timeout, but that's their
1354                                                                                 // problem, not ours.
1355                                                                         }
1356                                                                 }
1357                                                         }
1358                                                         continue;
1359                                                 }
1360                                         };
1361                                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1362                                                 let mut add_htlc_msgs = Vec::new();
1363                                                 let mut fail_htlc_msgs = Vec::new();
1364                                                 for forward_info in pending_forwards.drain(..) {
1365                                                         match forward_info {
1366                                                                 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1367                                                                         log_trace!(self, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", log_bytes!(forward_info.payment_hash.0), prev_short_channel_id, short_chan_id);
1368                                                                         let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1369                                                                                 short_channel_id: prev_short_channel_id,
1370                                                                                 htlc_id: prev_htlc_id,
1371                                                                                 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1372                                                                         });
1373                                                                         match chan.get_mut().send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, htlc_source.clone(), forward_info.onion_packet.unwrap()) {
1374                                                                                 Err(e) => {
1375                                                                                         if let ChannelError::Ignore(msg) = e {
1376                                                                                                 log_trace!(self, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(forward_info.payment_hash.0), msg);
1377                                                                                         } else {
1378                                                                                                 panic!("Stated return value requirements in send_htlc() were not met");
1379                                                                                         }
1380                                                                                         let chan_update = self.get_channel_update(chan.get()).unwrap();
1381                                                                                         failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1382                                                                                         continue;
1383                                                                                 },
1384                                                                                 Ok(update_add) => {
1385                                                                                         match update_add {
1386                                                                                                 Some(msg) => { add_htlc_msgs.push(msg); },
1387                                                                                                 None => {
1388                                                                                                         // Nothing to do here...we're waiting on a remote
1389                                                                                                         // revoke_and_ack before we can add anymore HTLCs. The Channel
1390                                                                                                         // will automatically handle building the update_add_htlc and
1391                                                                                                         // commitment_signed messages when we can.
1392                                                                                                         // TODO: Do some kind of timer to set the channel as !is_live()
1393                                                                                                         // as we don't really want others relying on us relaying through
1394                                                                                                         // this channel currently :/.
1395                                                                                                 }
1396                                                                                         }
1397                                                                                 }
1398                                                                         }
1399                                                                 },
1400                                                                 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1401                                                                         log_trace!(self, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1402                                                                         match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1403                                                                                 Err(e) => {
1404                                                                                         if let ChannelError::Ignore(msg) = e {
1405                                                                                                 log_trace!(self, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1406                                                                                         } else {
1407                                                                                                 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1408                                                                                         }
1409                                                                                         // fail-backs are best-effort, we probably already have one
1410                                                                                         // pending, and if not that's OK, if not, the channel is on
1411                                                                                         // the chain and sending the HTLC-Timeout is their problem.
1412                                                                                         continue;
1413                                                                                 },
1414                                                                                 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1415                                                                                 Ok(None) => {
1416                                                                                         // Nothing to do here...we're waiting on a remote
1417                                                                                         // revoke_and_ack before we can update the commitment
1418                                                                                         // transaction. The Channel will automatically handle
1419                                                                                         // building the update_fail_htlc and commitment_signed
1420                                                                                         // messages when we can.
1421                                                                                         // We don't need any kind of timer here as they should fail
1422                                                                                         // the channel onto the chain if they can't get our
1423                                                                                         // update_fail_htlc in time, it's not our problem.
1424                                                                                 }
1425                                                                         }
1426                                                                 },
1427                                                         }
1428                                                 }
1429
1430                                                 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1431                                                         let (commitment_msg, monitor) = match chan.get_mut().send_commitment() {
1432                                                                 Ok(res) => res,
1433                                                                 Err(e) => {
1434                                                                         // We surely failed send_commitment due to bad keys, in that case
1435                                                                         // close channel and then send error message to peer.
1436                                                                         let their_node_id = chan.get().get_their_node_id();
1437                                                                         let err: Result<(), _>  = match e {
1438                                                                                 ChannelError::Ignore(_) => {
1439                                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1440                                                                                 },
1441                                                                                 ChannelError::Close(msg) => {
1442                                                                                         log_trace!(self, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1443                                                                                         let (channel_id, mut channel) = chan.remove_entry();
1444                                                                                         if let Some(short_id) = channel.get_short_channel_id() {
1445                                                                                                 channel_state.short_to_id.remove(&short_id);
1446                                                                                         }
1447                                                                                         Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(), self.get_channel_update(&channel).ok()))
1448                                                                                 },
1449                                                                                 ChannelError::CloseDelayBroadcast { .. } => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
1450                                                                         };
1451                                                                         match handle_error!(self, err, their_node_id, channel_state) {
1452                                                                                 Ok(_) => unreachable!(),
1453                                                                                 Err(_) => { continue; },
1454                                                                         }
1455                                                                 }
1456                                                         };
1457                                                         if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1458                                                                 handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1459                                                                 continue;
1460                                                         }
1461                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1462                                                                 node_id: chan.get().get_their_node_id(),
1463                                                                 updates: msgs::CommitmentUpdate {
1464                                                                         update_add_htlcs: add_htlc_msgs,
1465                                                                         update_fulfill_htlcs: Vec::new(),
1466                                                                         update_fail_htlcs: fail_htlc_msgs,
1467                                                                         update_fail_malformed_htlcs: Vec::new(),
1468                                                                         update_fee: None,
1469                                                                         commitment_signed: commitment_msg,
1470                                                                 },
1471                                                         });
1472                                                 }
1473                                         } else {
1474                                                 unreachable!();
1475                                         }
1476                                 } else {
1477                                         for forward_info in pending_forwards.drain(..) {
1478                                                 match forward_info {
1479                                                         HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1480                                                                 let prev_hop_data = HTLCPreviousHopData {
1481                                                                         short_channel_id: prev_short_channel_id,
1482                                                                         htlc_id: prev_htlc_id,
1483                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1484                                                                 };
1485                                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1486                                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push((forward_info.amt_to_forward, prev_hop_data)),
1487                                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![(forward_info.amt_to_forward, prev_hop_data)]); },
1488                                                                 };
1489                                                                 new_events.push(events::Event::PaymentReceived {
1490                                                                         payment_hash: forward_info.payment_hash,
1491                                                                         amt: forward_info.amt_to_forward,
1492                                                                 });
1493                                                         },
1494                                                         HTLCForwardInfo::FailHTLC { .. } => {
1495                                                                 panic!("Got pending fail of our own HTLC");
1496                                                         }
1497                                                 }
1498                                         }
1499                                 }
1500                         }
1501                 }
1502
1503                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1504                         match update {
1505                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1506                                 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() }),
1507                         };
1508                 }
1509
1510                 if handle_errors.len() > 0 {
1511                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1512                         for (their_node_id, err) in handle_errors.drain(..) {
1513                                 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
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         /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
1523         /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
1524         /// to inform the network about the uselessness of these channels.
1525         ///
1526         /// This method handles all the details, and must be called roughly once per minute.
1527         pub fn timer_chan_freshness_every_min(&self) {
1528                 let _ = self.total_consistency_lock.read().unwrap();
1529                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1530                 let channel_state = &mut *channel_state_lock;
1531                 for (_, chan) in channel_state.by_id.iter_mut() {
1532                         if chan.is_disabled_staged() && !chan.is_live() {
1533                                 if let Ok(update) = self.get_channel_update(&chan) {
1534                                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1535                                                 msg: update
1536                                         });
1537                                 }
1538                                 chan.to_fresh();
1539                         } else if chan.is_disabled_staged() && chan.is_live() {
1540                                 chan.to_fresh();
1541                         } else if chan.is_disabled_marked() {
1542                                 chan.to_disabled_staged();
1543                         }
1544                 }
1545         }
1546
1547         /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1548         /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1549         /// along the path (including in our own channel on which we received it).
1550         /// Returns false if no payment was found to fail backwards, true if the process of failing the
1551         /// HTLC backwards has been started.
1552         pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
1553                 let _ = self.total_consistency_lock.read().unwrap();
1554
1555                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1556                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1557                 if let Some(mut sources) = removed_source {
1558                         for (recvd_value, htlc_with_hash) in sources.drain(..) {
1559                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1560                                 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1561                                                 HTLCSource::PreviousHopData(htlc_with_hash), payment_hash,
1562                                                 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: byte_utils::be64_to_array(recvd_value).to_vec() });
1563                         }
1564                         true
1565                 } else { false }
1566         }
1567
1568         /// Fails an HTLC backwards to the sender of it to us.
1569         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1570         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1571         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1572         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1573         /// still-available channels.
1574         fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
1575                 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
1576                 //identify whether we sent it or not based on the (I presume) very different runtime
1577                 //between the branches here. We should make this async and move it into the forward HTLCs
1578                 //timer handling.
1579                 match source {
1580                         HTLCSource::OutboundRoute { ref route, .. } => {
1581                                 log_trace!(self, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1582                                 mem::drop(channel_state_lock);
1583                                 match &onion_error {
1584                                         &HTLCFailReason::LightningError { ref err } => {
1585 #[cfg(test)]
1586                                                 let (channel_update, payment_retryable, onion_error_code) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1587 #[cfg(not(test))]
1588                                                 let (channel_update, payment_retryable, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1589                                                 // TODO: If we decided to blame ourselves (or one of our channels) in
1590                                                 // process_onion_failure we should close that channel as it implies our
1591                                                 // next-hop is needlessly blaming us!
1592                                                 if let Some(update) = channel_update {
1593                                                         self.channel_state.lock().unwrap().pending_msg_events.push(
1594                                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1595                                                                         update,
1596                                                                 }
1597                                                         );
1598                                                 }
1599                                                 self.pending_events.lock().unwrap().push(
1600                                                         events::Event::PaymentFailed {
1601                                                                 payment_hash: payment_hash.clone(),
1602                                                                 rejected_by_dest: !payment_retryable,
1603 #[cfg(test)]
1604                                                                 error_code: onion_error_code
1605                                                         }
1606                                                 );
1607                                         },
1608                                         &HTLCFailReason::Reason {
1609 #[cfg(test)]
1610                                                         ref failure_code,
1611                                                         .. } => {
1612                                                 // we get a fail_malformed_htlc from the first hop
1613                                                 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
1614                                                 // failures here, but that would be insufficient as Router::get_route
1615                                                 // generally ignores its view of our own channels as we provide them via
1616                                                 // ChannelDetails.
1617                                                 // TODO: For non-temporary failures, we really should be closing the
1618                                                 // channel here as we apparently can't relay through them anyway.
1619                                                 self.pending_events.lock().unwrap().push(
1620                                                         events::Event::PaymentFailed {
1621                                                                 payment_hash: payment_hash.clone(),
1622                                                                 rejected_by_dest: route.hops.len() == 1,
1623 #[cfg(test)]
1624                                                                 error_code: Some(*failure_code),
1625                                                         }
1626                                                 );
1627                                         }
1628                                 }
1629                         },
1630                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1631                                 let err_packet = match onion_error {
1632                                         HTLCFailReason::Reason { failure_code, data } => {
1633                                                 log_trace!(self, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
1634                                                 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1635                                                 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1636                                         },
1637                                         HTLCFailReason::LightningError { err } => {
1638                                                 log_trace!(self, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
1639                                                 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1640                                         }
1641                                 };
1642
1643                                 let mut forward_event = None;
1644                                 if channel_state_lock.forward_htlcs.is_empty() {
1645                                         forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
1646                                 }
1647                                 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
1648                                         hash_map::Entry::Occupied(mut entry) => {
1649                                                 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
1650                                         },
1651                                         hash_map::Entry::Vacant(entry) => {
1652                                                 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
1653                                         }
1654                                 }
1655                                 mem::drop(channel_state_lock);
1656                                 if let Some(time) = forward_event {
1657                                         let mut pending_events = self.pending_events.lock().unwrap();
1658                                         pending_events.push(events::Event::PendingHTLCsForwardable {
1659                                                 time_forwardable: time
1660                                         });
1661                                 }
1662                         },
1663                 }
1664         }
1665
1666         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1667         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1668         /// should probably kick the net layer to go send messages if this returns true!
1669         ///
1670         /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
1671         /// available within a few percent of the expected amount. This is critical for several
1672         /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
1673         /// payment_preimage without having provided the full value and b) it avoids certain
1674         /// privacy-breaking recipient-probing attacks which may reveal payment activity to
1675         /// motivated attackers.
1676         ///
1677         /// May panic if called except in response to a PaymentReceived event.
1678         pub fn claim_funds(&self, payment_preimage: PaymentPreimage, expected_amount: u64) -> bool {
1679                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1680
1681                 let _ = self.total_consistency_lock.read().unwrap();
1682
1683                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1684                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1685                 if let Some(mut sources) = removed_source {
1686                         for (received_amount, htlc_with_hash) in sources.drain(..) {
1687                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1688                                 if received_amount < expected_amount || received_amount > expected_amount * 2 {
1689                                         let mut htlc_msat_data = byte_utils::be64_to_array(received_amount).to_vec();
1690                                         let mut height_data = byte_utils::be32_to_array(self.latest_block_height.load(Ordering::Acquire) as u32).to_vec();
1691                                         htlc_msat_data.append(&mut height_data);
1692                                         self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1693                                                                          HTLCSource::PreviousHopData(htlc_with_hash), &payment_hash,
1694                                                                          HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_data });
1695                                 } else {
1696                                         self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1697                                 }
1698                         }
1699                         true
1700                 } else { false }
1701         }
1702         fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
1703                 let (their_node_id, err) = loop {
1704                         match source {
1705                                 HTLCSource::OutboundRoute { .. } => {
1706                                         mem::drop(channel_state_lock);
1707                                         let mut pending_events = self.pending_events.lock().unwrap();
1708                                         pending_events.push(events::Event::PaymentSent {
1709                                                 payment_preimage
1710                                         });
1711                                 },
1712                                 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1713                                         //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1714                                         let channel_state = &mut *channel_state_lock;
1715
1716                                         let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1717                                                 Some(chan_id) => chan_id.clone(),
1718                                                 None => {
1719                                                         // TODO: There is probably a channel manager somewhere that needs to
1720                                                         // learn the preimage as the channel already hit the chain and that's
1721                                                         // why it's missing.
1722                                                         return
1723                                                 }
1724                                         };
1725
1726                                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
1727                                                 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
1728                                                 match chan.get_mut().get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1729                                                         Ok((msgs, monitor_option)) => {
1730                                                                 if let Some(chan_monitor) = monitor_option {
1731                                                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1732                                                                                 if was_frozen_for_monitor {
1733                                                                                         assert!(msgs.is_none());
1734                                                                                 } else {
1735                                                                                         break (chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()));
1736                                                                                 }
1737                                                                         }
1738                                                                 }
1739                                                                 if let Some((msg, commitment_signed)) = msgs {
1740                                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1741                                                                                 node_id: chan.get().get_their_node_id(),
1742                                                                                 updates: msgs::CommitmentUpdate {
1743                                                                                         update_add_htlcs: Vec::new(),
1744                                                                                         update_fulfill_htlcs: vec![msg],
1745                                                                                         update_fail_htlcs: Vec::new(),
1746                                                                                         update_fail_malformed_htlcs: Vec::new(),
1747                                                                                         update_fee: None,
1748                                                                                         commitment_signed,
1749                                                                                 }
1750                                                                         });
1751                                                                 }
1752                                                         },
1753                                                         Err(_e) => {
1754                                                                 // TODO: There is probably a channel manager somewhere that needs to
1755                                                                 // learn the preimage as the channel may be about to hit the chain.
1756                                                                 //TODO: Do something with e?
1757                                                                 return
1758                                                         },
1759                                                 }
1760                                         } else { unreachable!(); }
1761                                 },
1762                         }
1763                         return;
1764                 };
1765
1766                 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1767         }
1768
1769         /// Gets the node_id held by this ChannelManager
1770         pub fn get_our_node_id(&self) -> PublicKey {
1771                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1772         }
1773
1774         /// Used to restore channels to normal operation after a
1775         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1776         /// operation.
1777         pub fn test_restore_channel_monitor(&self) {
1778                 let mut close_results = Vec::new();
1779                 let mut htlc_forwards = Vec::new();
1780                 let mut htlc_failures = Vec::new();
1781                 let mut pending_events = Vec::new();
1782                 let _ = self.total_consistency_lock.read().unwrap();
1783
1784                 {
1785                         let mut channel_lock = self.channel_state.lock().unwrap();
1786                         let channel_state = &mut *channel_lock;
1787                         let short_to_id = &mut channel_state.short_to_id;
1788                         let pending_msg_events = &mut channel_state.pending_msg_events;
1789                         channel_state.by_id.retain(|_, channel| {
1790                                 if channel.is_awaiting_monitor_update() {
1791                                         let chan_monitor = channel.channel_monitor().clone();
1792                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1793                                                 match e {
1794                                                         ChannelMonitorUpdateErr::PermanentFailure => {
1795                                                                 // TODO: There may be some pending HTLCs that we intended to fail
1796                                                                 // backwards when a monitor update failed. We should make sure
1797                                                                 // knowledge of those gets moved into the appropriate in-memory
1798                                                                 // ChannelMonitor and they get failed backwards once we get
1799                                                                 // on-chain confirmations.
1800                                                                 // Note I think #198 addresses this, so once it's merged a test
1801                                                                 // should be written.
1802                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1803                                                                         short_to_id.remove(&short_id);
1804                                                                 }
1805                                                                 close_results.push(channel.force_shutdown());
1806                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1807                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1808                                                                                 msg: update
1809                                                                         });
1810                                                                 }
1811                                                                 false
1812                                                         },
1813                                                         ChannelMonitorUpdateErr::TemporaryFailure => true,
1814                                                 }
1815                                         } else {
1816                                                 let (raa, commitment_update, order, pending_forwards, mut pending_failures, needs_broadcast_safe, funding_locked) = channel.monitor_updating_restored();
1817                                                 if !pending_forwards.is_empty() {
1818                                                         htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1819                                                 }
1820                                                 htlc_failures.append(&mut pending_failures);
1821
1822                                                 macro_rules! handle_cs { () => {
1823                                                         if let Some(update) = commitment_update {
1824                                                                 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1825                                                                         node_id: channel.get_their_node_id(),
1826                                                                         updates: update,
1827                                                                 });
1828                                                         }
1829                                                 } }
1830                                                 macro_rules! handle_raa { () => {
1831                                                         if let Some(revoke_and_ack) = raa {
1832                                                                 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1833                                                                         node_id: channel.get_their_node_id(),
1834                                                                         msg: revoke_and_ack,
1835                                                                 });
1836                                                         }
1837                                                 } }
1838                                                 match order {
1839                                                         RAACommitmentOrder::CommitmentFirst => {
1840                                                                 handle_cs!();
1841                                                                 handle_raa!();
1842                                                         },
1843                                                         RAACommitmentOrder::RevokeAndACKFirst => {
1844                                                                 handle_raa!();
1845                                                                 handle_cs!();
1846                                                         },
1847                                                 }
1848                                                 if needs_broadcast_safe {
1849                                                         pending_events.push(events::Event::FundingBroadcastSafe {
1850                                                                 funding_txo: channel.get_funding_txo().unwrap(),
1851                                                                 user_channel_id: channel.get_user_id(),
1852                                                         });
1853                                                 }
1854                                                 if let Some(msg) = funding_locked {
1855                                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1856                                                                 node_id: channel.get_their_node_id(),
1857                                                                 msg,
1858                                                         });
1859                                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
1860                                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1861                                                                         node_id: channel.get_their_node_id(),
1862                                                                         msg: announcement_sigs,
1863                                                                 });
1864                                                         }
1865                                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1866                                                 }
1867                                                 true
1868                                         }
1869                                 } else { true }
1870                         });
1871                 }
1872
1873                 self.pending_events.lock().unwrap().append(&mut pending_events);
1874
1875                 for failure in htlc_failures.drain(..) {
1876                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1877                 }
1878                 self.forward_htlcs(&mut htlc_forwards[..]);
1879
1880                 for res in close_results.drain(..) {
1881                         self.finish_force_close_channel(res);
1882                 }
1883         }
1884
1885         fn internal_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1886                 if msg.chain_hash != self.genesis_hash {
1887                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1888                 }
1889
1890                 let channel = Channel::new_from_req(&*self.fee_estimator, &self.keys_manager, their_node_id.clone(), their_features, msg, 0, Arc::clone(&self.logger), &self.default_configuration)
1891                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1892                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1893                 let channel_state = &mut *channel_state_lock;
1894                 match channel_state.by_id.entry(channel.channel_id()) {
1895                         hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1896                         hash_map::Entry::Vacant(entry) => {
1897                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1898                                         node_id: their_node_id.clone(),
1899                                         msg: channel.get_accept_channel(),
1900                                 });
1901                                 entry.insert(channel);
1902                         }
1903                 }
1904                 Ok(())
1905         }
1906
1907         fn internal_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1908                 let (value, output_script, user_id) = {
1909                         let mut channel_lock = self.channel_state.lock().unwrap();
1910                         let channel_state = &mut *channel_lock;
1911                         match channel_state.by_id.entry(msg.temporary_channel_id) {
1912                                 hash_map::Entry::Occupied(mut chan) => {
1913                                         if chan.get().get_their_node_id() != *their_node_id {
1914                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1915                                         }
1916                                         try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
1917                                         (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1918                                 },
1919                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1920                         }
1921                 };
1922                 let mut pending_events = self.pending_events.lock().unwrap();
1923                 pending_events.push(events::Event::FundingGenerationReady {
1924                         temporary_channel_id: msg.temporary_channel_id,
1925                         channel_value_satoshis: value,
1926                         output_script: output_script,
1927                         user_channel_id: user_id,
1928                 });
1929                 Ok(())
1930         }
1931
1932         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1933                 let ((funding_msg, monitor_update), mut chan) = {
1934                         let mut channel_lock = self.channel_state.lock().unwrap();
1935                         let channel_state = &mut *channel_lock;
1936                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1937                                 hash_map::Entry::Occupied(mut chan) => {
1938                                         if chan.get().get_their_node_id() != *their_node_id {
1939                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1940                                         }
1941                                         (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1942                                 },
1943                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1944                         }
1945                 };
1946                 // Because we have exclusive ownership of the channel here we can release the channel_state
1947                 // lock before add_update_monitor
1948                 if let Err(e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1949                         match e {
1950                                 ChannelMonitorUpdateErr::PermanentFailure => {
1951                                         // Note that we reply with the new channel_id in error messages if we gave up on the
1952                                         // channel, not the temporary_channel_id. This is compatible with ourselves, but the
1953                                         // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
1954                                         // any messages referencing a previously-closed channel anyway.
1955                                         return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", funding_msg.channel_id, chan.force_shutdown(), None));
1956                                 },
1957                                 ChannelMonitorUpdateErr::TemporaryFailure => {
1958                                         // There's no problem signing a counterparty's funding transaction if our monitor
1959                                         // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
1960                                         // accepted payment from yet. We do, however, need to wait to send our funding_locked
1961                                         // until we have persisted our monitor.
1962                                         chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1963                                 },
1964                         }
1965                 }
1966                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1967                 let channel_state = &mut *channel_state_lock;
1968                 match channel_state.by_id.entry(funding_msg.channel_id) {
1969                         hash_map::Entry::Occupied(_) => {
1970                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1971                         },
1972                         hash_map::Entry::Vacant(e) => {
1973                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1974                                         node_id: their_node_id.clone(),
1975                                         msg: funding_msg,
1976                                 });
1977                                 e.insert(chan);
1978                         }
1979                 }
1980                 Ok(())
1981         }
1982
1983         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1984                 let (funding_txo, user_id) = {
1985                         let mut channel_lock = self.channel_state.lock().unwrap();
1986                         let channel_state = &mut *channel_lock;
1987                         match channel_state.by_id.entry(msg.channel_id) {
1988                                 hash_map::Entry::Occupied(mut chan) => {
1989                                         if chan.get().get_their_node_id() != *their_node_id {
1990                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1991                                         }
1992                                         let chan_monitor = try_chan_entry!(self, chan.get_mut().funding_signed(&msg), channel_state, chan);
1993                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1994                                                 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
1995                                         }
1996                                         (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
1997                                 },
1998                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1999                         }
2000                 };
2001                 let mut pending_events = self.pending_events.lock().unwrap();
2002                 pending_events.push(events::Event::FundingBroadcastSafe {
2003                         funding_txo: funding_txo,
2004                         user_channel_id: user_id,
2005                 });
2006                 Ok(())
2007         }
2008
2009         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2010                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2011                 let channel_state = &mut *channel_state_lock;
2012                 match channel_state.by_id.entry(msg.channel_id) {
2013                         hash_map::Entry::Occupied(mut chan) => {
2014                                 if chan.get().get_their_node_id() != *their_node_id {
2015                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2016                                 }
2017                                 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2018                                 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2019                                         log_trace!(self, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
2020                                         // If we see locking block before receiving remote funding_locked, we broadcast our
2021                                         // announcement_sigs at remote funding_locked reception. If we receive remote
2022                                         // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2023                                         // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2024                                         // the order of the events but our peer may not receive it due to disconnection. The specs
2025                                         // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2026                                         // connection in the future if simultaneous misses by both peers due to network/hardware
2027                                         // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2028                                         // to be received, from then sigs are going to be flood to the whole network.
2029                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2030                                                 node_id: their_node_id.clone(),
2031                                                 msg: announcement_sigs,
2032                                         });
2033                                 }
2034                                 Ok(())
2035                         },
2036                         hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2037                 }
2038         }
2039
2040         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2041                 let (mut dropped_htlcs, chan_option) = {
2042                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2043                         let channel_state = &mut *channel_state_lock;
2044
2045                         match channel_state.by_id.entry(msg.channel_id.clone()) {
2046                                 hash_map::Entry::Occupied(mut chan_entry) => {
2047                                         if chan_entry.get().get_their_node_id() != *their_node_id {
2048                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2049                                         }
2050                                         let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg), channel_state, chan_entry);
2051                                         if let Some(msg) = shutdown {
2052                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2053                                                         node_id: their_node_id.clone(),
2054                                                         msg,
2055                                                 });
2056                                         }
2057                                         if let Some(msg) = closing_signed {
2058                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2059                                                         node_id: their_node_id.clone(),
2060                                                         msg,
2061                                                 });
2062                                         }
2063                                         if chan_entry.get().is_shutdown() {
2064                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2065                                                         channel_state.short_to_id.remove(&short_id);
2066                                                 }
2067                                                 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2068                                         } else { (dropped_htlcs, None) }
2069                                 },
2070                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2071                         }
2072                 };
2073                 for htlc_source in dropped_htlcs.drain(..) {
2074                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
2075                 }
2076                 if let Some(chan) = chan_option {
2077                         if let Ok(update) = self.get_channel_update(&chan) {
2078                                 let mut channel_state = self.channel_state.lock().unwrap();
2079                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2080                                         msg: update
2081                                 });
2082                         }
2083                 }
2084                 Ok(())
2085         }
2086
2087         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2088                 let (tx, chan_option) = {
2089                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2090                         let channel_state = &mut *channel_state_lock;
2091                         match channel_state.by_id.entry(msg.channel_id.clone()) {
2092                                 hash_map::Entry::Occupied(mut chan_entry) => {
2093                                         if chan_entry.get().get_their_node_id() != *their_node_id {
2094                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2095                                         }
2096                                         let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg), channel_state, chan_entry);
2097                                         if let Some(msg) = closing_signed {
2098                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2099                                                         node_id: their_node_id.clone(),
2100                                                         msg,
2101                                                 });
2102                                         }
2103                                         if tx.is_some() {
2104                                                 // We're done with this channel, we've got a signed closing transaction and
2105                                                 // will send the closing_signed back to the remote peer upon return. This
2106                                                 // also implies there are no pending HTLCs left on the channel, so we can
2107                                                 // fully delete it from tracking (the channel monitor is still around to
2108                                                 // watch for old state broadcasts)!
2109                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2110                                                         channel_state.short_to_id.remove(&short_id);
2111                                                 }
2112                                                 (tx, Some(chan_entry.remove_entry().1))
2113                                         } else { (tx, None) }
2114                                 },
2115                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2116                         }
2117                 };
2118                 if let Some(broadcast_tx) = tx {
2119                         log_trace!(self, "Broadcast onchain {}", log_tx!(broadcast_tx));
2120                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2121                 }
2122                 if let Some(chan) = chan_option {
2123                         if let Ok(update) = self.get_channel_update(&chan) {
2124                                 let mut channel_state = self.channel_state.lock().unwrap();
2125                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2126                                         msg: update
2127                                 });
2128                         }
2129                 }
2130                 Ok(())
2131         }
2132
2133         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2134                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2135                 //determine the state of the payment based on our response/if we forward anything/the time
2136                 //we take to respond. We should take care to avoid allowing such an attack.
2137                 //
2138                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2139                 //us repeatedly garbled in different ways, and compare our error messages, which are
2140                 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2141                 //but we should prevent it anyway.
2142
2143                 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2144                 let channel_state = &mut *channel_state_lock;
2145
2146                 match channel_state.by_id.entry(msg.channel_id) {
2147                         hash_map::Entry::Occupied(mut chan) => {
2148                                 if chan.get().get_their_node_id() != *their_node_id {
2149                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2150                                 }
2151                                 if !chan.get().is_usable() {
2152                                         // If the update_add is completely bogus, the call will Err and we will close,
2153                                         // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2154                                         // want to reject the new HTLC and fail it backwards instead of forwarding.
2155                                         if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2156                                                 let chan_update = self.get_channel_update(chan.get());
2157                                                 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2158                                                         channel_id: msg.channel_id,
2159                                                         htlc_id: msg.htlc_id,
2160                                                         reason: if let Ok(update) = chan_update {
2161                                                                 // TODO: Note that |20 is defined as "channel FROM the processing
2162                                                                 // node has been disabled" (emphasis mine), which seems to imply
2163                                                                 // that we can't return |20 for an inbound channel being disabled.
2164                                                                 // This probably needs a spec update but should definitely be
2165                                                                 // allowed.
2166                                                                 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &{
2167                                                                         let mut res = Vec::with_capacity(8 + 128);
2168                                                                         res.extend_from_slice(&byte_utils::be16_to_array(update.contents.flags));
2169                                                                         res.extend_from_slice(&update.encode_with_len()[..]);
2170                                                                         res
2171                                                                 }[..])
2172                                                         } else {
2173                                                                 // This can only happen if the channel isn't in the fully-funded
2174                                                                 // state yet, implying our counterparty is trying to route payments
2175                                                                 // over the channel back to themselves (cause no one else should
2176                                                                 // know the short_id is a lightning channel yet). We should have no
2177                                                                 // problem just calling this unknown_next_peer
2178                                                                 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2179                                                         },
2180                                                 }));
2181                                         }
2182                                 }
2183                                 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2184                         },
2185                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2186                 }
2187                 Ok(())
2188         }
2189
2190         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2191                 let mut channel_lock = self.channel_state.lock().unwrap();
2192                 let htlc_source = {
2193                         let channel_state = &mut *channel_lock;
2194                         match channel_state.by_id.entry(msg.channel_id) {
2195                                 hash_map::Entry::Occupied(mut chan) => {
2196                                         if chan.get().get_their_node_id() != *their_node_id {
2197                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2198                                         }
2199                                         try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2200                                 },
2201                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2202                         }
2203                 };
2204                 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2205                 Ok(())
2206         }
2207
2208         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2209                 let mut channel_lock = self.channel_state.lock().unwrap();
2210                 let channel_state = &mut *channel_lock;
2211                 match channel_state.by_id.entry(msg.channel_id) {
2212                         hash_map::Entry::Occupied(mut chan) => {
2213                                 if chan.get().get_their_node_id() != *their_node_id {
2214                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2215                                 }
2216                                 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2217                         },
2218                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2219                 }
2220                 Ok(())
2221         }
2222
2223         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2224                 let mut channel_lock = self.channel_state.lock().unwrap();
2225                 let channel_state = &mut *channel_lock;
2226                 match channel_state.by_id.entry(msg.channel_id) {
2227                         hash_map::Entry::Occupied(mut chan) => {
2228                                 if chan.get().get_their_node_id() != *their_node_id {
2229                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2230                                 }
2231                                 if (msg.failure_code & 0x8000) == 0 {
2232                                         let chan_err: ChannelError<ChanSigner> = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set");
2233                                         try_chan_entry!(self, Err(chan_err), channel_state, chan);
2234                                 }
2235                                 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);
2236                                 Ok(())
2237                         },
2238                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2239                 }
2240         }
2241
2242         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2243                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2244                 let channel_state = &mut *channel_state_lock;
2245                 match channel_state.by_id.entry(msg.channel_id) {
2246                         hash_map::Entry::Occupied(mut chan) => {
2247                                 if chan.get().get_their_node_id() != *their_node_id {
2248                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2249                                 }
2250                                 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) =
2251                                         try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &*self.fee_estimator), channel_state, chan);
2252                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2253                                         return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2254                                         //TODO: Rebroadcast closing_signed if present on monitor update restoration
2255                                 }
2256                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2257                                         node_id: their_node_id.clone(),
2258                                         msg: revoke_and_ack,
2259                                 });
2260                                 if let Some(msg) = commitment_signed {
2261                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2262                                                 node_id: their_node_id.clone(),
2263                                                 updates: msgs::CommitmentUpdate {
2264                                                         update_add_htlcs: Vec::new(),
2265                                                         update_fulfill_htlcs: Vec::new(),
2266                                                         update_fail_htlcs: Vec::new(),
2267                                                         update_fail_malformed_htlcs: Vec::new(),
2268                                                         update_fee: None,
2269                                                         commitment_signed: msg,
2270                                                 },
2271                                         });
2272                                 }
2273                                 if let Some(msg) = closing_signed {
2274                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2275                                                 node_id: their_node_id.clone(),
2276                                                 msg,
2277                                         });
2278                                 }
2279                                 Ok(())
2280                         },
2281                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2282                 }
2283         }
2284
2285         #[inline]
2286         fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2287                 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2288                         let mut forward_event = None;
2289                         if !pending_forwards.is_empty() {
2290                                 let mut channel_state = self.channel_state.lock().unwrap();
2291                                 if channel_state.forward_htlcs.is_empty() {
2292                                         forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2293                                 }
2294                                 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2295                                         match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2296                                                 hash_map::Entry::Occupied(mut entry) => {
2297                                                         entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info });
2298                                                 },
2299                                                 hash_map::Entry::Vacant(entry) => {
2300                                                         entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info }));
2301                                                 }
2302                                         }
2303                                 }
2304                         }
2305                         match forward_event {
2306                                 Some(time) => {
2307                                         let mut pending_events = self.pending_events.lock().unwrap();
2308                                         pending_events.push(events::Event::PendingHTLCsForwardable {
2309                                                 time_forwardable: time
2310                                         });
2311                                 }
2312                                 None => {},
2313                         }
2314                 }
2315         }
2316
2317         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2318                 let (pending_forwards, mut pending_failures, short_channel_id) = {
2319                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2320                         let channel_state = &mut *channel_state_lock;
2321                         match channel_state.by_id.entry(msg.channel_id) {
2322                                 hash_map::Entry::Occupied(mut chan) => {
2323                                         if chan.get().get_their_node_id() != *their_node_id {
2324                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2325                                         }
2326                                         let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2327                                         let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) =
2328                                                 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &*self.fee_estimator), channel_state, chan);
2329                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2330                                                 if was_frozen_for_monitor {
2331                                                         assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2332                                                         return Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA"));
2333                                                 } else {
2334                                                         return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures);
2335                                                 }
2336                                         }
2337                                         if let Some(updates) = commitment_update {
2338                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2339                                                         node_id: their_node_id.clone(),
2340                                                         updates,
2341                                                 });
2342                                         }
2343                                         if let Some(msg) = closing_signed {
2344                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2345                                                         node_id: their_node_id.clone(),
2346                                                         msg,
2347                                                 });
2348                                         }
2349                                         (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2350                                 },
2351                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2352                         }
2353                 };
2354                 for failure in pending_failures.drain(..) {
2355                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2356                 }
2357                 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2358
2359                 Ok(())
2360         }
2361
2362         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2363                 let mut channel_lock = self.channel_state.lock().unwrap();
2364                 let channel_state = &mut *channel_lock;
2365                 match channel_state.by_id.entry(msg.channel_id) {
2366                         hash_map::Entry::Occupied(mut chan) => {
2367                                 if chan.get().get_their_node_id() != *their_node_id {
2368                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2369                                 }
2370                                 try_chan_entry!(self, chan.get_mut().update_fee(&*self.fee_estimator, &msg), channel_state, chan);
2371                         },
2372                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2373                 }
2374                 Ok(())
2375         }
2376
2377         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2378                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2379                 let channel_state = &mut *channel_state_lock;
2380
2381                 match channel_state.by_id.entry(msg.channel_id) {
2382                         hash_map::Entry::Occupied(mut chan) => {
2383                                 if chan.get().get_their_node_id() != *their_node_id {
2384                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2385                                 }
2386                                 if !chan.get().is_usable() {
2387                                         return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: msgs::ErrorAction::IgnoreError}));
2388                                 }
2389
2390                                 let our_node_id = self.get_our_node_id();
2391                                 let (announcement, our_bitcoin_sig) =
2392                                         try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2393
2394                                 let were_node_one = announcement.node_id_1 == our_node_id;
2395                                 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2396                                 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2397                                                 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2398                                         let chan_err: ChannelError<ChanSigner> = ChannelError::Close("Bad announcement_signatures node_signature");
2399                                         try_chan_entry!(self, Err(chan_err), channel_state, chan);
2400                                 }
2401
2402                                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2403
2404                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2405                                         msg: msgs::ChannelAnnouncement {
2406                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2407                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2408                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2409                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2410                                                 contents: announcement,
2411                                         },
2412                                         update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2413                                 });
2414                         },
2415                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2416                 }
2417                 Ok(())
2418         }
2419
2420         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2421                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2422                 let channel_state = &mut *channel_state_lock;
2423
2424                 match channel_state.by_id.entry(msg.channel_id) {
2425                         hash_map::Entry::Occupied(mut chan) => {
2426                                 if chan.get().get_their_node_id() != *their_node_id {
2427                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2428                                 }
2429                                 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, mut order, shutdown) =
2430                                         try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2431                                 if let Some(monitor) = channel_monitor {
2432                                         if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2433                                                 // channel_reestablish doesn't guarantee the order it returns is sensical
2434                                                 // for the messages it returns, but if we're setting what messages to
2435                                                 // re-transmit on monitor update success, we need to make sure it is sane.
2436                                                 if revoke_and_ack.is_none() {
2437                                                         order = RAACommitmentOrder::CommitmentFirst;
2438                                                 }
2439                                                 if commitment_update.is_none() {
2440                                                         order = RAACommitmentOrder::RevokeAndACKFirst;
2441                                                 }
2442                                                 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
2443                                                 //TODO: Resend the funding_locked if needed once we get the monitor running again
2444                                         }
2445                                 }
2446                                 if let Some(msg) = funding_locked {
2447                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2448                                                 node_id: their_node_id.clone(),
2449                                                 msg
2450                                         });
2451                                 }
2452                                 macro_rules! send_raa { () => {
2453                                         if let Some(msg) = revoke_and_ack {
2454                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2455                                                         node_id: their_node_id.clone(),
2456                                                         msg
2457                                                 });
2458                                         }
2459                                 } }
2460                                 macro_rules! send_cu { () => {
2461                                         if let Some(updates) = commitment_update {
2462                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2463                                                         node_id: their_node_id.clone(),
2464                                                         updates
2465                                                 });
2466                                         }
2467                                 } }
2468                                 match order {
2469                                         RAACommitmentOrder::RevokeAndACKFirst => {
2470                                                 send_raa!();
2471                                                 send_cu!();
2472                                         },
2473                                         RAACommitmentOrder::CommitmentFirst => {
2474                                                 send_cu!();
2475                                                 send_raa!();
2476                                         },
2477                                 }
2478                                 if let Some(msg) = shutdown {
2479                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2480                                                 node_id: their_node_id.clone(),
2481                                                 msg,
2482                                         });
2483                                 }
2484                                 Ok(())
2485                         },
2486                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2487                 }
2488         }
2489
2490         /// Begin Update fee process. Allowed only on an outbound channel.
2491         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2492         /// PeerManager::process_events afterwards.
2493         /// Note: This API is likely to change!
2494         #[doc(hidden)]
2495         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2496                 let _ = self.total_consistency_lock.read().unwrap();
2497                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2498                 let their_node_id;
2499                 let err: Result<(), _> = loop {
2500                         let channel_state = &mut *channel_state_lock;
2501
2502                         match channel_state.by_id.entry(channel_id) {
2503                                 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2504                                 hash_map::Entry::Occupied(mut chan) => {
2505                                         if !chan.get().is_outbound() {
2506                                                 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2507                                         }
2508                                         if chan.get().is_awaiting_monitor_update() {
2509                                                 return Err(APIError::MonitorUpdateFailed);
2510                                         }
2511                                         if !chan.get().is_live() {
2512                                                 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2513                                         }
2514                                         their_node_id = chan.get().get_their_node_id();
2515                                         if let Some((update_fee, commitment_signed, chan_monitor)) =
2516                                                         break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2517                                         {
2518                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2519                                                         unimplemented!();
2520                                                 }
2521                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2522                                                         node_id: chan.get().get_their_node_id(),
2523                                                         updates: msgs::CommitmentUpdate {
2524                                                                 update_add_htlcs: Vec::new(),
2525                                                                 update_fulfill_htlcs: Vec::new(),
2526                                                                 update_fail_htlcs: Vec::new(),
2527                                                                 update_fail_malformed_htlcs: Vec::new(),
2528                                                                 update_fee: Some(update_fee),
2529                                                                 commitment_signed,
2530                                                         },
2531                                                 });
2532                                         }
2533                                 },
2534                         }
2535                         return Ok(())
2536                 };
2537
2538                 match handle_error!(self, err, their_node_id, channel_state_lock) {
2539                         Ok(_) => unreachable!(),
2540                         Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
2541                 }
2542         }
2543 }
2544
2545 impl<ChanSigner: ChannelKeys, M: Deref> events::MessageSendEventsProvider for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor<ChanSigner> {
2546         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2547                 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2548                 // user to serialize a ChannelManager with pending events in it and lose those events on
2549                 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2550                 {
2551                         //TODO: This behavior should be documented.
2552                         for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2553                                 if let Some(preimage) = htlc_update.payment_preimage {
2554                                         log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2555                                         self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2556                                 } else {
2557                                         log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2558                                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
2559                                 }
2560                         }
2561                 }
2562
2563                 let mut ret = Vec::new();
2564                 let mut channel_state = self.channel_state.lock().unwrap();
2565                 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2566                 ret
2567         }
2568 }
2569
2570 impl<ChanSigner: ChannelKeys, M: Deref> events::EventsProvider for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor<ChanSigner> {
2571         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2572                 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2573                 // user to serialize a ChannelManager with pending events in it and lose those events on
2574                 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2575                 {
2576                         //TODO: This behavior should be documented.
2577                         for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2578                                 if let Some(preimage) = htlc_update.payment_preimage {
2579                                         log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2580                                         self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2581                                 } else {
2582                                         log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2583                                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
2584                                 }
2585                         }
2586                 }
2587
2588                 let mut ret = Vec::new();
2589                 let mut pending_events = self.pending_events.lock().unwrap();
2590                 mem::swap(&mut ret, &mut *pending_events);
2591                 ret
2592         }
2593 }
2594
2595 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send> ChainListener for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor<ChanSigner> {
2596         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2597                 let header_hash = header.bitcoin_hash();
2598                 log_trace!(self, "Block {} at height {} connected with {} txn matched", header_hash, height, txn_matched.len());
2599                 let _ = self.total_consistency_lock.read().unwrap();
2600                 let mut failed_channels = Vec::new();
2601                 {
2602                         let mut channel_lock = self.channel_state.lock().unwrap();
2603                         let channel_state = &mut *channel_lock;
2604                         let short_to_id = &mut channel_state.short_to_id;
2605                         let pending_msg_events = &mut channel_state.pending_msg_events;
2606                         channel_state.by_id.retain(|_, channel| {
2607                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2608                                 if let Ok(Some(funding_locked)) = chan_res {
2609                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2610                                                 node_id: channel.get_their_node_id(),
2611                                                 msg: funding_locked,
2612                                         });
2613                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2614                                                 log_trace!(self, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
2615                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2616                                                         node_id: channel.get_their_node_id(),
2617                                                         msg: announcement_sigs,
2618                                                 });
2619                                         } else {
2620                                                 log_trace!(self, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
2621                                         }
2622                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2623                                 } else if let Err(e) = chan_res {
2624                                         pending_msg_events.push(events::MessageSendEvent::HandleError {
2625                                                 node_id: channel.get_their_node_id(),
2626                                                 action: msgs::ErrorAction::SendErrorMessage { msg: e },
2627                                         });
2628                                         return false;
2629                                 }
2630                                 if let Some(funding_txo) = channel.get_funding_txo() {
2631                                         for tx in txn_matched {
2632                                                 for inp in tx.input.iter() {
2633                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2634                                                                 log_trace!(self, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, log_bytes!(channel.channel_id()));
2635                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2636                                                                         short_to_id.remove(&short_id);
2637                                                                 }
2638                                                                 // It looks like our counterparty went on-chain. We go ahead and
2639                                                                 // broadcast our latest local state as well here, just in case its
2640                                                                 // some kind of SPV attack, though we expect these to be dropped.
2641                                                                 failed_channels.push(channel.force_shutdown());
2642                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2643                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2644                                                                                 msg: update
2645                                                                         });
2646                                                                 }
2647                                                                 return false;
2648                                                         }
2649                                                 }
2650                                         }
2651                                 }
2652                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2653                                         if let Some(short_id) = channel.get_short_channel_id() {
2654                                                 short_to_id.remove(&short_id);
2655                                         }
2656                                         failed_channels.push(channel.force_shutdown());
2657                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2658                                         // the latest local tx for us, so we should skip that here (it doesn't really
2659                                         // hurt anything, but does make tests a bit simpler).
2660                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2661                                         if let Ok(update) = self.get_channel_update(&channel) {
2662                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2663                                                         msg: update
2664                                                 });
2665                                         }
2666                                         return false;
2667                                 }
2668                                 true
2669                         });
2670                 }
2671                 for failure in failed_channels.drain(..) {
2672                         self.finish_force_close_channel(failure);
2673                 }
2674                 self.latest_block_height.store(height as usize, Ordering::Release);
2675                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header_hash;
2676         }
2677
2678         /// We force-close the channel without letting our counterparty participate in the shutdown
2679         fn block_disconnected(&self, header: &BlockHeader, _: u32) {
2680                 let _ = self.total_consistency_lock.read().unwrap();
2681                 let mut failed_channels = Vec::new();
2682                 {
2683                         let mut channel_lock = self.channel_state.lock().unwrap();
2684                         let channel_state = &mut *channel_lock;
2685                         let short_to_id = &mut channel_state.short_to_id;
2686                         let pending_msg_events = &mut channel_state.pending_msg_events;
2687                         channel_state.by_id.retain(|_,  v| {
2688                                 if v.block_disconnected(header) {
2689                                         if let Some(short_id) = v.get_short_channel_id() {
2690                                                 short_to_id.remove(&short_id);
2691                                         }
2692                                         failed_channels.push(v.force_shutdown());
2693                                         if let Ok(update) = self.get_channel_update(&v) {
2694                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2695                                                         msg: update
2696                                                 });
2697                                         }
2698                                         false
2699                                 } else {
2700                                         true
2701                                 }
2702                         });
2703                 }
2704                 for failure in failed_channels.drain(..) {
2705                         self.finish_force_close_channel(failure);
2706                 }
2707                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2708                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2709         }
2710 }
2711
2712 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send> ChannelMessageHandler for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor<ChanSigner> {
2713         fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
2714                 let _ = self.total_consistency_lock.read().unwrap();
2715                 let res = self.internal_open_channel(their_node_id, their_features, msg);
2716                 if res.is_err() {
2717                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2718                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2719                 }
2720         }
2721
2722         fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
2723                 let _ = self.total_consistency_lock.read().unwrap();
2724                 let res = self.internal_accept_channel(their_node_id, their_features, msg);
2725                 if res.is_err() {
2726                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2727                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2728                 }
2729         }
2730
2731         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
2732                 let _ = self.total_consistency_lock.read().unwrap();
2733                 let res = self.internal_funding_created(their_node_id, msg);
2734                 if res.is_err() {
2735                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2736                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2737                 }
2738         }
2739
2740         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
2741                 let _ = self.total_consistency_lock.read().unwrap();
2742                 let res = self.internal_funding_signed(their_node_id, msg);
2743                 if res.is_err() {
2744                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2745                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2746                 }
2747         }
2748
2749         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
2750                 let _ = self.total_consistency_lock.read().unwrap();
2751                 let res = self.internal_funding_locked(their_node_id, msg);
2752                 if res.is_err() {
2753                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2754                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2755                 }
2756         }
2757
2758         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
2759                 let _ = self.total_consistency_lock.read().unwrap();
2760                 let res = self.internal_shutdown(their_node_id, msg);
2761                 if res.is_err() {
2762                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2763                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2764                 }
2765         }
2766
2767         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
2768                 let _ = self.total_consistency_lock.read().unwrap();
2769                 let res = self.internal_closing_signed(their_node_id, msg);
2770                 if res.is_err() {
2771                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2772                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2773                 }
2774         }
2775
2776         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
2777                 let _ = self.total_consistency_lock.read().unwrap();
2778                 let res = self.internal_update_add_htlc(their_node_id, msg);
2779                 if res.is_err() {
2780                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2781                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2782                 }
2783         }
2784
2785         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
2786                 let _ = self.total_consistency_lock.read().unwrap();
2787                 let res = self.internal_update_fulfill_htlc(their_node_id, msg);
2788                 if res.is_err() {
2789                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2790                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2791                 }
2792         }
2793
2794         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
2795                 let _ = self.total_consistency_lock.read().unwrap();
2796                 let res = self.internal_update_fail_htlc(their_node_id, msg);
2797                 if res.is_err() {
2798                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2799                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2800                 }
2801         }
2802
2803         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
2804                 let _ = self.total_consistency_lock.read().unwrap();
2805                 let res = self.internal_update_fail_malformed_htlc(their_node_id, msg);
2806                 if res.is_err() {
2807                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2808                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2809                 }
2810         }
2811
2812         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
2813                 let _ = self.total_consistency_lock.read().unwrap();
2814                 let res = self.internal_commitment_signed(their_node_id, msg);
2815                 if res.is_err() {
2816                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2817                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2818                 }
2819         }
2820
2821         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
2822                 let _ = self.total_consistency_lock.read().unwrap();
2823                 let res = self.internal_revoke_and_ack(their_node_id, msg);
2824                 if res.is_err() {
2825                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2826                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2827                 }
2828         }
2829
2830         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
2831                 let _ = self.total_consistency_lock.read().unwrap();
2832                 let res = self.internal_update_fee(their_node_id, msg);
2833                 if res.is_err() {
2834                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2835                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2836                 }
2837         }
2838
2839         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
2840                 let _ = self.total_consistency_lock.read().unwrap();
2841                 let res = self.internal_announcement_signatures(their_node_id, msg);
2842                 if res.is_err() {
2843                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2844                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2845                 }
2846         }
2847
2848         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
2849                 let _ = self.total_consistency_lock.read().unwrap();
2850                 let res = self.internal_channel_reestablish(their_node_id, msg);
2851                 if res.is_err() {
2852                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2853                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2854                 }
2855         }
2856
2857         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2858                 let _ = self.total_consistency_lock.read().unwrap();
2859                 let mut failed_channels = Vec::new();
2860                 let mut failed_payments = Vec::new();
2861                 let mut no_channels_remain = true;
2862                 {
2863                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2864                         let channel_state = &mut *channel_state_lock;
2865                         let short_to_id = &mut channel_state.short_to_id;
2866                         let pending_msg_events = &mut channel_state.pending_msg_events;
2867                         if no_connection_possible {
2868                                 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2869                                 channel_state.by_id.retain(|_, chan| {
2870                                         if chan.get_their_node_id() == *their_node_id {
2871                                                 if let Some(short_id) = chan.get_short_channel_id() {
2872                                                         short_to_id.remove(&short_id);
2873                                                 }
2874                                                 failed_channels.push(chan.force_shutdown());
2875                                                 if let Ok(update) = self.get_channel_update(&chan) {
2876                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2877                                                                 msg: update
2878                                                         });
2879                                                 }
2880                                                 false
2881                                         } else {
2882                                                 true
2883                                         }
2884                                 });
2885                         } else {
2886                                 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2887                                 channel_state.by_id.retain(|_, chan| {
2888                                         if chan.get_their_node_id() == *their_node_id {
2889                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2890                                                 chan.to_disabled_marked();
2891                                                 if !failed_adds.is_empty() {
2892                                                         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
2893                                                         failed_payments.push((chan_update, failed_adds));
2894                                                 }
2895                                                 if chan.is_shutdown() {
2896                                                         if let Some(short_id) = chan.get_short_channel_id() {
2897                                                                 short_to_id.remove(&short_id);
2898                                                         }
2899                                                         return false;
2900                                                 } else {
2901                                                         no_channels_remain = false;
2902                                                 }
2903                                         }
2904                                         true
2905                                 })
2906                         }
2907                         pending_msg_events.retain(|msg| {
2908                                 match msg {
2909                                         &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != their_node_id,
2910                                         &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != their_node_id,
2911                                         &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != their_node_id,
2912                                         &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != their_node_id,
2913                                         &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != their_node_id,
2914                                         &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != their_node_id,
2915                                         &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != their_node_id,
2916                                         &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != their_node_id,
2917                                         &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != their_node_id,
2918                                         &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != their_node_id,
2919                                         &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != their_node_id,
2920                                         &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
2921                                         &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
2922                                         &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != their_node_id,
2923                                         &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
2924                                 }
2925                         });
2926                 }
2927                 if no_channels_remain {
2928                         self.per_peer_state.write().unwrap().remove(their_node_id);
2929                 }
2930
2931                 for failure in failed_channels.drain(..) {
2932                         self.finish_force_close_channel(failure);
2933                 }
2934                 for (chan_update, mut htlc_sources) in failed_payments {
2935                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2936                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2937                         }
2938                 }
2939         }
2940
2941         fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init) {
2942                 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2943
2944                 let _ = self.total_consistency_lock.read().unwrap();
2945
2946                 {
2947                         let mut peer_state_lock = self.per_peer_state.write().unwrap();
2948                         match peer_state_lock.entry(their_node_id.clone()) {
2949                                 hash_map::Entry::Vacant(e) => {
2950                                         e.insert(Mutex::new(PeerState {
2951                                                 latest_features: init_msg.features.clone(),
2952                                         }));
2953                                 },
2954                                 hash_map::Entry::Occupied(e) => {
2955                                         e.get().lock().unwrap().latest_features = init_msg.features.clone();
2956                                 },
2957                         }
2958                 }
2959
2960                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2961                 let channel_state = &mut *channel_state_lock;
2962                 let pending_msg_events = &mut channel_state.pending_msg_events;
2963                 channel_state.by_id.retain(|_, chan| {
2964                         if chan.get_their_node_id() == *their_node_id {
2965                                 if !chan.have_received_message() {
2966                                         // If we created this (outbound) channel while we were disconnected from the
2967                                         // peer we probably failed to send the open_channel message, which is now
2968                                         // lost. We can't have had anything pending related to this channel, so we just
2969                                         // drop it.
2970                                         false
2971                                 } else {
2972                                         pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2973                                                 node_id: chan.get_their_node_id(),
2974                                                 msg: chan.get_channel_reestablish(),
2975                                         });
2976                                         true
2977                                 }
2978                         } else { true }
2979                 });
2980                 //TODO: Also re-broadcast announcement_signatures
2981         }
2982
2983         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2984                 let _ = self.total_consistency_lock.read().unwrap();
2985
2986                 if msg.channel_id == [0; 32] {
2987                         for chan in self.list_channels() {
2988                                 if chan.remote_network_id == *their_node_id {
2989                                         self.force_close_channel(&chan.channel_id);
2990                                 }
2991                         }
2992                 } else {
2993                         self.force_close_channel(&msg.channel_id);
2994                 }
2995         }
2996 }
2997
2998 const SERIALIZATION_VERSION: u8 = 1;
2999 const MIN_SERIALIZATION_VERSION: u8 = 1;
3000
3001 impl Writeable for PendingForwardHTLCInfo {
3002         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3003                 self.onion_packet.write(writer)?;
3004                 self.incoming_shared_secret.write(writer)?;
3005                 self.payment_hash.write(writer)?;
3006                 self.short_channel_id.write(writer)?;
3007                 self.amt_to_forward.write(writer)?;
3008                 self.outgoing_cltv_value.write(writer)?;
3009                 Ok(())
3010         }
3011 }
3012
3013 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
3014         fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
3015                 Ok(PendingForwardHTLCInfo {
3016                         onion_packet: Readable::read(reader)?,
3017                         incoming_shared_secret: Readable::read(reader)?,
3018                         payment_hash: Readable::read(reader)?,
3019                         short_channel_id: Readable::read(reader)?,
3020                         amt_to_forward: Readable::read(reader)?,
3021                         outgoing_cltv_value: Readable::read(reader)?,
3022                 })
3023         }
3024 }
3025
3026 impl Writeable for HTLCFailureMsg {
3027         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3028                 match self {
3029                         &HTLCFailureMsg::Relay(ref fail_msg) => {
3030                                 0u8.write(writer)?;
3031                                 fail_msg.write(writer)?;
3032                         },
3033                         &HTLCFailureMsg::Malformed(ref fail_msg) => {
3034                                 1u8.write(writer)?;
3035                                 fail_msg.write(writer)?;
3036                         }
3037                 }
3038                 Ok(())
3039         }
3040 }
3041
3042 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
3043         fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3044                 match <u8 as Readable<R>>::read(reader)? {
3045                         0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
3046                         1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
3047                         _ => Err(DecodeError::InvalidValue),
3048                 }
3049         }
3050 }
3051
3052 impl Writeable for PendingHTLCStatus {
3053         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3054                 match self {
3055                         &PendingHTLCStatus::Forward(ref forward_info) => {
3056                                 0u8.write(writer)?;
3057                                 forward_info.write(writer)?;
3058                         },
3059                         &PendingHTLCStatus::Fail(ref fail_msg) => {
3060                                 1u8.write(writer)?;
3061                                 fail_msg.write(writer)?;
3062                         }
3063                 }
3064                 Ok(())
3065         }
3066 }
3067
3068 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3069         fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3070                 match <u8 as Readable<R>>::read(reader)? {
3071                         0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3072                         1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3073                         _ => Err(DecodeError::InvalidValue),
3074                 }
3075         }
3076 }
3077
3078 impl_writeable!(HTLCPreviousHopData, 0, {
3079         short_channel_id,
3080         htlc_id,
3081         incoming_packet_shared_secret
3082 });
3083
3084 impl Writeable for HTLCSource {
3085         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3086                 match self {
3087                         &HTLCSource::PreviousHopData(ref hop_data) => {
3088                                 0u8.write(writer)?;
3089                                 hop_data.write(writer)?;
3090                         },
3091                         &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
3092                                 1u8.write(writer)?;
3093                                 route.write(writer)?;
3094                                 session_priv.write(writer)?;
3095                                 first_hop_htlc_msat.write(writer)?;
3096                         }
3097                 }
3098                 Ok(())
3099         }
3100 }
3101
3102 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3103         fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3104                 match <u8 as Readable<R>>::read(reader)? {
3105                         0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3106                         1 => Ok(HTLCSource::OutboundRoute {
3107                                 route: Readable::read(reader)?,
3108                                 session_priv: Readable::read(reader)?,
3109                                 first_hop_htlc_msat: Readable::read(reader)?,
3110                         }),
3111                         _ => Err(DecodeError::InvalidValue),
3112                 }
3113         }
3114 }
3115
3116 impl Writeable for HTLCFailReason {
3117         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3118                 match self {
3119                         &HTLCFailReason::LightningError { ref err } => {
3120                                 0u8.write(writer)?;
3121                                 err.write(writer)?;
3122                         },
3123                         &HTLCFailReason::Reason { ref failure_code, ref data } => {
3124                                 1u8.write(writer)?;
3125                                 failure_code.write(writer)?;
3126                                 data.write(writer)?;
3127                         }
3128                 }
3129                 Ok(())
3130         }
3131 }
3132
3133 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3134         fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3135                 match <u8 as Readable<R>>::read(reader)? {
3136                         0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
3137                         1 => Ok(HTLCFailReason::Reason {
3138                                 failure_code: Readable::read(reader)?,
3139                                 data: Readable::read(reader)?,
3140                         }),
3141                         _ => Err(DecodeError::InvalidValue),
3142                 }
3143         }
3144 }
3145
3146 impl Writeable for HTLCForwardInfo {
3147         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3148                 match self {
3149                         &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_htlc_id, ref forward_info } => {
3150                                 0u8.write(writer)?;
3151                                 prev_short_channel_id.write(writer)?;
3152                                 prev_htlc_id.write(writer)?;
3153                                 forward_info.write(writer)?;
3154                         },
3155                         &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
3156                                 1u8.write(writer)?;
3157                                 htlc_id.write(writer)?;
3158                                 err_packet.write(writer)?;
3159                         },
3160                 }
3161                 Ok(())
3162         }
3163 }
3164
3165 impl<R: ::std::io::Read> Readable<R> for HTLCForwardInfo {
3166         fn read(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3167                 match <u8 as Readable<R>>::read(reader)? {
3168                         0 => Ok(HTLCForwardInfo::AddHTLC {
3169                                 prev_short_channel_id: Readable::read(reader)?,
3170                                 prev_htlc_id: Readable::read(reader)?,
3171                                 forward_info: Readable::read(reader)?,
3172                         }),
3173                         1 => Ok(HTLCForwardInfo::FailHTLC {
3174                                 htlc_id: Readable::read(reader)?,
3175                                 err_packet: Readable::read(reader)?,
3176                         }),
3177                         _ => Err(DecodeError::InvalidValue),
3178                 }
3179         }
3180 }
3181
3182 impl<ChanSigner: ChannelKeys + Writeable, M: Deref> Writeable for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor<ChanSigner> {
3183         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3184                 let _ = self.total_consistency_lock.write().unwrap();
3185
3186                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3187                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3188
3189                 self.genesis_hash.write(writer)?;
3190                 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3191                 self.last_block_hash.lock().unwrap().write(writer)?;
3192
3193                 let channel_state = self.channel_state.lock().unwrap();
3194                 let mut unfunded_channels = 0;
3195                 for (_, channel) in channel_state.by_id.iter() {
3196                         if !channel.is_funding_initiated() {
3197                                 unfunded_channels += 1;
3198                         }
3199                 }
3200                 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3201                 for (_, channel) in channel_state.by_id.iter() {
3202                         if channel.is_funding_initiated() {
3203                                 channel.write(writer)?;
3204                         }
3205                 }
3206
3207                 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3208                 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3209                         short_channel_id.write(writer)?;
3210                         (pending_forwards.len() as u64).write(writer)?;
3211                         for forward in pending_forwards {
3212                                 forward.write(writer)?;
3213                         }
3214                 }
3215
3216                 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3217                 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3218                         payment_hash.write(writer)?;
3219                         (previous_hops.len() as u64).write(writer)?;
3220                         for &(recvd_amt, ref previous_hop) in previous_hops.iter() {
3221                                 recvd_amt.write(writer)?;
3222                                 previous_hop.write(writer)?;
3223                         }
3224                 }
3225
3226                 let per_peer_state = self.per_peer_state.write().unwrap();
3227                 (per_peer_state.len() as u64).write(writer)?;
3228                 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
3229                         peer_pubkey.write(writer)?;
3230                         let peer_state = peer_state_mutex.lock().unwrap();
3231                         peer_state.latest_features.write(writer)?;
3232                 }
3233
3234                 Ok(())
3235         }
3236 }
3237
3238 /// Arguments for the creation of a ChannelManager that are not deserialized.
3239 ///
3240 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3241 /// is:
3242 /// 1) Deserialize all stored ChannelMonitors.
3243 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3244 ///    ChannelManager)>::read(reader, args).
3245 ///    This may result in closing some Channels if the ChannelMonitor is newer than the stored
3246 ///    ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3247 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3248 ///    ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3249 /// 4) Reconnect blocks on your ChannelMonitors.
3250 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3251 /// 6) Disconnect/connect blocks on the ChannelManager.
3252 /// 7) Register the new ChannelManager with your ChainWatchInterface.
3253 pub struct ChannelManagerReadArgs<'a, ChanSigner: 'a + ChannelKeys, M: Deref> where M::Target: ManyChannelMonitor<ChanSigner> {
3254         /// The keys provider which will give us relevant keys. Some keys will be loaded during
3255         /// deserialization.
3256         pub keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>,
3257
3258         /// The fee_estimator for use in the ChannelManager in the future.
3259         ///
3260         /// No calls to the FeeEstimator will be made during deserialization.
3261         pub fee_estimator: Arc<FeeEstimator>,
3262         /// The ManyChannelMonitor for use in the ChannelManager in the future.
3263         ///
3264         /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3265         /// you have deserialized ChannelMonitors separately and will add them to your
3266         /// ManyChannelMonitor after deserializing this ChannelManager.
3267         pub monitor: M,
3268
3269         /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3270         /// used to broadcast the latest local commitment transactions of channels which must be
3271         /// force-closed during deserialization.
3272         pub tx_broadcaster: Arc<BroadcasterInterface>,
3273         /// The Logger for use in the ChannelManager and which may be used to log information during
3274         /// deserialization.
3275         pub logger: Arc<Logger>,
3276         /// Default settings used for new channels. Any existing channels will continue to use the
3277         /// runtime settings which were stored when the ChannelManager was serialized.
3278         pub default_config: UserConfig,
3279
3280         /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3281         /// value.get_funding_txo() should be the key).
3282         ///
3283         /// If a monitor is inconsistent with the channel state during deserialization the channel will
3284         /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
3285         /// is true for missing channels as well. If there is a monitor missing for which we find
3286         /// channel data Err(DecodeError::InvalidValue) will be returned.
3287         ///
3288         /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3289         /// this struct.
3290         pub channel_monitors: &'a mut HashMap<OutPoint, &'a mut ChannelMonitor<ChanSigner>>,
3291 }
3292
3293 impl<'a, R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>, M: Deref> ReadableArgs<R, ChannelManagerReadArgs<'a, ChanSigner, M>> for (Sha256dHash, ChannelManager<ChanSigner, M>) where M::Target: ManyChannelMonitor<ChanSigner> {
3294         fn read(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M>) -> Result<Self, DecodeError> {
3295                 let _ver: u8 = Readable::read(reader)?;
3296                 let min_ver: u8 = Readable::read(reader)?;
3297                 if min_ver > SERIALIZATION_VERSION {
3298                         return Err(DecodeError::UnknownVersion);
3299                 }
3300
3301                 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3302                 let latest_block_height: u32 = Readable::read(reader)?;
3303                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3304
3305                 let mut closed_channels = Vec::new();
3306
3307                 let channel_count: u64 = Readable::read(reader)?;
3308                 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3309                 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3310                 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3311                 for _ in 0..channel_count {
3312                         let mut channel: Channel<ChanSigner> = ReadableArgs::read(reader, args.logger.clone())?;
3313                         if channel.last_block_connected != last_block_hash {
3314                                 return Err(DecodeError::InvalidValue);
3315                         }
3316
3317                         let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3318                         funding_txo_set.insert(funding_txo.clone());
3319                         if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
3320                                 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3321                                                 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3322                                                 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3323                                         let mut force_close_res = channel.force_shutdown();
3324                                         force_close_res.0 = monitor.get_latest_local_commitment_txn();
3325                                         closed_channels.push(force_close_res);
3326                                 } else {
3327                                         if let Some(short_channel_id) = channel.get_short_channel_id() {
3328                                                 short_to_id.insert(short_channel_id, channel.channel_id());
3329                                         }
3330                                         by_id.insert(channel.channel_id(), channel);
3331                                 }
3332                         } else {
3333                                 return Err(DecodeError::InvalidValue);
3334                         }
3335                 }
3336
3337                 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
3338                         if !funding_txo_set.contains(funding_txo) {
3339                                 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3340                         }
3341                 }
3342
3343                 let forward_htlcs_count: u64 = Readable::read(reader)?;
3344                 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3345                 for _ in 0..forward_htlcs_count {
3346                         let short_channel_id = Readable::read(reader)?;
3347                         let pending_forwards_count: u64 = Readable::read(reader)?;
3348                         let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3349                         for _ in 0..pending_forwards_count {
3350                                 pending_forwards.push(Readable::read(reader)?);
3351                         }
3352                         forward_htlcs.insert(short_channel_id, pending_forwards);
3353                 }
3354
3355                 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3356                 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3357                 for _ in 0..claimable_htlcs_count {
3358                         let payment_hash = Readable::read(reader)?;
3359                         let previous_hops_len: u64 = Readable::read(reader)?;
3360                         let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3361                         for _ in 0..previous_hops_len {
3362                                 previous_hops.push((Readable::read(reader)?, Readable::read(reader)?));
3363                         }
3364                         claimable_htlcs.insert(payment_hash, previous_hops);
3365                 }
3366
3367                 let peer_count: u64 = Readable::read(reader)?;
3368                 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, 128));
3369                 for _ in 0..peer_count {
3370                         let peer_pubkey = Readable::read(reader)?;
3371                         let peer_state = PeerState {
3372                                 latest_features: Readable::read(reader)?,
3373                         };
3374                         per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
3375                 }
3376
3377                 let channel_manager = ChannelManager {
3378                         genesis_hash,
3379                         fee_estimator: args.fee_estimator,
3380                         monitor: args.monitor,
3381                         tx_broadcaster: args.tx_broadcaster,
3382
3383                         latest_block_height: AtomicUsize::new(latest_block_height as usize),
3384                         last_block_hash: Mutex::new(last_block_hash),
3385                         secp_ctx: Secp256k1::new(),
3386
3387                         channel_state: Mutex::new(ChannelHolder {
3388                                 by_id,
3389                                 short_to_id,
3390                                 forward_htlcs,
3391                                 claimable_htlcs,
3392                                 pending_msg_events: Vec::new(),
3393                         }),
3394                         our_network_key: args.keys_manager.get_node_secret(),
3395
3396                         per_peer_state: RwLock::new(per_peer_state),
3397
3398                         pending_events: Mutex::new(Vec::new()),
3399                         total_consistency_lock: RwLock::new(()),
3400                         keys_manager: args.keys_manager,
3401                         logger: args.logger,
3402                         default_configuration: args.default_config,
3403                 };
3404
3405                 for close_res in closed_channels.drain(..) {
3406                         channel_manager.finish_force_close_channel(close_res);
3407                         //TODO: Broadcast channel update for closed channels, but only after we've made a
3408                         //connection or two.
3409                 }
3410
3411                 Ok((last_block_hash.clone(), channel_manager))
3412         }
3413 }