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