]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/channelmanager.rs
47107abeda9d7c7b2597fb5463a263de508c5863
[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(err: ChannelError, 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 {
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(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(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) {
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(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 {
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                                                 _ => 0x2000 | 2, // Should never happen
914                                         };
915                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
916                                 },
917                                 Ok(msg) => {
918                                         let mut hmac = [0; 32];
919                                         if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
920                                                 return_err!("Unable to decode our hop data", 0x4000 | 1, &[0;0]);
921                                         }
922                                         (msg, hmac)
923                                 },
924                         }
925                 };
926
927                 let pending_forward_info = if next_hop_hmac == [0; 32] {
928                                 #[cfg(test)]
929                                 {
930                                         // In tests, make sure that the initial onion pcket data is, at least, non-0.
931                                         // We could do some fancy randomness test here, but, ehh, whatever.
932                                         // This checks for the issue where you can calculate the path length given the
933                                         // onion data as all the path entries that the originator sent will be here
934                                         // as-is (and were originally 0s).
935                                         // Of course reverse path calculation is still pretty easy given naive routing
936                                         // algorithms, but this fixes the most-obvious case.
937                                         let mut next_bytes = [0; 32];
938                                         chacha_stream.read_exact(&mut next_bytes).unwrap();
939                                         assert_ne!(next_bytes[..], [0; 32][..]);
940                                         chacha_stream.read_exact(&mut next_bytes).unwrap();
941                                         assert_ne!(next_bytes[..], [0; 32][..]);
942                                 }
943
944                                 // OUR PAYMENT!
945                                 // final_expiry_too_soon
946                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
947                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
948                                 }
949                                 // final_incorrect_htlc_amount
950                                 if next_hop_data.amt_to_forward > msg.amount_msat {
951                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
952                                 }
953                                 // final_incorrect_cltv_expiry
954                                 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
955                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
956                                 }
957
958                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
959                                 // message, however that would leak that we are the recipient of this payment, so
960                                 // instead we stay symmetric with the forwarding case, only responding (after a
961                                 // delay) once they've send us a commitment_signed!
962
963                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
964                                         onion_packet: None,
965                                         payment_hash: msg.payment_hash.clone(),
966                                         short_channel_id: 0,
967                                         incoming_shared_secret: shared_secret,
968                                         amt_to_forward: next_hop_data.amt_to_forward,
969                                         outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
970                                 })
971                         } else {
972                                 let mut new_packet_data = [0; 20*65];
973                                 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
974                                 chacha_stream.chacha.process_inline(&mut new_packet_data[read_pos..]);
975
976                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
977
978                                 let blinding_factor = {
979                                         let mut sha = Sha256::engine();
980                                         sha.input(&new_pubkey.serialize()[..]);
981                                         sha.input(&shared_secret);
982                                         Sha256::from_engine(sha).into_inner()
983                                 };
984
985                                 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
986                                         Err(e)
987                                 } else { Ok(new_pubkey) };
988
989                                 let outgoing_packet = msgs::OnionPacket {
990                                         version: 0,
991                                         public_key,
992                                         hop_data: new_packet_data,
993                                         hmac: next_hop_hmac.clone(),
994                                 };
995
996                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
997                                         onion_packet: Some(outgoing_packet),
998                                         payment_hash: msg.payment_hash.clone(),
999                                         short_channel_id: next_hop_data.short_channel_id,
1000                                         incoming_shared_secret: shared_secret,
1001                                         amt_to_forward: next_hop_data.amt_to_forward,
1002                                         outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1003                                 })
1004                         };
1005
1006                 channel_state = Some(self.channel_state.lock().unwrap());
1007                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1008                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1009                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1010                                 let forwarding_id = match id_option {
1011                                         None => { // unknown_next_peer
1012                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1013                                         },
1014                                         Some(id) => id.clone(),
1015                                 };
1016                                 if let Some((err, code, chan_update)) = loop {
1017                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1018
1019                                         // Note that we could technically not return an error yet here and just hope
1020                                         // that the connection is reestablished or monitor updated by the time we get
1021                                         // around to doing the actual forward, but better to fail early if we can and
1022                                         // hopefully an attacker trying to path-trace payments cannot make this occur
1023                                         // on a small/per-node/per-channel scale.
1024                                         if !chan.is_live() { // channel_disabled
1025                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1026                                         }
1027                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1028                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1029                                         }
1030                                         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) });
1031                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1032                                                 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())));
1033                                         }
1034                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1035                                                 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())));
1036                                         }
1037                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1038                                         // We want to have at least LATENCY_GRACE_PERIOD_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1039                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS as u32 { // expiry_too_soon
1040                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1041                                         }
1042                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1043                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1044                                         }
1045                                         break None;
1046                                 }
1047                                 {
1048                                         let mut res = Vec::with_capacity(8 + 128);
1049                                         if let Some(chan_update) = chan_update {
1050                                                 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1051                                                         res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1052                                                 }
1053                                                 else if code == 0x1000 | 13 {
1054                                                         res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1055                                                 }
1056                                                 else if code == 0x1000 | 20 {
1057                                                         res.extend_from_slice(&byte_utils::be16_to_array(chan_update.contents.flags));
1058                                                 }
1059                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1060                                         }
1061                                         return_err!(err, code, &res[..]);
1062                                 }
1063                         }
1064                 }
1065
1066                 (pending_forward_info, channel_state.unwrap())
1067         }
1068
1069         /// only fails if the channel does not yet have an assigned short_id
1070         /// May be called with channel_state already locked!
1071         fn get_channel_update(&self, chan: &Channel<ChanSigner>) -> Result<msgs::ChannelUpdate, LightningError> {
1072                 let short_channel_id = match chan.get_short_channel_id() {
1073                         None => return Err(LightningError{err: "Channel not yet established", action: msgs::ErrorAction::IgnoreError}),
1074                         Some(id) => id,
1075                 };
1076
1077                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1078
1079                 let unsigned = msgs::UnsignedChannelUpdate {
1080                         chain_hash: self.genesis_hash,
1081                         short_channel_id: short_channel_id,
1082                         timestamp: chan.get_channel_update_count(),
1083                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1084                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1085                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1086                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1087                         fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1088                         excess_data: Vec::new(),
1089                 };
1090
1091                 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1092                 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1093
1094                 Ok(msgs::ChannelUpdate {
1095                         signature: sig,
1096                         contents: unsigned
1097                 })
1098         }
1099
1100         /// Sends a payment along a given route.
1101         ///
1102         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1103         /// fields for more info.
1104         ///
1105         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1106         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1107         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1108         /// specified in the last hop in the route! Thus, you should probably do your own
1109         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1110         /// payment") and prevent double-sends yourself.
1111         ///
1112         /// May generate a SendHTLCs message event on success, which should be relayed.
1113         ///
1114         /// Raises APIError::RoutError when invalid route or forward parameter
1115         /// (cltv_delta, fee, node public key) is specified.
1116         /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1117         /// (including due to previous monitor update failure or new permanent monitor update failure).
1118         /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1119         /// relevant updates.
1120         ///
1121         /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1122         /// and you may wish to retry via a different route immediately.
1123         /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1124         /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1125         /// the payment via a different route unless you intend to pay twice!
1126         pub fn send_payment(&self, route: Route, payment_hash: PaymentHash) -> Result<(), APIError> {
1127                 if route.hops.len() < 1 || route.hops.len() > 20 {
1128                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1129                 }
1130                 let our_node_id = self.get_our_node_id();
1131                 for (idx, hop) in route.hops.iter().enumerate() {
1132                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1133                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1134                         }
1135                 }
1136
1137                 let (session_priv, prng_seed) = self.keys_manager.get_onion_rand();
1138
1139                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1140
1141                 let onion_keys = secp_call!(onion_utils::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1142                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1143                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height)?;
1144                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, &payment_hash);
1145
1146                 let _ = self.total_consistency_lock.read().unwrap();
1147
1148                 let mut channel_lock = self.channel_state.lock().unwrap();
1149                 let err: Result<(), _> = loop {
1150
1151                         let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1152                                 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1153                                 Some(id) => id.clone(),
1154                         };
1155
1156                         let channel_state = &mut *channel_lock;
1157                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1158                                 match {
1159                                         if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1160                                                 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1161                                         }
1162                                         if !chan.get().is_live() {
1163                                                 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1164                                         }
1165                                         break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1166                                                 route: route.clone(),
1167                                                 session_priv: session_priv.clone(),
1168                                                 first_hop_htlc_msat: htlc_msat,
1169                                         }, onion_packet), channel_state, chan)
1170                                 } {
1171                                         Some((update_add, commitment_signed, chan_monitor)) => {
1172                                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1173                                                         maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1174                                                         // Note that MonitorUpdateFailed here indicates (per function docs)
1175                                                         // that we will resent the commitment update once we unfree monitor
1176                                                         // updating, so we have to take special care that we don't return
1177                                                         // something else in case we will resend later!
1178                                                         return Err(APIError::MonitorUpdateFailed);
1179                                                 }
1180
1181                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1182                                                         node_id: route.hops.first().unwrap().pubkey,
1183                                                         updates: msgs::CommitmentUpdate {
1184                                                                 update_add_htlcs: vec![update_add],
1185                                                                 update_fulfill_htlcs: Vec::new(),
1186                                                                 update_fail_htlcs: Vec::new(),
1187                                                                 update_fail_malformed_htlcs: Vec::new(),
1188                                                                 update_fee: None,
1189                                                                 commitment_signed,
1190                                                         },
1191                                                 });
1192                                         },
1193                                         None => {},
1194                                 }
1195                         } else { unreachable!(); }
1196                         return Ok(());
1197                 };
1198
1199                 match handle_error!(self, err, route.hops.first().unwrap().pubkey, channel_lock) {
1200                         Ok(_) => unreachable!(),
1201                         Err(e) => { Err(APIError::ChannelUnavailable { err: e.err }) }
1202                 }
1203         }
1204
1205         /// Call this upon creation of a funding transaction for the given channel.
1206         ///
1207         /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1208         /// or your counterparty can steal your funds!
1209         ///
1210         /// Panics if a funding transaction has already been provided for this channel.
1211         ///
1212         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1213         /// be trivially prevented by using unique funding transaction keys per-channel).
1214         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1215                 let _ = self.total_consistency_lock.read().unwrap();
1216
1217                 let (mut chan, msg, chan_monitor) = {
1218                         let mut channel_state = self.channel_state.lock().unwrap();
1219                         let (res, chan) = match channel_state.by_id.remove(temporary_channel_id) {
1220                                 Some(mut chan) => {
1221                                         (chan.get_outbound_funding_created(funding_txo)
1222                                                 .map_err(|e| if let ChannelError::Close(msg) = e {
1223                                                         MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1224                                                 } else { unreachable!(); })
1225                                         , chan)
1226                                 },
1227                                 None => return
1228                         };
1229                         match handle_error!(self, res, chan.get_their_node_id(), channel_state) {
1230                                 Ok(funding_msg) => {
1231                                         (chan, funding_msg.0, funding_msg.1)
1232                                 },
1233                                 Err(_) => { return; }
1234                         }
1235                 };
1236                 // Because we have exclusive ownership of the channel here we can release the channel_state
1237                 // lock before add_update_monitor
1238                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1239                         match e {
1240                                 ChannelMonitorUpdateErr::PermanentFailure => {
1241                                         {
1242                                                 let mut channel_state = self.channel_state.lock().unwrap();
1243                                                 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) {
1244                                                         Err(_) => { return; },
1245                                                         Ok(()) => unreachable!(),
1246                                                 }
1247                                         }
1248                                 },
1249                                 ChannelMonitorUpdateErr::TemporaryFailure => {
1250                                         // Its completely fine to continue with a FundingCreated until the monitor
1251                                         // update is persisted, as long as we don't generate the FundingBroadcastSafe
1252                                         // until the monitor has been safely persisted (as funding broadcast is not,
1253                                         // in fact, safe).
1254                                         chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1255                                 },
1256                         }
1257                 }
1258
1259                 let mut channel_state = self.channel_state.lock().unwrap();
1260                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1261                         node_id: chan.get_their_node_id(),
1262                         msg: msg,
1263                 });
1264                 match channel_state.by_id.entry(chan.channel_id()) {
1265                         hash_map::Entry::Occupied(_) => {
1266                                 panic!("Generated duplicate funding txid?");
1267                         },
1268                         hash_map::Entry::Vacant(e) => {
1269                                 e.insert(chan);
1270                         }
1271                 }
1272         }
1273
1274         fn get_announcement_sigs(&self, chan: &Channel<ChanSigner>) -> Option<msgs::AnnouncementSignatures> {
1275                 if !chan.should_announce() { return None }
1276
1277                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1278                         Ok(res) => res,
1279                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1280                 };
1281                 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1282                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1283
1284                 Some(msgs::AnnouncementSignatures {
1285                         channel_id: chan.channel_id(),
1286                         short_channel_id: chan.get_short_channel_id().unwrap(),
1287                         node_signature: our_node_sig,
1288                         bitcoin_signature: our_bitcoin_sig,
1289                 })
1290         }
1291
1292         /// Processes HTLCs which are pending waiting on random forward delay.
1293         ///
1294         /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1295         /// Will likely generate further events.
1296         pub fn process_pending_htlc_forwards(&self) {
1297                 let _ = self.total_consistency_lock.read().unwrap();
1298
1299                 let mut new_events = Vec::new();
1300                 let mut failed_forwards = Vec::new();
1301                 let mut handle_errors = Vec::new();
1302                 {
1303                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1304                         let channel_state = &mut *channel_state_lock;
1305
1306                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1307                                 if short_chan_id != 0 {
1308                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1309                                                 Some(chan_id) => chan_id.clone(),
1310                                                 None => {
1311                                                         failed_forwards.reserve(pending_forwards.len());
1312                                                         for forward_info in pending_forwards.drain(..) {
1313                                                                 match forward_info {
1314                                                                         HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1315                                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1316                                                                                         short_channel_id: prev_short_channel_id,
1317                                                                                         htlc_id: prev_htlc_id,
1318                                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1319                                                                                 });
1320                                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1321                                                                         },
1322                                                                         HTLCForwardInfo::FailHTLC { .. } => {
1323                                                                                 // Channel went away before we could fail it. This implies
1324                                                                                 // the channel is now on chain and our counterparty is
1325                                                                                 // trying to broadcast the HTLC-Timeout, but that's their
1326                                                                                 // problem, not ours.
1327                                                                         }
1328                                                                 }
1329                                                         }
1330                                                         continue;
1331                                                 }
1332                                         };
1333                                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1334                                                 let mut add_htlc_msgs = Vec::new();
1335                                                 let mut fail_htlc_msgs = Vec::new();
1336                                                 for forward_info in pending_forwards.drain(..) {
1337                                                         match forward_info {
1338                                                                 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1339                                                                         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);
1340                                                                         let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1341                                                                                 short_channel_id: prev_short_channel_id,
1342                                                                                 htlc_id: prev_htlc_id,
1343                                                                                 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1344                                                                         });
1345                                                                         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()) {
1346                                                                                 Err(e) => {
1347                                                                                         if let ChannelError::Ignore(msg) = e {
1348                                                                                                 log_trace!(self, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(forward_info.payment_hash.0), msg);
1349                                                                                         } else {
1350                                                                                                 panic!("Stated return value requirements in send_htlc() were not met");
1351                                                                                         }
1352                                                                                         let chan_update = self.get_channel_update(chan.get()).unwrap();
1353                                                                                         failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1354                                                                                         continue;
1355                                                                                 },
1356                                                                                 Ok(update_add) => {
1357                                                                                         match update_add {
1358                                                                                                 Some(msg) => { add_htlc_msgs.push(msg); },
1359                                                                                                 None => {
1360                                                                                                         // Nothing to do here...we're waiting on a remote
1361                                                                                                         // revoke_and_ack before we can add anymore HTLCs. The Channel
1362                                                                                                         // will automatically handle building the update_add_htlc and
1363                                                                                                         // commitment_signed messages when we can.
1364                                                                                                         // TODO: Do some kind of timer to set the channel as !is_live()
1365                                                                                                         // as we don't really want others relying on us relaying through
1366                                                                                                         // this channel currently :/.
1367                                                                                                 }
1368                                                                                         }
1369                                                                                 }
1370                                                                         }
1371                                                                 },
1372                                                                 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1373                                                                         log_trace!(self, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1374                                                                         match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1375                                                                                 Err(e) => {
1376                                                                                         if let ChannelError::Ignore(msg) = e {
1377                                                                                                 log_trace!(self, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1378                                                                                         } else {
1379                                                                                                 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1380                                                                                         }
1381                                                                                         // fail-backs are best-effort, we probably already have one
1382                                                                                         // pending, and if not that's OK, if not, the channel is on
1383                                                                                         // the chain and sending the HTLC-Timeout is their problem.
1384                                                                                         continue;
1385                                                                                 },
1386                                                                                 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1387                                                                                 Ok(None) => {
1388                                                                                         // Nothing to do here...we're waiting on a remote
1389                                                                                         // revoke_and_ack before we can update the commitment
1390                                                                                         // transaction. The Channel will automatically handle
1391                                                                                         // building the update_fail_htlc and commitment_signed
1392                                                                                         // messages when we can.
1393                                                                                         // We don't need any kind of timer here as they should fail
1394                                                                                         // the channel onto the chain if they can't get our
1395                                                                                         // update_fail_htlc in time, it's not our problem.
1396                                                                                 }
1397                                                                         }
1398                                                                 },
1399                                                         }
1400                                                 }
1401
1402                                                 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1403                                                         let (commitment_msg, monitor) = match chan.get_mut().send_commitment() {
1404                                                                 Ok(res) => res,
1405                                                                 Err(e) => {
1406                                                                         // We surely failed send_commitment due to bad keys, in that case
1407                                                                         // close channel and then send error message to peer.
1408                                                                         let their_node_id = chan.get().get_their_node_id();
1409                                                                         let err: Result<(), _>  = match e {
1410                                                                                 ChannelError::Ignore(_) => {
1411                                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1412                                                                                 },
1413                                                                                 ChannelError::Close(msg) => {
1414                                                                                         log_trace!(self, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1415                                                                                         let (channel_id, mut channel) = chan.remove_entry();
1416                                                                                         if let Some(short_id) = channel.get_short_channel_id() {
1417                                                                                                 channel_state.short_to_id.remove(&short_id);
1418                                                                                         }
1419                                                                                         Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(), self.get_channel_update(&channel).ok()))
1420                                                                                 },
1421                                                                                 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"); }
1422                                                                         };
1423                                                                         match handle_error!(self, err, their_node_id, channel_state) {
1424                                                                                 Ok(_) => unreachable!(),
1425                                                                                 Err(_) => { continue; },
1426                                                                         }
1427                                                                 }
1428                                                         };
1429                                                         if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1430                                                                 handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1431                                                                 continue;
1432                                                         }
1433                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1434                                                                 node_id: chan.get().get_their_node_id(),
1435                                                                 updates: msgs::CommitmentUpdate {
1436                                                                         update_add_htlcs: add_htlc_msgs,
1437                                                                         update_fulfill_htlcs: Vec::new(),
1438                                                                         update_fail_htlcs: fail_htlc_msgs,
1439                                                                         update_fail_malformed_htlcs: Vec::new(),
1440                                                                         update_fee: None,
1441                                                                         commitment_signed: commitment_msg,
1442                                                                 },
1443                                                         });
1444                                                 }
1445                                         } else {
1446                                                 unreachable!();
1447                                         }
1448                                 } else {
1449                                         for forward_info in pending_forwards.drain(..) {
1450                                                 match forward_info {
1451                                                         HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1452                                                                 let prev_hop_data = HTLCPreviousHopData {
1453                                                                         short_channel_id: prev_short_channel_id,
1454                                                                         htlc_id: prev_htlc_id,
1455                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1456                                                                 };
1457                                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1458                                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push((forward_info.amt_to_forward, prev_hop_data)),
1459                                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![(forward_info.amt_to_forward, prev_hop_data)]); },
1460                                                                 };
1461                                                                 new_events.push(events::Event::PaymentReceived {
1462                                                                         payment_hash: forward_info.payment_hash,
1463                                                                         amt: forward_info.amt_to_forward,
1464                                                                 });
1465                                                         },
1466                                                         HTLCForwardInfo::FailHTLC { .. } => {
1467                                                                 panic!("Got pending fail of our own HTLC");
1468                                                         }
1469                                                 }
1470                                         }
1471                                 }
1472                         }
1473                 }
1474
1475                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1476                         match update {
1477                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1478                                 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() }),
1479                         };
1480                 }
1481
1482                 if handle_errors.len() > 0 {
1483                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1484                         for (their_node_id, err) in handle_errors.drain(..) {
1485                                 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1486                         }
1487                 }
1488
1489                 if new_events.is_empty() { return }
1490                 let mut events = self.pending_events.lock().unwrap();
1491                 events.append(&mut new_events);
1492         }
1493
1494         /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
1495         /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
1496         /// to inform the network about the uselessness of these channels.
1497         ///
1498         /// This method handles all the details, and must be called roughly once per minute.
1499         pub fn timer_chan_freshness_every_min(&self) {
1500                 let _ = self.total_consistency_lock.read().unwrap();
1501                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1502                 let channel_state = &mut *channel_state_lock;
1503                 for (_, chan) in channel_state.by_id.iter_mut() {
1504                         if chan.is_disabled_staged() && !chan.is_live() {
1505                                 if let Ok(update) = self.get_channel_update(&chan) {
1506                                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1507                                                 msg: update
1508                                         });
1509                                 }
1510                                 chan.to_fresh();
1511                         } else if chan.is_disabled_staged() && chan.is_live() {
1512                                 chan.to_fresh();
1513                         } else if chan.is_disabled_marked() {
1514                                 chan.to_disabled_staged();
1515                         }
1516                 }
1517         }
1518
1519         /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1520         /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1521         /// along the path (including in our own channel on which we received it).
1522         /// Returns false if no payment was found to fail backwards, true if the process of failing the
1523         /// HTLC backwards has been started.
1524         pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
1525                 let _ = self.total_consistency_lock.read().unwrap();
1526
1527                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1528                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1529                 if let Some(mut sources) = removed_source {
1530                         for (recvd_value, htlc_with_hash) in sources.drain(..) {
1531                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1532                                 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1533                                                 HTLCSource::PreviousHopData(htlc_with_hash), payment_hash,
1534                                                 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: byte_utils::be64_to_array(recvd_value).to_vec() });
1535                         }
1536                         true
1537                 } else { false }
1538         }
1539
1540         /// Fails an HTLC backwards to the sender of it to us.
1541         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1542         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1543         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1544         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1545         /// still-available channels.
1546         fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
1547                 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
1548                 //identify whether we sent it or not based on the (I presume) very different runtime
1549                 //between the branches here. We should make this async and move it into the forward HTLCs
1550                 //timer handling.
1551                 match source {
1552                         HTLCSource::OutboundRoute { ref route, .. } => {
1553                                 log_trace!(self, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1554                                 mem::drop(channel_state_lock);
1555                                 match &onion_error {
1556                                         &HTLCFailReason::LightningError { ref err } => {
1557 #[cfg(test)]
1558                                                 let (channel_update, payment_retryable, onion_error_code) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1559 #[cfg(not(test))]
1560                                                 let (channel_update, payment_retryable, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1561                                                 // TODO: If we decided to blame ourselves (or one of our channels) in
1562                                                 // process_onion_failure we should close that channel as it implies our
1563                                                 // next-hop is needlessly blaming us!
1564                                                 if let Some(update) = channel_update {
1565                                                         self.channel_state.lock().unwrap().pending_msg_events.push(
1566                                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1567                                                                         update,
1568                                                                 }
1569                                                         );
1570                                                 }
1571                                                 self.pending_events.lock().unwrap().push(
1572                                                         events::Event::PaymentFailed {
1573                                                                 payment_hash: payment_hash.clone(),
1574                                                                 rejected_by_dest: !payment_retryable,
1575 #[cfg(test)]
1576                                                                 error_code: onion_error_code
1577                                                         }
1578                                                 );
1579                                         },
1580                                         &HTLCFailReason::Reason {
1581 #[cfg(test)]
1582                                                         ref failure_code,
1583                                                         .. } => {
1584                                                 // we get a fail_malformed_htlc from the first hop
1585                                                 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
1586                                                 // failures here, but that would be insufficient as Router::get_route
1587                                                 // generally ignores its view of our own channels as we provide them via
1588                                                 // ChannelDetails.
1589                                                 // TODO: For non-temporary failures, we really should be closing the
1590                                                 // channel here as we apparently can't relay through them anyway.
1591                                                 self.pending_events.lock().unwrap().push(
1592                                                         events::Event::PaymentFailed {
1593                                                                 payment_hash: payment_hash.clone(),
1594                                                                 rejected_by_dest: route.hops.len() == 1,
1595 #[cfg(test)]
1596                                                                 error_code: Some(*failure_code),
1597                                                         }
1598                                                 );
1599                                         }
1600                                 }
1601                         },
1602                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1603                                 let err_packet = match onion_error {
1604                                         HTLCFailReason::Reason { failure_code, data } => {
1605                                                 log_trace!(self, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
1606                                                 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1607                                                 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1608                                         },
1609                                         HTLCFailReason::LightningError { err } => {
1610                                                 log_trace!(self, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
1611                                                 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1612                                         }
1613                                 };
1614
1615                                 let mut forward_event = None;
1616                                 if channel_state_lock.forward_htlcs.is_empty() {
1617                                         forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
1618                                 }
1619                                 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
1620                                         hash_map::Entry::Occupied(mut entry) => {
1621                                                 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
1622                                         },
1623                                         hash_map::Entry::Vacant(entry) => {
1624                                                 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
1625                                         }
1626                                 }
1627                                 mem::drop(channel_state_lock);
1628                                 if let Some(time) = forward_event {
1629                                         let mut pending_events = self.pending_events.lock().unwrap();
1630                                         pending_events.push(events::Event::PendingHTLCsForwardable {
1631                                                 time_forwardable: time
1632                                         });
1633                                 }
1634                         },
1635                 }
1636         }
1637
1638         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1639         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1640         /// should probably kick the net layer to go send messages if this returns true!
1641         ///
1642         /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
1643         /// available within a few percent of the expected amount. This is critical for several
1644         /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
1645         /// payment_preimage without having provided the full value and b) it avoids certain
1646         /// privacy-breaking recipient-probing attacks which may reveal payment activity to
1647         /// motivated attackers.
1648         ///
1649         /// May panic if called except in response to a PaymentReceived event.
1650         pub fn claim_funds(&self, payment_preimage: PaymentPreimage, expected_amount: u64) -> bool {
1651                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1652
1653                 let _ = self.total_consistency_lock.read().unwrap();
1654
1655                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1656                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1657                 if let Some(mut sources) = removed_source {
1658                         for (received_amount, htlc_with_hash) in sources.drain(..) {
1659                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1660                                 if received_amount < expected_amount || received_amount > expected_amount * 2 {
1661                                         let mut htlc_msat_data = byte_utils::be64_to_array(received_amount).to_vec();
1662                                         let mut height_data = byte_utils::be32_to_array(self.latest_block_height.load(Ordering::Acquire) as u32).to_vec();
1663                                         htlc_msat_data.append(&mut height_data);
1664                                         self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1665                                                                          HTLCSource::PreviousHopData(htlc_with_hash), &payment_hash,
1666                                                                          HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_data });
1667                                 } else {
1668                                         self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1669                                 }
1670                         }
1671                         true
1672                 } else { false }
1673         }
1674         fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
1675                 let (their_node_id, err) = loop {
1676                         match source {
1677                                 HTLCSource::OutboundRoute { .. } => {
1678                                         mem::drop(channel_state_lock);
1679                                         let mut pending_events = self.pending_events.lock().unwrap();
1680                                         pending_events.push(events::Event::PaymentSent {
1681                                                 payment_preimage
1682                                         });
1683                                 },
1684                                 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1685                                         //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1686                                         let channel_state = &mut *channel_state_lock;
1687
1688                                         let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1689                                                 Some(chan_id) => chan_id.clone(),
1690                                                 None => {
1691                                                         // TODO: There is probably a channel manager somewhere that needs to
1692                                                         // learn the preimage as the channel already hit the chain and that's
1693                                                         // why it's missing.
1694                                                         return
1695                                                 }
1696                                         };
1697
1698                                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
1699                                                 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
1700                                                 match chan.get_mut().get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1701                                                         Ok((msgs, monitor_option)) => {
1702                                                                 if let Some(chan_monitor) = monitor_option {
1703                                                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1704                                                                                 if was_frozen_for_monitor {
1705                                                                                         assert!(msgs.is_none());
1706                                                                                 } else {
1707                                                                                         break (chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()));
1708                                                                                 }
1709                                                                         }
1710                                                                 }
1711                                                                 if let Some((msg, commitment_signed)) = msgs {
1712                                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1713                                                                                 node_id: chan.get().get_their_node_id(),
1714                                                                                 updates: msgs::CommitmentUpdate {
1715                                                                                         update_add_htlcs: Vec::new(),
1716                                                                                         update_fulfill_htlcs: vec![msg],
1717                                                                                         update_fail_htlcs: Vec::new(),
1718                                                                                         update_fail_malformed_htlcs: Vec::new(),
1719                                                                                         update_fee: None,
1720                                                                                         commitment_signed,
1721                                                                                 }
1722                                                                         });
1723                                                                 }
1724                                                         },
1725                                                         Err(_e) => {
1726                                                                 // TODO: There is probably a channel manager somewhere that needs to
1727                                                                 // learn the preimage as the channel may be about to hit the chain.
1728                                                                 //TODO: Do something with e?
1729                                                                 return
1730                                                         },
1731                                                 }
1732                                         } else { unreachable!(); }
1733                                 },
1734                         }
1735                         return;
1736                 };
1737
1738                 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1739         }
1740
1741         /// Gets the node_id held by this ChannelManager
1742         pub fn get_our_node_id(&self) -> PublicKey {
1743                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1744         }
1745
1746         /// Used to restore channels to normal operation after a
1747         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1748         /// operation.
1749         pub fn test_restore_channel_monitor(&self) {
1750                 let mut close_results = Vec::new();
1751                 let mut htlc_forwards = Vec::new();
1752                 let mut htlc_failures = Vec::new();
1753                 let mut pending_events = Vec::new();
1754                 let _ = self.total_consistency_lock.read().unwrap();
1755
1756                 {
1757                         let mut channel_lock = self.channel_state.lock().unwrap();
1758                         let channel_state = &mut *channel_lock;
1759                         let short_to_id = &mut channel_state.short_to_id;
1760                         let pending_msg_events = &mut channel_state.pending_msg_events;
1761                         channel_state.by_id.retain(|_, channel| {
1762                                 if channel.is_awaiting_monitor_update() {
1763                                         let chan_monitor = channel.channel_monitor().clone();
1764                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1765                                                 match e {
1766                                                         ChannelMonitorUpdateErr::PermanentFailure => {
1767                                                                 // TODO: There may be some pending HTLCs that we intended to fail
1768                                                                 // backwards when a monitor update failed. We should make sure
1769                                                                 // knowledge of those gets moved into the appropriate in-memory
1770                                                                 // ChannelMonitor and they get failed backwards once we get
1771                                                                 // on-chain confirmations.
1772                                                                 // Note I think #198 addresses this, so once it's merged a test
1773                                                                 // should be written.
1774                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1775                                                                         short_to_id.remove(&short_id);
1776                                                                 }
1777                                                                 close_results.push(channel.force_shutdown());
1778                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1779                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1780                                                                                 msg: update
1781                                                                         });
1782                                                                 }
1783                                                                 false
1784                                                         },
1785                                                         ChannelMonitorUpdateErr::TemporaryFailure => true,
1786                                                 }
1787                                         } else {
1788                                                 let (raa, commitment_update, order, pending_forwards, mut pending_failures, needs_broadcast_safe, funding_locked) = channel.monitor_updating_restored();
1789                                                 if !pending_forwards.is_empty() {
1790                                                         htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1791                                                 }
1792                                                 htlc_failures.append(&mut pending_failures);
1793
1794                                                 macro_rules! handle_cs { () => {
1795                                                         if let Some(update) = commitment_update {
1796                                                                 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1797                                                                         node_id: channel.get_their_node_id(),
1798                                                                         updates: update,
1799                                                                 });
1800                                                         }
1801                                                 } }
1802                                                 macro_rules! handle_raa { () => {
1803                                                         if let Some(revoke_and_ack) = raa {
1804                                                                 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1805                                                                         node_id: channel.get_their_node_id(),
1806                                                                         msg: revoke_and_ack,
1807                                                                 });
1808                                                         }
1809                                                 } }
1810                                                 match order {
1811                                                         RAACommitmentOrder::CommitmentFirst => {
1812                                                                 handle_cs!();
1813                                                                 handle_raa!();
1814                                                         },
1815                                                         RAACommitmentOrder::RevokeAndACKFirst => {
1816                                                                 handle_raa!();
1817                                                                 handle_cs!();
1818                                                         },
1819                                                 }
1820                                                 if needs_broadcast_safe {
1821                                                         pending_events.push(events::Event::FundingBroadcastSafe {
1822                                                                 funding_txo: channel.get_funding_txo().unwrap(),
1823                                                                 user_channel_id: channel.get_user_id(),
1824                                                         });
1825                                                 }
1826                                                 if let Some(msg) = funding_locked {
1827                                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1828                                                                 node_id: channel.get_their_node_id(),
1829                                                                 msg,
1830                                                         });
1831                                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
1832                                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1833                                                                         node_id: channel.get_their_node_id(),
1834                                                                         msg: announcement_sigs,
1835                                                                 });
1836                                                         }
1837                                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1838                                                 }
1839                                                 true
1840                                         }
1841                                 } else { true }
1842                         });
1843                 }
1844
1845                 self.pending_events.lock().unwrap().append(&mut pending_events);
1846
1847                 for failure in htlc_failures.drain(..) {
1848                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1849                 }
1850                 self.forward_htlcs(&mut htlc_forwards[..]);
1851
1852                 for res in close_results.drain(..) {
1853                         self.finish_force_close_channel(res);
1854                 }
1855         }
1856
1857         fn internal_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1858                 if msg.chain_hash != self.genesis_hash {
1859                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1860                 }
1861
1862                 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)
1863                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1864                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1865                 let channel_state = &mut *channel_state_lock;
1866                 match channel_state.by_id.entry(channel.channel_id()) {
1867                         hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1868                         hash_map::Entry::Vacant(entry) => {
1869                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1870                                         node_id: their_node_id.clone(),
1871                                         msg: channel.get_accept_channel(),
1872                                 });
1873                                 entry.insert(channel);
1874                         }
1875                 }
1876                 Ok(())
1877         }
1878
1879         fn internal_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1880                 let (value, output_script, user_id) = {
1881                         let mut channel_lock = self.channel_state.lock().unwrap();
1882                         let channel_state = &mut *channel_lock;
1883                         match channel_state.by_id.entry(msg.temporary_channel_id) {
1884                                 hash_map::Entry::Occupied(mut chan) => {
1885                                         if chan.get().get_their_node_id() != *their_node_id {
1886                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1887                                         }
1888                                         try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
1889                                         (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1890                                 },
1891                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1892                         }
1893                 };
1894                 let mut pending_events = self.pending_events.lock().unwrap();
1895                 pending_events.push(events::Event::FundingGenerationReady {
1896                         temporary_channel_id: msg.temporary_channel_id,
1897                         channel_value_satoshis: value,
1898                         output_script: output_script,
1899                         user_channel_id: user_id,
1900                 });
1901                 Ok(())
1902         }
1903
1904         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1905                 let ((funding_msg, monitor_update), mut chan) = {
1906                         let mut channel_lock = self.channel_state.lock().unwrap();
1907                         let channel_state = &mut *channel_lock;
1908                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1909                                 hash_map::Entry::Occupied(mut chan) => {
1910                                         if chan.get().get_their_node_id() != *their_node_id {
1911                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1912                                         }
1913                                         (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1914                                 },
1915                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1916                         }
1917                 };
1918                 // Because we have exclusive ownership of the channel here we can release the channel_state
1919                 // lock before add_update_monitor
1920                 if let Err(e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1921                         match e {
1922                                 ChannelMonitorUpdateErr::PermanentFailure => {
1923                                         // Note that we reply with the new channel_id in error messages if we gave up on the
1924                                         // channel, not the temporary_channel_id. This is compatible with ourselves, but the
1925                                         // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
1926                                         // any messages referencing a previously-closed channel anyway.
1927                                         return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", funding_msg.channel_id, chan.force_shutdown(), None));
1928                                 },
1929                                 ChannelMonitorUpdateErr::TemporaryFailure => {
1930                                         // There's no problem signing a counterparty's funding transaction if our monitor
1931                                         // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
1932                                         // accepted payment from yet. We do, however, need to wait to send our funding_locked
1933                                         // until we have persisted our monitor.
1934                                         chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1935                                 },
1936                         }
1937                 }
1938                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1939                 let channel_state = &mut *channel_state_lock;
1940                 match channel_state.by_id.entry(funding_msg.channel_id) {
1941                         hash_map::Entry::Occupied(_) => {
1942                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1943                         },
1944                         hash_map::Entry::Vacant(e) => {
1945                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1946                                         node_id: their_node_id.clone(),
1947                                         msg: funding_msg,
1948                                 });
1949                                 e.insert(chan);
1950                         }
1951                 }
1952                 Ok(())
1953         }
1954
1955         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1956                 let (funding_txo, user_id) = {
1957                         let mut channel_lock = self.channel_state.lock().unwrap();
1958                         let channel_state = &mut *channel_lock;
1959                         match channel_state.by_id.entry(msg.channel_id) {
1960                                 hash_map::Entry::Occupied(mut chan) => {
1961                                         if chan.get().get_their_node_id() != *their_node_id {
1962                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1963                                         }
1964                                         let chan_monitor = try_chan_entry!(self, chan.get_mut().funding_signed(&msg), channel_state, chan);
1965                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1966                                                 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
1967                                         }
1968                                         (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
1969                                 },
1970                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1971                         }
1972                 };
1973                 let mut pending_events = self.pending_events.lock().unwrap();
1974                 pending_events.push(events::Event::FundingBroadcastSafe {
1975                         funding_txo: funding_txo,
1976                         user_channel_id: user_id,
1977                 });
1978                 Ok(())
1979         }
1980
1981         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
1982                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1983                 let channel_state = &mut *channel_state_lock;
1984                 match channel_state.by_id.entry(msg.channel_id) {
1985                         hash_map::Entry::Occupied(mut chan) => {
1986                                 if chan.get().get_their_node_id() != *their_node_id {
1987                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1988                                 }
1989                                 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
1990                                 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
1991                                         // If we see locking block before receiving remote funding_locked, we broadcast our
1992                                         // announcement_sigs at remote funding_locked reception. If we receive remote
1993                                         // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
1994                                         // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
1995                                         // the order of the events but our peer may not receive it due to disconnection. The specs
1996                                         // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
1997                                         // connection in the future if simultaneous misses by both peers due to network/hardware
1998                                         // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
1999                                         // to be received, from then sigs are going to be flood to the whole network.
2000                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2001                                                 node_id: their_node_id.clone(),
2002                                                 msg: announcement_sigs,
2003                                         });
2004                                 }
2005                                 Ok(())
2006                         },
2007                         hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2008                 }
2009         }
2010
2011         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2012                 let (mut dropped_htlcs, chan_option) = {
2013                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2014                         let channel_state = &mut *channel_state_lock;
2015
2016                         match channel_state.by_id.entry(msg.channel_id.clone()) {
2017                                 hash_map::Entry::Occupied(mut chan_entry) => {
2018                                         if chan_entry.get().get_their_node_id() != *their_node_id {
2019                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2020                                         }
2021                                         let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg), channel_state, chan_entry);
2022                                         if let Some(msg) = shutdown {
2023                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2024                                                         node_id: their_node_id.clone(),
2025                                                         msg,
2026                                                 });
2027                                         }
2028                                         if let Some(msg) = closing_signed {
2029                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2030                                                         node_id: their_node_id.clone(),
2031                                                         msg,
2032                                                 });
2033                                         }
2034                                         if chan_entry.get().is_shutdown() {
2035                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2036                                                         channel_state.short_to_id.remove(&short_id);
2037                                                 }
2038                                                 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2039                                         } else { (dropped_htlcs, None) }
2040                                 },
2041                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2042                         }
2043                 };
2044                 for htlc_source in dropped_htlcs.drain(..) {
2045                         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() });
2046                 }
2047                 if let Some(chan) = chan_option {
2048                         if let Ok(update) = self.get_channel_update(&chan) {
2049                                 let mut channel_state = self.channel_state.lock().unwrap();
2050                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2051                                         msg: update
2052                                 });
2053                         }
2054                 }
2055                 Ok(())
2056         }
2057
2058         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2059                 let (tx, chan_option) = {
2060                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2061                         let channel_state = &mut *channel_state_lock;
2062                         match channel_state.by_id.entry(msg.channel_id.clone()) {
2063                                 hash_map::Entry::Occupied(mut chan_entry) => {
2064                                         if chan_entry.get().get_their_node_id() != *their_node_id {
2065                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2066                                         }
2067                                         let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg), channel_state, chan_entry);
2068                                         if let Some(msg) = closing_signed {
2069                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2070                                                         node_id: their_node_id.clone(),
2071                                                         msg,
2072                                                 });
2073                                         }
2074                                         if tx.is_some() {
2075                                                 // We're done with this channel, we've got a signed closing transaction and
2076                                                 // will send the closing_signed back to the remote peer upon return. This
2077                                                 // also implies there are no pending HTLCs left on the channel, so we can
2078                                                 // fully delete it from tracking (the channel monitor is still around to
2079                                                 // watch for old state broadcasts)!
2080                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2081                                                         channel_state.short_to_id.remove(&short_id);
2082                                                 }
2083                                                 (tx, Some(chan_entry.remove_entry().1))
2084                                         } else { (tx, None) }
2085                                 },
2086                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2087                         }
2088                 };
2089                 if let Some(broadcast_tx) = tx {
2090                         log_trace!(self, "Broadcast onchain {}", log_tx!(broadcast_tx));
2091                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2092                 }
2093                 if let Some(chan) = chan_option {
2094                         if let Ok(update) = self.get_channel_update(&chan) {
2095                                 let mut channel_state = self.channel_state.lock().unwrap();
2096                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2097                                         msg: update
2098                                 });
2099                         }
2100                 }
2101                 Ok(())
2102         }
2103
2104         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2105                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2106                 //determine the state of the payment based on our response/if we forward anything/the time
2107                 //we take to respond. We should take care to avoid allowing such an attack.
2108                 //
2109                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2110                 //us repeatedly garbled in different ways, and compare our error messages, which are
2111                 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2112                 //but we should prevent it anyway.
2113
2114                 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2115                 let channel_state = &mut *channel_state_lock;
2116
2117                 match channel_state.by_id.entry(msg.channel_id) {
2118                         hash_map::Entry::Occupied(mut chan) => {
2119                                 if chan.get().get_their_node_id() != *their_node_id {
2120                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2121                                 }
2122                                 if !chan.get().is_usable() {
2123                                         // If the update_add is completely bogus, the call will Err and we will close,
2124                                         // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2125                                         // want to reject the new HTLC and fail it backwards instead of forwarding.
2126                                         if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2127                                                 let chan_update = self.get_channel_update(chan.get());
2128                                                 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2129                                                         channel_id: msg.channel_id,
2130                                                         htlc_id: msg.htlc_id,
2131                                                         reason: if let Ok(update) = chan_update {
2132                                                                 // TODO: Note that |20 is defined as "channel FROM the processing
2133                                                                 // node has been disabled" (emphasis mine), which seems to imply
2134                                                                 // that we can't return |20 for an inbound channel being disabled.
2135                                                                 // This probably needs a spec update but should definitely be
2136                                                                 // allowed.
2137                                                                 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &{
2138                                                                         let mut res = Vec::with_capacity(8 + 128);
2139                                                                         res.extend_from_slice(&byte_utils::be16_to_array(update.contents.flags));
2140                                                                         res.extend_from_slice(&update.encode_with_len()[..]);
2141                                                                         res
2142                                                                 }[..])
2143                                                         } else {
2144                                                                 // This can only happen if the channel isn't in the fully-funded
2145                                                                 // state yet, implying our counterparty is trying to route payments
2146                                                                 // over the channel back to themselves (cause no one else should
2147                                                                 // know the short_id is a lightning channel yet). We should have no
2148                                                                 // problem just calling this unknown_next_peer
2149                                                                 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2150                                                         },
2151                                                 }));
2152                                         }
2153                                 }
2154                                 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2155                         },
2156                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2157                 }
2158                 Ok(())
2159         }
2160
2161         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2162                 let mut channel_lock = self.channel_state.lock().unwrap();
2163                 let htlc_source = {
2164                         let channel_state = &mut *channel_lock;
2165                         match channel_state.by_id.entry(msg.channel_id) {
2166                                 hash_map::Entry::Occupied(mut chan) => {
2167                                         if chan.get().get_their_node_id() != *their_node_id {
2168                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2169                                         }
2170                                         try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2171                                 },
2172                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2173                         }
2174                 };
2175                 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2176                 Ok(())
2177         }
2178
2179         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2180                 let mut channel_lock = self.channel_state.lock().unwrap();
2181                 let channel_state = &mut *channel_lock;
2182                 match channel_state.by_id.entry(msg.channel_id) {
2183                         hash_map::Entry::Occupied(mut chan) => {
2184                                 if chan.get().get_their_node_id() != *their_node_id {
2185                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2186                                 }
2187                                 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2188                         },
2189                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2190                 }
2191                 Ok(())
2192         }
2193
2194         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2195                 let mut channel_lock = self.channel_state.lock().unwrap();
2196                 let channel_state = &mut *channel_lock;
2197                 match channel_state.by_id.entry(msg.channel_id) {
2198                         hash_map::Entry::Occupied(mut chan) => {
2199                                 if chan.get().get_their_node_id() != *their_node_id {
2200                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2201                                 }
2202                                 if (msg.failure_code & 0x8000) == 0 {
2203                                         try_chan_entry!(self, Err(ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set")), channel_state, chan);
2204                                 }
2205                                 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);
2206                                 Ok(())
2207                         },
2208                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2209                 }
2210         }
2211
2212         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2213                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2214                 let channel_state = &mut *channel_state_lock;
2215                 match channel_state.by_id.entry(msg.channel_id) {
2216                         hash_map::Entry::Occupied(mut chan) => {
2217                                 if chan.get().get_their_node_id() != *their_node_id {
2218                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2219                                 }
2220                                 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) =
2221                                         try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &*self.fee_estimator), channel_state, chan);
2222                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2223                                         return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2224                                         //TODO: Rebroadcast closing_signed if present on monitor update restoration
2225                                 }
2226                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2227                                         node_id: their_node_id.clone(),
2228                                         msg: revoke_and_ack,
2229                                 });
2230                                 if let Some(msg) = commitment_signed {
2231                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2232                                                 node_id: their_node_id.clone(),
2233                                                 updates: msgs::CommitmentUpdate {
2234                                                         update_add_htlcs: Vec::new(),
2235                                                         update_fulfill_htlcs: Vec::new(),
2236                                                         update_fail_htlcs: Vec::new(),
2237                                                         update_fail_malformed_htlcs: Vec::new(),
2238                                                         update_fee: None,
2239                                                         commitment_signed: msg,
2240                                                 },
2241                                         });
2242                                 }
2243                                 if let Some(msg) = closing_signed {
2244                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2245                                                 node_id: their_node_id.clone(),
2246                                                 msg,
2247                                         });
2248                                 }
2249                                 Ok(())
2250                         },
2251                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2252                 }
2253         }
2254
2255         #[inline]
2256         fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2257                 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2258                         let mut forward_event = None;
2259                         if !pending_forwards.is_empty() {
2260                                 let mut channel_state = self.channel_state.lock().unwrap();
2261                                 if channel_state.forward_htlcs.is_empty() {
2262                                         forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2263                                 }
2264                                 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2265                                         match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2266                                                 hash_map::Entry::Occupied(mut entry) => {
2267                                                         entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info });
2268                                                 },
2269                                                 hash_map::Entry::Vacant(entry) => {
2270                                                         entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info }));
2271                                                 }
2272                                         }
2273                                 }
2274                         }
2275                         match forward_event {
2276                                 Some(time) => {
2277                                         let mut pending_events = self.pending_events.lock().unwrap();
2278                                         pending_events.push(events::Event::PendingHTLCsForwardable {
2279                                                 time_forwardable: time
2280                                         });
2281                                 }
2282                                 None => {},
2283                         }
2284                 }
2285         }
2286
2287         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2288                 let (pending_forwards, mut pending_failures, short_channel_id) = {
2289                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2290                         let channel_state = &mut *channel_state_lock;
2291                         match channel_state.by_id.entry(msg.channel_id) {
2292                                 hash_map::Entry::Occupied(mut chan) => {
2293                                         if chan.get().get_their_node_id() != *their_node_id {
2294                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2295                                         }
2296                                         let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2297                                         let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) =
2298                                                 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &*self.fee_estimator), channel_state, chan);
2299                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2300                                                 if was_frozen_for_monitor {
2301                                                         assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2302                                                         return Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA"));
2303                                                 } else {
2304                                                         return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures);
2305                                                 }
2306                                         }
2307                                         if let Some(updates) = commitment_update {
2308                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2309                                                         node_id: their_node_id.clone(),
2310                                                         updates,
2311                                                 });
2312                                         }
2313                                         if let Some(msg) = closing_signed {
2314                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2315                                                         node_id: their_node_id.clone(),
2316                                                         msg,
2317                                                 });
2318                                         }
2319                                         (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2320                                 },
2321                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2322                         }
2323                 };
2324                 for failure in pending_failures.drain(..) {
2325                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2326                 }
2327                 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2328
2329                 Ok(())
2330         }
2331
2332         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2333                 let mut channel_lock = self.channel_state.lock().unwrap();
2334                 let channel_state = &mut *channel_lock;
2335                 match channel_state.by_id.entry(msg.channel_id) {
2336                         hash_map::Entry::Occupied(mut chan) => {
2337                                 if chan.get().get_their_node_id() != *their_node_id {
2338                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2339                                 }
2340                                 try_chan_entry!(self, chan.get_mut().update_fee(&*self.fee_estimator, &msg), channel_state, chan);
2341                         },
2342                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2343                 }
2344                 Ok(())
2345         }
2346
2347         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2348                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2349                 let channel_state = &mut *channel_state_lock;
2350
2351                 match channel_state.by_id.entry(msg.channel_id) {
2352                         hash_map::Entry::Occupied(mut chan) => {
2353                                 if chan.get().get_their_node_id() != *their_node_id {
2354                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2355                                 }
2356                                 if !chan.get().is_usable() {
2357                                         return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: msgs::ErrorAction::IgnoreError}));
2358                                 }
2359
2360                                 let our_node_id = self.get_our_node_id();
2361                                 let (announcement, our_bitcoin_sig) =
2362                                         try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2363
2364                                 let were_node_one = announcement.node_id_1 == our_node_id;
2365                                 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2366                                 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2367                                                 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2368                                         try_chan_entry!(self, Err(ChannelError::Close("Bad announcement_signatures node_signature")), channel_state, chan);
2369                                 }
2370
2371                                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2372
2373                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2374                                         msg: msgs::ChannelAnnouncement {
2375                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2376                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2377                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2378                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2379                                                 contents: announcement,
2380                                         },
2381                                         update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2382                                 });
2383                         },
2384                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2385                 }
2386                 Ok(())
2387         }
2388
2389         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2390                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2391                 let channel_state = &mut *channel_state_lock;
2392
2393                 match channel_state.by_id.entry(msg.channel_id) {
2394                         hash_map::Entry::Occupied(mut chan) => {
2395                                 if chan.get().get_their_node_id() != *their_node_id {
2396                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2397                                 }
2398                                 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, mut order, shutdown) =
2399                                         try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2400                                 if let Some(monitor) = channel_monitor {
2401                                         if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2402                                                 // channel_reestablish doesn't guarantee the order it returns is sensical
2403                                                 // for the messages it returns, but if we're setting what messages to
2404                                                 // re-transmit on monitor update success, we need to make sure it is sane.
2405                                                 if revoke_and_ack.is_none() {
2406                                                         order = RAACommitmentOrder::CommitmentFirst;
2407                                                 }
2408                                                 if commitment_update.is_none() {
2409                                                         order = RAACommitmentOrder::RevokeAndACKFirst;
2410                                                 }
2411                                                 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
2412                                                 //TODO: Resend the funding_locked if needed once we get the monitor running again
2413                                         }
2414                                 }
2415                                 if let Some(msg) = funding_locked {
2416                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2417                                                 node_id: their_node_id.clone(),
2418                                                 msg
2419                                         });
2420                                 }
2421                                 macro_rules! send_raa { () => {
2422                                         if let Some(msg) = revoke_and_ack {
2423                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2424                                                         node_id: their_node_id.clone(),
2425                                                         msg
2426                                                 });
2427                                         }
2428                                 } }
2429                                 macro_rules! send_cu { () => {
2430                                         if let Some(updates) = commitment_update {
2431                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2432                                                         node_id: their_node_id.clone(),
2433                                                         updates
2434                                                 });
2435                                         }
2436                                 } }
2437                                 match order {
2438                                         RAACommitmentOrder::RevokeAndACKFirst => {
2439                                                 send_raa!();
2440                                                 send_cu!();
2441                                         },
2442                                         RAACommitmentOrder::CommitmentFirst => {
2443                                                 send_cu!();
2444                                                 send_raa!();
2445                                         },
2446                                 }
2447                                 if let Some(msg) = shutdown {
2448                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2449                                                 node_id: their_node_id.clone(),
2450                                                 msg,
2451                                         });
2452                                 }
2453                                 Ok(())
2454                         },
2455                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2456                 }
2457         }
2458
2459         /// Begin Update fee process. Allowed only on an outbound channel.
2460         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2461         /// PeerManager::process_events afterwards.
2462         /// Note: This API is likely to change!
2463         #[doc(hidden)]
2464         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2465                 let _ = self.total_consistency_lock.read().unwrap();
2466                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2467                 let their_node_id;
2468                 let err: Result<(), _> = loop {
2469                         let channel_state = &mut *channel_state_lock;
2470
2471                         match channel_state.by_id.entry(channel_id) {
2472                                 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2473                                 hash_map::Entry::Occupied(mut chan) => {
2474                                         if !chan.get().is_outbound() {
2475                                                 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2476                                         }
2477                                         if chan.get().is_awaiting_monitor_update() {
2478                                                 return Err(APIError::MonitorUpdateFailed);
2479                                         }
2480                                         if !chan.get().is_live() {
2481                                                 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2482                                         }
2483                                         their_node_id = chan.get().get_their_node_id();
2484                                         if let Some((update_fee, commitment_signed, chan_monitor)) =
2485                                                         break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2486                                         {
2487                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2488                                                         unimplemented!();
2489                                                 }
2490                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2491                                                         node_id: chan.get().get_their_node_id(),
2492                                                         updates: msgs::CommitmentUpdate {
2493                                                                 update_add_htlcs: Vec::new(),
2494                                                                 update_fulfill_htlcs: Vec::new(),
2495                                                                 update_fail_htlcs: Vec::new(),
2496                                                                 update_fail_malformed_htlcs: Vec::new(),
2497                                                                 update_fee: Some(update_fee),
2498                                                                 commitment_signed,
2499                                                         },
2500                                                 });
2501                                         }
2502                                 },
2503                         }
2504                         return Ok(())
2505                 };
2506
2507                 match handle_error!(self, err, their_node_id, channel_state_lock) {
2508                         Ok(_) => unreachable!(),
2509                         Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
2510                 }
2511         }
2512 }
2513
2514 impl<ChanSigner: ChannelKeys, M: Deref> events::MessageSendEventsProvider for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
2515         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2516                 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2517                 // user to serialize a ChannelManager with pending events in it and lose those events on
2518                 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2519                 {
2520                         //TODO: This behavior should be documented.
2521                         for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2522                                 if let Some(preimage) = htlc_update.payment_preimage {
2523                                         log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2524                                         self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2525                                 } else {
2526                                         log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2527                                         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() });
2528                                 }
2529                         }
2530                 }
2531
2532                 let mut ret = Vec::new();
2533                 let mut channel_state = self.channel_state.lock().unwrap();
2534                 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2535                 ret
2536         }
2537 }
2538
2539 impl<ChanSigner: ChannelKeys, M: Deref> events::EventsProvider for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
2540         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2541                 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2542                 // user to serialize a ChannelManager with pending events in it and lose those events on
2543                 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2544                 {
2545                         //TODO: This behavior should be documented.
2546                         for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2547                                 if let Some(preimage) = htlc_update.payment_preimage {
2548                                         log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2549                                         self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2550                                 } else {
2551                                         log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2552                                         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() });
2553                                 }
2554                         }
2555                 }
2556
2557                 let mut ret = Vec::new();
2558                 let mut pending_events = self.pending_events.lock().unwrap();
2559                 mem::swap(&mut ret, &mut *pending_events);
2560                 ret
2561         }
2562 }
2563
2564 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send> ChainListener for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
2565         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2566                 let header_hash = header.bitcoin_hash();
2567                 log_trace!(self, "Block {} at height {} connected with {} txn matched", header_hash, height, txn_matched.len());
2568                 let _ = self.total_consistency_lock.read().unwrap();
2569                 let mut failed_channels = Vec::new();
2570                 {
2571                         let mut channel_lock = self.channel_state.lock().unwrap();
2572                         let channel_state = &mut *channel_lock;
2573                         let short_to_id = &mut channel_state.short_to_id;
2574                         let pending_msg_events = &mut channel_state.pending_msg_events;
2575                         channel_state.by_id.retain(|_, channel| {
2576                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2577                                 if let Ok(Some(funding_locked)) = chan_res {
2578                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2579                                                 node_id: channel.get_their_node_id(),
2580                                                 msg: funding_locked,
2581                                         });
2582                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2583                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2584                                                         node_id: channel.get_their_node_id(),
2585                                                         msg: announcement_sigs,
2586                                                 });
2587                                         }
2588                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2589                                 } else if let Err(e) = chan_res {
2590                                         pending_msg_events.push(events::MessageSendEvent::HandleError {
2591                                                 node_id: channel.get_their_node_id(),
2592                                                 action: msgs::ErrorAction::SendErrorMessage { msg: e },
2593                                         });
2594                                         return false;
2595                                 }
2596                                 if let Some(funding_txo) = channel.get_funding_txo() {
2597                                         for tx in txn_matched {
2598                                                 for inp in tx.input.iter() {
2599                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2600                                                                 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()));
2601                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2602                                                                         short_to_id.remove(&short_id);
2603                                                                 }
2604                                                                 // It looks like our counterparty went on-chain. We go ahead and
2605                                                                 // broadcast our latest local state as well here, just in case its
2606                                                                 // some kind of SPV attack, though we expect these to be dropped.
2607                                                                 failed_channels.push(channel.force_shutdown());
2608                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2609                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2610                                                                                 msg: update
2611                                                                         });
2612                                                                 }
2613                                                                 return false;
2614                                                         }
2615                                                 }
2616                                         }
2617                                 }
2618                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2619                                         if let Some(short_id) = channel.get_short_channel_id() {
2620                                                 short_to_id.remove(&short_id);
2621                                         }
2622                                         failed_channels.push(channel.force_shutdown());
2623                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2624                                         // the latest local tx for us, so we should skip that here (it doesn't really
2625                                         // hurt anything, but does make tests a bit simpler).
2626                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2627                                         if let Ok(update) = self.get_channel_update(&channel) {
2628                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2629                                                         msg: update
2630                                                 });
2631                                         }
2632                                         return false;
2633                                 }
2634                                 true
2635                         });
2636                 }
2637                 for failure in failed_channels.drain(..) {
2638                         self.finish_force_close_channel(failure);
2639                 }
2640                 self.latest_block_height.store(height as usize, Ordering::Release);
2641                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header_hash;
2642         }
2643
2644         /// We force-close the channel without letting our counterparty participate in the shutdown
2645         fn block_disconnected(&self, header: &BlockHeader, _: u32) {
2646                 let _ = self.total_consistency_lock.read().unwrap();
2647                 let mut failed_channels = Vec::new();
2648                 {
2649                         let mut channel_lock = self.channel_state.lock().unwrap();
2650                         let channel_state = &mut *channel_lock;
2651                         let short_to_id = &mut channel_state.short_to_id;
2652                         let pending_msg_events = &mut channel_state.pending_msg_events;
2653                         channel_state.by_id.retain(|_,  v| {
2654                                 if v.block_disconnected(header) {
2655                                         if let Some(short_id) = v.get_short_channel_id() {
2656                                                 short_to_id.remove(&short_id);
2657                                         }
2658                                         failed_channels.push(v.force_shutdown());
2659                                         if let Ok(update) = self.get_channel_update(&v) {
2660                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2661                                                         msg: update
2662                                                 });
2663                                         }
2664                                         false
2665                                 } else {
2666                                         true
2667                                 }
2668                         });
2669                 }
2670                 for failure in failed_channels.drain(..) {
2671                         self.finish_force_close_channel(failure);
2672                 }
2673                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2674                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2675         }
2676 }
2677
2678 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send> ChannelMessageHandler for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
2679         fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
2680                 let _ = self.total_consistency_lock.read().unwrap();
2681                 let res = self.internal_open_channel(their_node_id, their_features, msg);
2682                 if res.is_err() {
2683                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2684                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2685                 }
2686         }
2687
2688         fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
2689                 let _ = self.total_consistency_lock.read().unwrap();
2690                 let res = self.internal_accept_channel(their_node_id, their_features, msg);
2691                 if res.is_err() {
2692                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2693                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2694                 }
2695         }
2696
2697         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
2698                 let _ = self.total_consistency_lock.read().unwrap();
2699                 let res = self.internal_funding_created(their_node_id, msg);
2700                 if res.is_err() {
2701                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2702                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2703                 }
2704         }
2705
2706         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
2707                 let _ = self.total_consistency_lock.read().unwrap();
2708                 let res = self.internal_funding_signed(their_node_id, msg);
2709                 if res.is_err() {
2710                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2711                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2712                 }
2713         }
2714
2715         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
2716                 let _ = self.total_consistency_lock.read().unwrap();
2717                 let res = self.internal_funding_locked(their_node_id, msg);
2718                 if res.is_err() {
2719                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2720                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2721                 }
2722         }
2723
2724         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
2725                 let _ = self.total_consistency_lock.read().unwrap();
2726                 let res = self.internal_shutdown(their_node_id, msg);
2727                 if res.is_err() {
2728                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2729                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2730                 }
2731         }
2732
2733         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
2734                 let _ = self.total_consistency_lock.read().unwrap();
2735                 let res = self.internal_closing_signed(their_node_id, msg);
2736                 if res.is_err() {
2737                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2738                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2739                 }
2740         }
2741
2742         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
2743                 let _ = self.total_consistency_lock.read().unwrap();
2744                 let res = self.internal_update_add_htlc(their_node_id, msg);
2745                 if res.is_err() {
2746                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2747                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2748                 }
2749         }
2750
2751         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
2752                 let _ = self.total_consistency_lock.read().unwrap();
2753                 let res = self.internal_update_fulfill_htlc(their_node_id, msg);
2754                 if res.is_err() {
2755                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2756                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2757                 }
2758         }
2759
2760         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
2761                 let _ = self.total_consistency_lock.read().unwrap();
2762                 let res = self.internal_update_fail_htlc(their_node_id, msg);
2763                 if res.is_err() {
2764                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2765                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2766                 }
2767         }
2768
2769         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
2770                 let _ = self.total_consistency_lock.read().unwrap();
2771                 let res = self.internal_update_fail_malformed_htlc(their_node_id, msg);
2772                 if res.is_err() {
2773                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2774                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2775                 }
2776         }
2777
2778         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
2779                 let _ = self.total_consistency_lock.read().unwrap();
2780                 let res = self.internal_commitment_signed(their_node_id, msg);
2781                 if res.is_err() {
2782                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2783                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2784                 }
2785         }
2786
2787         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
2788                 let _ = self.total_consistency_lock.read().unwrap();
2789                 let res = self.internal_revoke_and_ack(their_node_id, msg);
2790                 if res.is_err() {
2791                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2792                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2793                 }
2794         }
2795
2796         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
2797                 let _ = self.total_consistency_lock.read().unwrap();
2798                 let res = self.internal_update_fee(their_node_id, msg);
2799                 if res.is_err() {
2800                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2801                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2802                 }
2803         }
2804
2805         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
2806                 let _ = self.total_consistency_lock.read().unwrap();
2807                 let res = self.internal_announcement_signatures(their_node_id, msg);
2808                 if res.is_err() {
2809                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2810                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2811                 }
2812         }
2813
2814         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
2815                 let _ = self.total_consistency_lock.read().unwrap();
2816                 let res = self.internal_channel_reestablish(their_node_id, msg);
2817                 if res.is_err() {
2818                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2819                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2820                 }
2821         }
2822
2823         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2824                 let _ = self.total_consistency_lock.read().unwrap();
2825                 let mut failed_channels = Vec::new();
2826                 let mut failed_payments = Vec::new();
2827                 let mut no_channels_remain = true;
2828                 {
2829                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2830                         let channel_state = &mut *channel_state_lock;
2831                         let short_to_id = &mut channel_state.short_to_id;
2832                         let pending_msg_events = &mut channel_state.pending_msg_events;
2833                         if no_connection_possible {
2834                                 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2835                                 channel_state.by_id.retain(|_, chan| {
2836                                         if chan.get_their_node_id() == *their_node_id {
2837                                                 if let Some(short_id) = chan.get_short_channel_id() {
2838                                                         short_to_id.remove(&short_id);
2839                                                 }
2840                                                 failed_channels.push(chan.force_shutdown());
2841                                                 if let Ok(update) = self.get_channel_update(&chan) {
2842                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2843                                                                 msg: update
2844                                                         });
2845                                                 }
2846                                                 false
2847                                         } else {
2848                                                 true
2849                                         }
2850                                 });
2851                         } else {
2852                                 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2853                                 channel_state.by_id.retain(|_, chan| {
2854                                         if chan.get_their_node_id() == *their_node_id {
2855                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2856                                                 chan.to_disabled_marked();
2857                                                 if !failed_adds.is_empty() {
2858                                                         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
2859                                                         failed_payments.push((chan_update, failed_adds));
2860                                                 }
2861                                                 if chan.is_shutdown() {
2862                                                         if let Some(short_id) = chan.get_short_channel_id() {
2863                                                                 short_to_id.remove(&short_id);
2864                                                         }
2865                                                         return false;
2866                                                 } else {
2867                                                         no_channels_remain = false;
2868                                                 }
2869                                         }
2870                                         true
2871                                 })
2872                         }
2873                         pending_msg_events.retain(|msg| {
2874                                 match msg {
2875                                         &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != their_node_id,
2876                                         &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != their_node_id,
2877                                         &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != their_node_id,
2878                                         &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != their_node_id,
2879                                         &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != their_node_id,
2880                                         &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != their_node_id,
2881                                         &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != their_node_id,
2882                                         &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != their_node_id,
2883                                         &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != their_node_id,
2884                                         &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != their_node_id,
2885                                         &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != their_node_id,
2886                                         &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
2887                                         &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
2888                                         &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != their_node_id,
2889                                         &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
2890                                 }
2891                         });
2892                 }
2893                 if no_channels_remain {
2894                         self.per_peer_state.write().unwrap().remove(their_node_id);
2895                 }
2896
2897                 for failure in failed_channels.drain(..) {
2898                         self.finish_force_close_channel(failure);
2899                 }
2900                 for (chan_update, mut htlc_sources) in failed_payments {
2901                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2902                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2903                         }
2904                 }
2905         }
2906
2907         fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init) {
2908                 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2909
2910                 let _ = self.total_consistency_lock.read().unwrap();
2911
2912                 {
2913                         let mut peer_state_lock = self.per_peer_state.write().unwrap();
2914                         match peer_state_lock.entry(their_node_id.clone()) {
2915                                 hash_map::Entry::Vacant(e) => {
2916                                         e.insert(Mutex::new(PeerState {
2917                                                 latest_features: init_msg.features.clone(),
2918                                         }));
2919                                 },
2920                                 hash_map::Entry::Occupied(e) => {
2921                                         e.get().lock().unwrap().latest_features = init_msg.features.clone();
2922                                 },
2923                         }
2924                 }
2925
2926                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2927                 let channel_state = &mut *channel_state_lock;
2928                 let pending_msg_events = &mut channel_state.pending_msg_events;
2929                 channel_state.by_id.retain(|_, chan| {
2930                         if chan.get_their_node_id() == *their_node_id {
2931                                 if !chan.have_received_message() {
2932                                         // If we created this (outbound) channel while we were disconnected from the
2933                                         // peer we probably failed to send the open_channel message, which is now
2934                                         // lost. We can't have had anything pending related to this channel, so we just
2935                                         // drop it.
2936                                         false
2937                                 } else {
2938                                         pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2939                                                 node_id: chan.get_their_node_id(),
2940                                                 msg: chan.get_channel_reestablish(),
2941                                         });
2942                                         true
2943                                 }
2944                         } else { true }
2945                 });
2946                 //TODO: Also re-broadcast announcement_signatures
2947         }
2948
2949         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2950                 let _ = self.total_consistency_lock.read().unwrap();
2951
2952                 if msg.channel_id == [0; 32] {
2953                         for chan in self.list_channels() {
2954                                 if chan.remote_network_id == *their_node_id {
2955                                         self.force_close_channel(&chan.channel_id);
2956                                 }
2957                         }
2958                 } else {
2959                         self.force_close_channel(&msg.channel_id);
2960                 }
2961         }
2962 }
2963
2964 const SERIALIZATION_VERSION: u8 = 1;
2965 const MIN_SERIALIZATION_VERSION: u8 = 1;
2966
2967 impl Writeable for PendingForwardHTLCInfo {
2968         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2969                 self.onion_packet.write(writer)?;
2970                 self.incoming_shared_secret.write(writer)?;
2971                 self.payment_hash.write(writer)?;
2972                 self.short_channel_id.write(writer)?;
2973                 self.amt_to_forward.write(writer)?;
2974                 self.outgoing_cltv_value.write(writer)?;
2975                 Ok(())
2976         }
2977 }
2978
2979 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
2980         fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
2981                 Ok(PendingForwardHTLCInfo {
2982                         onion_packet: Readable::read(reader)?,
2983                         incoming_shared_secret: Readable::read(reader)?,
2984                         payment_hash: Readable::read(reader)?,
2985                         short_channel_id: Readable::read(reader)?,
2986                         amt_to_forward: Readable::read(reader)?,
2987                         outgoing_cltv_value: Readable::read(reader)?,
2988                 })
2989         }
2990 }
2991
2992 impl Writeable for HTLCFailureMsg {
2993         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2994                 match self {
2995                         &HTLCFailureMsg::Relay(ref fail_msg) => {
2996                                 0u8.write(writer)?;
2997                                 fail_msg.write(writer)?;
2998                         },
2999                         &HTLCFailureMsg::Malformed(ref fail_msg) => {
3000                                 1u8.write(writer)?;
3001                                 fail_msg.write(writer)?;
3002                         }
3003                 }
3004                 Ok(())
3005         }
3006 }
3007
3008 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
3009         fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3010                 match <u8 as Readable<R>>::read(reader)? {
3011                         0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
3012                         1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
3013                         _ => Err(DecodeError::InvalidValue),
3014                 }
3015         }
3016 }
3017
3018 impl Writeable for PendingHTLCStatus {
3019         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3020                 match self {
3021                         &PendingHTLCStatus::Forward(ref forward_info) => {
3022                                 0u8.write(writer)?;
3023                                 forward_info.write(writer)?;
3024                         },
3025                         &PendingHTLCStatus::Fail(ref fail_msg) => {
3026                                 1u8.write(writer)?;
3027                                 fail_msg.write(writer)?;
3028                         }
3029                 }
3030                 Ok(())
3031         }
3032 }
3033
3034 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3035         fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3036                 match <u8 as Readable<R>>::read(reader)? {
3037                         0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3038                         1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3039                         _ => Err(DecodeError::InvalidValue),
3040                 }
3041         }
3042 }
3043
3044 impl_writeable!(HTLCPreviousHopData, 0, {
3045         short_channel_id,
3046         htlc_id,
3047         incoming_packet_shared_secret
3048 });
3049
3050 impl Writeable for HTLCSource {
3051         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3052                 match self {
3053                         &HTLCSource::PreviousHopData(ref hop_data) => {
3054                                 0u8.write(writer)?;
3055                                 hop_data.write(writer)?;
3056                         },
3057                         &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
3058                                 1u8.write(writer)?;
3059                                 route.write(writer)?;
3060                                 session_priv.write(writer)?;
3061                                 first_hop_htlc_msat.write(writer)?;
3062                         }
3063                 }
3064                 Ok(())
3065         }
3066 }
3067
3068 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3069         fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3070                 match <u8 as Readable<R>>::read(reader)? {
3071                         0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3072                         1 => Ok(HTLCSource::OutboundRoute {
3073                                 route: Readable::read(reader)?,
3074                                 session_priv: Readable::read(reader)?,
3075                                 first_hop_htlc_msat: Readable::read(reader)?,
3076                         }),
3077                         _ => Err(DecodeError::InvalidValue),
3078                 }
3079         }
3080 }
3081
3082 impl Writeable for HTLCFailReason {
3083         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3084                 match self {
3085                         &HTLCFailReason::LightningError { ref err } => {
3086                                 0u8.write(writer)?;
3087                                 err.write(writer)?;
3088                         },
3089                         &HTLCFailReason::Reason { ref failure_code, ref data } => {
3090                                 1u8.write(writer)?;
3091                                 failure_code.write(writer)?;
3092                                 data.write(writer)?;
3093                         }
3094                 }
3095                 Ok(())
3096         }
3097 }
3098
3099 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3100         fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3101                 match <u8 as Readable<R>>::read(reader)? {
3102                         0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
3103                         1 => Ok(HTLCFailReason::Reason {
3104                                 failure_code: Readable::read(reader)?,
3105                                 data: Readable::read(reader)?,
3106                         }),
3107                         _ => Err(DecodeError::InvalidValue),
3108                 }
3109         }
3110 }
3111
3112 impl Writeable for HTLCForwardInfo {
3113         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3114                 match self {
3115                         &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_htlc_id, ref forward_info } => {
3116                                 0u8.write(writer)?;
3117                                 prev_short_channel_id.write(writer)?;
3118                                 prev_htlc_id.write(writer)?;
3119                                 forward_info.write(writer)?;
3120                         },
3121                         &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
3122                                 1u8.write(writer)?;
3123                                 htlc_id.write(writer)?;
3124                                 err_packet.write(writer)?;
3125                         },
3126                 }
3127                 Ok(())
3128         }
3129 }
3130
3131 impl<R: ::std::io::Read> Readable<R> for HTLCForwardInfo {
3132         fn read(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3133                 match <u8 as Readable<R>>::read(reader)? {
3134                         0 => Ok(HTLCForwardInfo::AddHTLC {
3135                                 prev_short_channel_id: Readable::read(reader)?,
3136                                 prev_htlc_id: Readable::read(reader)?,
3137                                 forward_info: Readable::read(reader)?,
3138                         }),
3139                         1 => Ok(HTLCForwardInfo::FailHTLC {
3140                                 htlc_id: Readable::read(reader)?,
3141                                 err_packet: Readable::read(reader)?,
3142                         }),
3143                         _ => Err(DecodeError::InvalidValue),
3144                 }
3145         }
3146 }
3147
3148 impl<ChanSigner: ChannelKeys + Writeable, M: Deref> Writeable for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
3149         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3150                 let _ = self.total_consistency_lock.write().unwrap();
3151
3152                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3153                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3154
3155                 self.genesis_hash.write(writer)?;
3156                 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3157                 self.last_block_hash.lock().unwrap().write(writer)?;
3158
3159                 let channel_state = self.channel_state.lock().unwrap();
3160                 let mut unfunded_channels = 0;
3161                 for (_, channel) in channel_state.by_id.iter() {
3162                         if !channel.is_funding_initiated() {
3163                                 unfunded_channels += 1;
3164                         }
3165                 }
3166                 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3167                 for (_, channel) in channel_state.by_id.iter() {
3168                         if channel.is_funding_initiated() {
3169                                 channel.write(writer)?;
3170                         }
3171                 }
3172
3173                 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3174                 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3175                         short_channel_id.write(writer)?;
3176                         (pending_forwards.len() as u64).write(writer)?;
3177                         for forward in pending_forwards {
3178                                 forward.write(writer)?;
3179                         }
3180                 }
3181
3182                 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3183                 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3184                         payment_hash.write(writer)?;
3185                         (previous_hops.len() as u64).write(writer)?;
3186                         for &(recvd_amt, ref previous_hop) in previous_hops.iter() {
3187                                 recvd_amt.write(writer)?;
3188                                 previous_hop.write(writer)?;
3189                         }
3190                 }
3191
3192                 let per_peer_state = self.per_peer_state.write().unwrap();
3193                 (per_peer_state.len() as u64).write(writer)?;
3194                 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
3195                         peer_pubkey.write(writer)?;
3196                         let peer_state = peer_state_mutex.lock().unwrap();
3197                         peer_state.latest_features.write(writer)?;
3198                 }
3199
3200                 Ok(())
3201         }
3202 }
3203
3204 /// Arguments for the creation of a ChannelManager that are not deserialized.
3205 ///
3206 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3207 /// is:
3208 /// 1) Deserialize all stored ChannelMonitors.
3209 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3210 ///    ChannelManager)>::read(reader, args).
3211 ///    This may result in closing some Channels if the ChannelMonitor is newer than the stored
3212 ///    ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3213 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3214 ///    ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3215 /// 4) Reconnect blocks on your ChannelMonitors.
3216 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3217 /// 6) Disconnect/connect blocks on the ChannelManager.
3218 /// 7) Register the new ChannelManager with your ChainWatchInterface.
3219 pub struct ChannelManagerReadArgs<'a, ChanSigner: ChannelKeys, M: Deref> where M::Target: ManyChannelMonitor {
3220         /// The keys provider which will give us relevant keys. Some keys will be loaded during
3221         /// deserialization.
3222         pub keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>,
3223
3224         /// The fee_estimator for use in the ChannelManager in the future.
3225         ///
3226         /// No calls to the FeeEstimator will be made during deserialization.
3227         pub fee_estimator: Arc<FeeEstimator>,
3228         /// The ManyChannelMonitor for use in the ChannelManager in the future.
3229         ///
3230         /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3231         /// you have deserialized ChannelMonitors separately and will add them to your
3232         /// ManyChannelMonitor after deserializing this ChannelManager.
3233         pub monitor: M,
3234
3235         /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3236         /// used to broadcast the latest local commitment transactions of channels which must be
3237         /// force-closed during deserialization.
3238         pub tx_broadcaster: Arc<BroadcasterInterface>,
3239         /// The Logger for use in the ChannelManager and which may be used to log information during
3240         /// deserialization.
3241         pub logger: Arc<Logger>,
3242         /// Default settings used for new channels. Any existing channels will continue to use the
3243         /// runtime settings which were stored when the ChannelManager was serialized.
3244         pub default_config: UserConfig,
3245
3246         /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3247         /// value.get_funding_txo() should be the key).
3248         ///
3249         /// If a monitor is inconsistent with the channel state during deserialization the channel will
3250         /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
3251         /// is true for missing channels as well. If there is a monitor missing for which we find
3252         /// channel data Err(DecodeError::InvalidValue) will be returned.
3253         ///
3254         /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3255         /// this struct.
3256         pub channel_monitors: &'a mut HashMap<OutPoint, &'a mut ChannelMonitor>,
3257 }
3258
3259 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 {
3260         fn read(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M>) -> Result<Self, DecodeError> {
3261                 let _ver: u8 = Readable::read(reader)?;
3262                 let min_ver: u8 = Readable::read(reader)?;
3263                 if min_ver > SERIALIZATION_VERSION {
3264                         return Err(DecodeError::UnknownVersion);
3265                 }
3266
3267                 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3268                 let latest_block_height: u32 = Readable::read(reader)?;
3269                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3270
3271                 let mut closed_channels = Vec::new();
3272
3273                 let channel_count: u64 = Readable::read(reader)?;
3274                 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3275                 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3276                 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3277                 for _ in 0..channel_count {
3278                         let mut channel: Channel<ChanSigner> = ReadableArgs::read(reader, args.logger.clone())?;
3279                         if channel.last_block_connected != last_block_hash {
3280                                 return Err(DecodeError::InvalidValue);
3281                         }
3282
3283                         let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3284                         funding_txo_set.insert(funding_txo.clone());
3285                         if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
3286                                 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3287                                                 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3288                                                 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3289                                         let mut force_close_res = channel.force_shutdown();
3290                                         force_close_res.0 = monitor.get_latest_local_commitment_txn();
3291                                         closed_channels.push(force_close_res);
3292                                 } else {
3293                                         if let Some(short_channel_id) = channel.get_short_channel_id() {
3294                                                 short_to_id.insert(short_channel_id, channel.channel_id());
3295                                         }
3296                                         by_id.insert(channel.channel_id(), channel);
3297                                 }
3298                         } else {
3299                                 return Err(DecodeError::InvalidValue);
3300                         }
3301                 }
3302
3303                 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
3304                         if !funding_txo_set.contains(funding_txo) {
3305                                 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3306                         }
3307                 }
3308
3309                 let forward_htlcs_count: u64 = Readable::read(reader)?;
3310                 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3311                 for _ in 0..forward_htlcs_count {
3312                         let short_channel_id = Readable::read(reader)?;
3313                         let pending_forwards_count: u64 = Readable::read(reader)?;
3314                         let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3315                         for _ in 0..pending_forwards_count {
3316                                 pending_forwards.push(Readable::read(reader)?);
3317                         }
3318                         forward_htlcs.insert(short_channel_id, pending_forwards);
3319                 }
3320
3321                 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3322                 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3323                 for _ in 0..claimable_htlcs_count {
3324                         let payment_hash = Readable::read(reader)?;
3325                         let previous_hops_len: u64 = Readable::read(reader)?;
3326                         let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3327                         for _ in 0..previous_hops_len {
3328                                 previous_hops.push((Readable::read(reader)?, Readable::read(reader)?));
3329                         }
3330                         claimable_htlcs.insert(payment_hash, previous_hops);
3331                 }
3332
3333                 let peer_count: u64 = Readable::read(reader)?;
3334                 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, 128));
3335                 for _ in 0..peer_count {
3336                         let peer_pubkey = Readable::read(reader)?;
3337                         let peer_state = PeerState {
3338                                 latest_features: Readable::read(reader)?,
3339                         };
3340                         per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
3341                 }
3342
3343                 let channel_manager = ChannelManager {
3344                         genesis_hash,
3345                         fee_estimator: args.fee_estimator,
3346                         monitor: args.monitor,
3347                         tx_broadcaster: args.tx_broadcaster,
3348
3349                         latest_block_height: AtomicUsize::new(latest_block_height as usize),
3350                         last_block_hash: Mutex::new(last_block_hash),
3351                         secp_ctx: Secp256k1::new(),
3352
3353                         channel_state: Mutex::new(ChannelHolder {
3354                                 by_id,
3355                                 short_to_id,
3356                                 forward_htlcs,
3357                                 claimable_htlcs,
3358                                 pending_msg_events: Vec::new(),
3359                         }),
3360                         our_network_key: args.keys_manager.get_node_secret(),
3361
3362                         per_peer_state: RwLock::new(per_peer_state),
3363
3364                         pending_events: Mutex::new(Vec::new()),
3365                         total_consistency_lock: RwLock::new(()),
3366                         keys_manager: args.keys_manager,
3367                         logger: args.logger,
3368                         default_configuration: args.default_config,
3369                 };
3370
3371                 for close_res in closed_channels.drain(..) {
3372                         channel_manager.finish_force_close_channel(close_res);
3373                         //TODO: Broadcast channel update for closed channels, but only after we've made a
3374                         //connection or two.
3375                 }
3376
3377                 Ok((last_block_hash.clone(), channel_manager))
3378         }
3379 }