_ Git - rust-lightning/blob - lightning/src/ln/channelmanager.rs

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