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