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