1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see routing::router::get_route for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
21 use bitcoin::blockdata::block::{Block, BlockHeader};
22 use bitcoin::blockdata::transaction::Transaction;
23 use bitcoin::blockdata::constants::genesis_block;
24 use bitcoin::network::constants::Network;
26 use bitcoin::hashes::{Hash, HashEngine};
27 use bitcoin::hashes::hmac::{Hmac, HmacEngine};
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
30 use bitcoin::hashes::cmp::fixed_time_eq;
31 use bitcoin::hash_types::{BlockHash, Txid};
33 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
34 use bitcoin::secp256k1::Secp256k1;
35 use bitcoin::secp256k1::ecdh::SharedSecret;
36 use bitcoin::secp256k1;
40 use chain::chaininterface::{BroadcasterInterface, FeeEstimator};
41 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, ChannelMonitorUpdateErr, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
42 use chain::transaction::{OutPoint, TransactionData};
43 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
44 // construct one themselves.
45 pub use ln::channel::CounterpartyForwardingInfo;
46 use ln::channel::{Channel, ChannelError};
47 use ln::features::{InitFeatures, NodeFeatures};
48 use routing::router::{Route, RouteHop};
50 use ln::msgs::NetAddress;
52 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, OptionalField};
53 use chain::keysinterface::{Sign, KeysInterface, KeysManager, InMemorySigner};
54 use util::config::UserConfig;
55 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
56 use util::{byte_utils, events};
57 use util::ser::{Readable, ReadableArgs, MaybeReadable, Writeable, Writer};
58 use util::chacha20::{ChaCha20, ChaChaReader};
59 use util::logger::Logger;
60 use util::errors::APIError;
63 use std::collections::{HashMap, hash_map, HashSet};
64 use std::io::{Cursor, Read};
65 use std::sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard};
66 use std::sync::atomic::{AtomicUsize, Ordering};
67 use std::time::Duration;
68 #[cfg(any(test, feature = "allow_wallclock_use"))]
69 use std::time::Instant;
70 use std::marker::{Sync, Send};
72 use bitcoin::hashes::hex::ToHex;
74 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
76 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
77 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
78 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
80 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
81 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
82 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
83 // before we forward it.
85 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
86 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
87 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
88 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
89 // our payment, which we can use to decode errors or inform the user that the payment was sent.
91 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
92 enum PendingHTLCRouting {
94 onion_packet: msgs::OnionPacket,
95 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
98 payment_data: Option<msgs::FinalOnionHopData>,
99 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
103 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
104 pub(super) struct PendingHTLCInfo {
105 routing: PendingHTLCRouting,
106 incoming_shared_secret: [u8; 32],
107 payment_hash: PaymentHash,
108 pub(super) amt_to_forward: u64,
109 pub(super) outgoing_cltv_value: u32,
112 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
113 pub(super) enum HTLCFailureMsg {
114 Relay(msgs::UpdateFailHTLC),
115 Malformed(msgs::UpdateFailMalformedHTLC),
118 /// Stores whether we can't forward an HTLC or relevant forwarding info
119 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
120 pub(super) enum PendingHTLCStatus {
121 Forward(PendingHTLCInfo),
122 Fail(HTLCFailureMsg),
125 pub(super) enum HTLCForwardInfo {
127 forward_info: PendingHTLCInfo,
129 // These fields are produced in `forward_htlcs()` and consumed in
130 // `process_pending_htlc_forwards()` for constructing the
131 // `HTLCSource::PreviousHopData` for failed and forwarded
133 prev_short_channel_id: u64,
135 prev_funding_outpoint: OutPoint,
139 err_packet: msgs::OnionErrorPacket,
143 /// Tracks the inbound corresponding to an outbound HTLC
144 #[derive(Clone, PartialEq)]
145 pub(crate) struct HTLCPreviousHopData {
146 short_channel_id: u64,
148 incoming_packet_shared_secret: [u8; 32],
150 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
151 // channel with a preimage provided by the forward channel.
155 struct ClaimableHTLC {
156 prev_hop: HTLCPreviousHopData,
158 /// Filled in when the HTLC was received with a payment_secret packet, which contains a
159 /// total_msat (which may differ from value if this is a Multi-Path Payment) and a
160 /// payment_secret which prevents path-probing attacks and can associate different HTLCs which
161 /// are part of the same payment.
162 payment_data: Option<msgs::FinalOnionHopData>,
166 /// Tracks the inbound corresponding to an outbound HTLC
167 #[derive(Clone, PartialEq)]
168 pub(crate) enum HTLCSource {
169 PreviousHopData(HTLCPreviousHopData),
172 session_priv: SecretKey,
173 /// Technically we can recalculate this from the route, but we cache it here to avoid
174 /// doing a double-pass on route when we get a failure back
175 first_hop_htlc_msat: u64,
180 pub fn dummy() -> Self {
181 HTLCSource::OutboundRoute {
183 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
184 first_hop_htlc_msat: 0,
189 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
190 pub(super) enum HTLCFailReason {
192 err: msgs::OnionErrorPacket,
200 /// payment_hash type, use to cross-lock hop
201 /// (C-not exported) as we just use [u8; 32] directly
202 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
203 pub struct PaymentHash(pub [u8;32]);
204 /// payment_preimage type, use to route payment between hop
205 /// (C-not exported) as we just use [u8; 32] directly
206 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
207 pub struct PaymentPreimage(pub [u8;32]);
208 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
209 /// (C-not exported) as we just use [u8; 32] directly
210 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
211 pub struct PaymentSecret(pub [u8;32]);
213 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>);
215 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
216 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
217 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
218 /// channel_state lock. We then return the set of things that need to be done outside the lock in
219 /// this struct and call handle_error!() on it.
221 struct MsgHandleErrInternal {
222 err: msgs::LightningError,
223 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
225 impl MsgHandleErrInternal {
227 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
229 err: LightningError {
231 action: msgs::ErrorAction::SendErrorMessage {
232 msg: msgs::ErrorMessage {
238 shutdown_finish: None,
242 fn ignore_no_close(err: String) -> Self {
244 err: LightningError {
246 action: msgs::ErrorAction::IgnoreError,
248 shutdown_finish: None,
252 fn from_no_close(err: msgs::LightningError) -> Self {
253 Self { err, shutdown_finish: None }
256 fn from_finish_shutdown(err: String, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
258 err: LightningError {
260 action: msgs::ErrorAction::SendErrorMessage {
261 msg: msgs::ErrorMessage {
267 shutdown_finish: Some((shutdown_res, channel_update)),
271 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
274 ChannelError::Ignore(msg) => LightningError {
276 action: msgs::ErrorAction::IgnoreError,
278 ChannelError::Close(msg) => LightningError {
280 action: msgs::ErrorAction::SendErrorMessage {
281 msg: msgs::ErrorMessage {
287 ChannelError::CloseDelayBroadcast(msg) => LightningError {
289 action: msgs::ErrorAction::SendErrorMessage {
290 msg: msgs::ErrorMessage {
297 shutdown_finish: None,
302 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
303 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
304 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
305 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
306 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
308 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
309 /// be sent in the order they appear in the return value, however sometimes the order needs to be
310 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
311 /// they were originally sent). In those cases, this enum is also returned.
312 #[derive(Clone, PartialEq)]
313 pub(super) enum RAACommitmentOrder {
314 /// Send the CommitmentUpdate messages first
316 /// Send the RevokeAndACK message first
320 // Note this is only exposed in cfg(test):
321 pub(super) struct ChannelHolder<Signer: Sign> {
322 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
323 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
324 /// short channel id -> forward infos. Key of 0 means payments received
325 /// Note that while this is held in the same mutex as the channels themselves, no consistency
326 /// guarantees are made about the existence of a channel with the short id here, nor the short
327 /// ids in the PendingHTLCInfo!
328 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
329 /// (payment_hash, payment_secret) -> Vec<HTLCs> for tracking HTLCs that
330 /// were to us and can be failed/claimed by the user
331 /// Note that while this is held in the same mutex as the channels themselves, no consistency
332 /// guarantees are made about the channels given here actually existing anymore by the time you
334 claimable_htlcs: HashMap<(PaymentHash, Option<PaymentSecret>), Vec<ClaimableHTLC>>,
335 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
336 /// for broadcast messages, where ordering isn't as strict).
337 pub(super) pending_msg_events: Vec<MessageSendEvent>,
340 /// Events which we process internally but cannot be procsesed immediately at the generation site
341 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
342 /// quite some time lag.
343 enum BackgroundEvent {
344 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
345 /// commitment transaction.
346 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
349 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
350 /// the latest Init features we heard from the peer.
352 latest_features: InitFeatures,
355 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
356 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
357 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
358 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
359 /// issues such as overly long function definitions. Note that the ChannelManager can take any
360 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
361 /// concrete type of the KeysManager.
362 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
364 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
365 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
366 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
367 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
368 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
369 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
370 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
371 /// concrete type of the KeysManager.
372 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
374 /// Manager which keeps track of a number of channels and sends messages to the appropriate
375 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
377 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
378 /// to individual Channels.
380 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
381 /// all peers during write/read (though does not modify this instance, only the instance being
382 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
383 /// called funding_transaction_generated for outbound channels).
385 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
386 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
387 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
388 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
389 /// the serialization process). If the deserialized version is out-of-date compared to the
390 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
391 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
393 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
394 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
395 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
396 /// block_connected() to step towards your best block) upon deserialization before using the
399 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
400 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
401 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
402 /// offline for a full minute. In order to track this, you must call
403 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
405 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
406 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
407 /// essentially you should default to using a SimpleRefChannelManager, and use a
408 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
409 /// you're using lightning-net-tokio.
410 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
411 where M::Target: chain::Watch<Signer>,
412 T::Target: BroadcasterInterface,
413 K::Target: KeysInterface<Signer = Signer>,
414 F::Target: FeeEstimator,
417 default_configuration: UserConfig,
418 genesis_hash: BlockHash,
424 pub(super) best_block: RwLock<BestBlock>,
426 best_block: RwLock<BestBlock>,
427 secp_ctx: Secp256k1<secp256k1::All>,
429 #[cfg(any(test, feature = "_test_utils"))]
430 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
431 #[cfg(not(any(test, feature = "_test_utils")))]
432 channel_state: Mutex<ChannelHolder<Signer>>,
433 our_network_key: SecretKey,
434 our_network_pubkey: PublicKey,
436 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
437 /// value increases strictly since we don't assume access to a time source.
438 last_node_announcement_serial: AtomicUsize,
440 /// The bulk of our storage will eventually be here (channels and message queues and the like).
441 /// If we are connected to a peer we always at least have an entry here, even if no channels
442 /// are currently open with that peer.
443 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
444 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
446 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
448 pending_events: Mutex<Vec<events::Event>>,
449 pending_background_events: Mutex<Vec<BackgroundEvent>>,
450 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
451 /// Essentially just when we're serializing ourselves out.
452 /// Taken first everywhere where we are making changes before any other locks.
453 /// When acquiring this lock in read mode, rather than acquiring it directly, call
454 /// `PersistenceNotifierGuard::new(..)` and pass the lock to it, to ensure the PersistenceNotifier
455 /// the lock contains sends out a notification when the lock is released.
456 total_consistency_lock: RwLock<()>,
458 persistence_notifier: PersistenceNotifier,
465 /// Chain-related parameters used to construct a new `ChannelManager`.
467 /// Typically, the block-specific parameters are derived from the best block hash for the network,
468 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
469 /// are not needed when deserializing a previously constructed `ChannelManager`.
470 pub struct ChainParameters {
471 /// The network for determining the `chain_hash` in Lightning messages.
472 pub network: Network,
474 /// The hash and height of the latest block successfully connected.
476 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
477 pub best_block: BestBlock,
480 /// The best known block as identified by its hash and height.
481 pub struct BestBlock {
482 block_hash: BlockHash,
487 /// Returns the best block from the genesis of the given network.
488 pub fn from_genesis(network: Network) -> Self {
490 block_hash: genesis_block(network).header.block_hash(),
495 /// Returns the best block as identified by the given block hash and height.
496 pub fn new(block_hash: BlockHash, height: u32) -> Self {
497 BestBlock { block_hash, height }
500 /// Returns the best block hash.
501 pub fn block_hash(&self) -> BlockHash { self.block_hash }
503 /// Returns the best block height.
504 pub fn height(&self) -> u32 { self.height }
507 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
508 /// desirable to notify any listeners on `await_persistable_update_timeout`/
509 /// `await_persistable_update` that new updates are available for persistence. Therefore, this
510 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
511 /// sending the aforementioned notification (since the lock being released indicates that the
512 /// updates are ready for persistence).
513 struct PersistenceNotifierGuard<'a> {
514 persistence_notifier: &'a PersistenceNotifier,
515 // We hold onto this result so the lock doesn't get released immediately.
516 _read_guard: RwLockReadGuard<'a, ()>,
519 impl<'a> PersistenceNotifierGuard<'a> {
520 fn new(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> Self {
521 let read_guard = lock.read().unwrap();
524 persistence_notifier: notifier,
525 _read_guard: read_guard,
530 impl<'a> Drop for PersistenceNotifierGuard<'a> {
532 self.persistence_notifier.notify();
536 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
537 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
539 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
541 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
542 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
543 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
544 /// the maximum required amount in lnd as of March 2021.
545 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
547 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
548 /// HTLC's CLTV. The current default represents roughly six hours of blocks at six blocks/hour.
550 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
552 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
553 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
554 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
555 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
556 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
557 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6 * 6;
558 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
560 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
561 // ie that if the next-hop peer fails the HTLC within
562 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
563 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
564 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
565 // LATENCY_GRACE_PERIOD_BLOCKS.
568 const CHECK_CLTV_EXPIRY_SANITY: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - CLTV_CLAIM_BUFFER - ANTI_REORG_DELAY - LATENCY_GRACE_PERIOD_BLOCKS;
570 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
571 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
574 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
576 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
578 pub struct ChannelDetails {
579 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
580 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
581 /// Note that this means this value is *not* persistent - it can change once during the
582 /// lifetime of the channel.
583 pub channel_id: [u8; 32],
584 /// The position of the funding transaction in the chain. None if the funding transaction has
585 /// not yet been confirmed and the channel fully opened.
586 pub short_channel_id: Option<u64>,
587 /// The node_id of our counterparty
588 pub remote_network_id: PublicKey,
589 /// The Features the channel counterparty provided upon last connection.
590 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
591 /// many routing-relevant features are present in the init context.
592 pub counterparty_features: InitFeatures,
593 /// The value, in satoshis, of this channel as appears in the funding output
594 pub channel_value_satoshis: u64,
595 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
597 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
598 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
599 /// available for inclusion in new outbound HTLCs). This further does not include any pending
600 /// outgoing HTLCs which are awaiting some other resolution to be sent.
601 pub outbound_capacity_msat: u64,
602 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
603 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
604 /// available for inclusion in new inbound HTLCs).
605 /// Note that there are some corner cases not fully handled here, so the actual available
606 /// inbound capacity may be slightly higher than this.
607 pub inbound_capacity_msat: u64,
608 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
609 /// the peer is connected, and (c) no monitor update failure is pending resolution.
612 /// Information on the fees and requirements that the counterparty requires when forwarding
613 /// payments to us through this channel.
614 pub counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
617 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
618 /// Err() type describing which state the payment is in, see the description of individual enum
620 #[derive(Clone, Debug)]
621 pub enum PaymentSendFailure {
622 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
623 /// send the payment at all. No channel state has been changed or messages sent to peers, and
624 /// once you've changed the parameter at error, you can freely retry the payment in full.
625 ParameterError(APIError),
626 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
627 /// from attempting to send the payment at all. No channel state has been changed or messages
628 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
631 /// The results here are ordered the same as the paths in the route object which was passed to
633 PathParameterError(Vec<Result<(), APIError>>),
634 /// All paths which were attempted failed to send, with no channel state change taking place.
635 /// You can freely retry the payment in full (though you probably want to do so over different
636 /// paths than the ones selected).
637 AllFailedRetrySafe(Vec<APIError>),
638 /// Some paths which were attempted failed to send, though possibly not all. At least some
639 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
640 /// in over-/re-payment.
642 /// The results here are ordered the same as the paths in the route object which was passed to
643 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
644 /// retried (though there is currently no API with which to do so).
646 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
647 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
648 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
649 /// with the latest update_id.
650 PartialFailure(Vec<Result<(), APIError>>),
653 macro_rules! handle_error {
654 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
657 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
658 #[cfg(debug_assertions)]
660 // In testing, ensure there are no deadlocks where the lock is already held upon
661 // entering the macro.
662 assert!($self.channel_state.try_lock().is_ok());
665 let mut msg_events = Vec::with_capacity(2);
667 if let Some((shutdown_res, update_option)) = shutdown_finish {
668 $self.finish_force_close_channel(shutdown_res);
669 if let Some(update) = update_option {
670 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
676 log_error!($self.logger, "{}", err.err);
677 if let msgs::ErrorAction::IgnoreError = err.action {
679 msg_events.push(events::MessageSendEvent::HandleError {
680 node_id: $counterparty_node_id,
681 action: err.action.clone()
685 if !msg_events.is_empty() {
686 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
689 // Return error in case higher-API need one
696 macro_rules! break_chan_entry {
697 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
700 Err(ChannelError::Ignore(msg)) => {
701 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
703 Err(ChannelError::Close(msg)) => {
704 log_trace!($self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
705 let (channel_id, mut chan) = $entry.remove_entry();
706 if let Some(short_id) = chan.get_short_channel_id() {
707 $channel_state.short_to_id.remove(&short_id);
709 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()))
711 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"); }
716 macro_rules! try_chan_entry {
717 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
720 Err(ChannelError::Ignore(msg)) => {
721 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
723 Err(ChannelError::Close(msg)) => {
724 log_trace!($self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
725 let (channel_id, mut chan) = $entry.remove_entry();
726 if let Some(short_id) = chan.get_short_channel_id() {
727 $channel_state.short_to_id.remove(&short_id);
729 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()))
731 Err(ChannelError::CloseDelayBroadcast(msg)) => {
732 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
733 let (channel_id, mut chan) = $entry.remove_entry();
734 if let Some(short_id) = chan.get_short_channel_id() {
735 $channel_state.short_to_id.remove(&short_id);
737 let shutdown_res = chan.force_shutdown(false);
738 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
744 macro_rules! handle_monitor_err {
745 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
746 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
748 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
750 ChannelMonitorUpdateErr::PermanentFailure => {
751 log_error!($self.logger, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
752 let (channel_id, mut chan) = $entry.remove_entry();
753 if let Some(short_id) = chan.get_short_channel_id() {
754 $channel_state.short_to_id.remove(&short_id);
756 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
757 // chain in a confused state! We need to move them into the ChannelMonitor which
758 // will be responsible for failing backwards once things confirm on-chain.
759 // It's ok that we drop $failed_forwards here - at this point we'd rather they
760 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
761 // us bother trying to claim it just to forward on to another peer. If we're
762 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
763 // given up the preimage yet, so might as well just wait until the payment is
764 // retried, avoiding the on-chain fees.
765 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()));
768 ChannelMonitorUpdateErr::TemporaryFailure => {
769 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
770 log_bytes!($entry.key()[..]),
771 if $resend_commitment && $resend_raa {
773 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
774 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
776 } else if $resend_commitment { "commitment" }
777 else if $resend_raa { "RAA" }
779 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
780 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
781 if !$resend_commitment {
782 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
785 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
787 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
788 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$entry.key()))
794 macro_rules! return_monitor_err {
795 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
796 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
798 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
799 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
803 // Does not break in case of TemporaryFailure!
804 macro_rules! maybe_break_monitor_err {
805 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
806 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
807 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
810 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
815 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
816 where M::Target: chain::Watch<Signer>,
817 T::Target: BroadcasterInterface,
818 K::Target: KeysInterface<Signer = Signer>,
819 F::Target: FeeEstimator,
822 /// Constructs a new ChannelManager to hold several channels and route between them.
824 /// This is the main "logic hub" for all channel-related actions, and implements
825 /// ChannelMessageHandler.
827 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
829 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
831 /// Users need to notify the new ChannelManager when a new block is connected or
832 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
833 /// from after `params.latest_hash`.
834 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
835 let mut secp_ctx = Secp256k1::new();
836 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
839 default_configuration: config.clone(),
840 genesis_hash: genesis_block(params.network).header.block_hash(),
841 fee_estimator: fee_est,
845 best_block: RwLock::new(params.best_block),
847 channel_state: Mutex::new(ChannelHolder{
848 by_id: HashMap::new(),
849 short_to_id: HashMap::new(),
850 forward_htlcs: HashMap::new(),
851 claimable_htlcs: HashMap::new(),
852 pending_msg_events: Vec::new(),
854 our_network_key: keys_manager.get_node_secret(),
855 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()),
858 last_node_announcement_serial: AtomicUsize::new(0),
860 per_peer_state: RwLock::new(HashMap::new()),
862 pending_events: Mutex::new(Vec::new()),
863 pending_background_events: Mutex::new(Vec::new()),
864 total_consistency_lock: RwLock::new(()),
865 persistence_notifier: PersistenceNotifier::new(),
873 /// Gets the current configuration applied to all new channels, as
874 pub fn get_current_default_configuration(&self) -> &UserConfig {
875 &self.default_configuration
878 /// Creates a new outbound channel to the given remote node and with the given value.
880 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
881 /// tracking of which events correspond with which create_channel call. Note that the
882 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
883 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
884 /// otherwise ignored.
886 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
887 /// PeerManager::process_events afterwards.
889 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
890 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
891 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, override_config: Option<UserConfig>) -> Result<(), APIError> {
892 if channel_value_satoshis < 1000 {
893 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
896 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
897 let channel = Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, config)?;
898 let res = channel.get_open_channel(self.genesis_hash.clone());
900 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
901 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
902 debug_assert!(&self.total_consistency_lock.try_write().is_err());
904 let mut channel_state = self.channel_state.lock().unwrap();
905 match channel_state.by_id.entry(channel.channel_id()) {
906 hash_map::Entry::Occupied(_) => {
907 if cfg!(feature = "fuzztarget") {
908 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
910 panic!("RNG is bad???");
913 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
915 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
916 node_id: their_network_key,
922 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
923 let mut res = Vec::new();
925 let channel_state = self.channel_state.lock().unwrap();
926 res.reserve(channel_state.by_id.len());
927 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
928 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
929 res.push(ChannelDetails {
930 channel_id: (*channel_id).clone(),
931 short_channel_id: channel.get_short_channel_id(),
932 remote_network_id: channel.get_counterparty_node_id(),
933 counterparty_features: InitFeatures::empty(),
934 channel_value_satoshis: channel.get_value_satoshis(),
935 inbound_capacity_msat,
936 outbound_capacity_msat,
937 user_id: channel.get_user_id(),
938 is_live: channel.is_live(),
939 counterparty_forwarding_info: channel.counterparty_forwarding_info(),
943 let per_peer_state = self.per_peer_state.read().unwrap();
944 for chan in res.iter_mut() {
945 if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
946 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
952 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
953 /// more information.
954 pub fn list_channels(&self) -> Vec<ChannelDetails> {
955 self.list_channels_with_filter(|_| true)
958 /// Gets the list of usable channels, in random order. Useful as an argument to
959 /// get_route to ensure non-announced channels are used.
961 /// These are guaranteed to have their is_live value set to true, see the documentation for
962 /// ChannelDetails::is_live for more info on exactly what the criteria are.
963 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
964 // Note we use is_live here instead of usable which leads to somewhat confused
965 // internal/external nomenclature, but that's ok cause that's probably what the user
966 // really wanted anyway.
967 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
970 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
971 /// will be accepted on the given channel, and after additional timeout/the closing of all
972 /// pending HTLCs, the channel will be closed on chain.
974 /// May generate a SendShutdown message event on success, which should be relayed.
975 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
976 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
978 let (mut failed_htlcs, chan_option) = {
979 let mut channel_state_lock = self.channel_state.lock().unwrap();
980 let channel_state = &mut *channel_state_lock;
981 match channel_state.by_id.entry(channel_id.clone()) {
982 hash_map::Entry::Occupied(mut chan_entry) => {
983 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
984 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
985 node_id: chan_entry.get().get_counterparty_node_id(),
988 if chan_entry.get().is_shutdown() {
989 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
990 channel_state.short_to_id.remove(&short_id);
992 (failed_htlcs, Some(chan_entry.remove_entry().1))
993 } else { (failed_htlcs, None) }
995 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
998 for htlc_source in failed_htlcs.drain(..) {
999 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() });
1001 let chan_update = if let Some(chan) = chan_option {
1002 if let Ok(update) = self.get_channel_update(&chan) {
1007 if let Some(update) = chan_update {
1008 let mut channel_state = self.channel_state.lock().unwrap();
1009 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1018 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1019 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1020 log_trace!(self.logger, "Finishing force-closure of channel {} HTLCs to fail", failed_htlcs.len());
1021 for htlc_source in failed_htlcs.drain(..) {
1022 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() });
1024 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1025 // There isn't anything we can do if we get an update failure - we're already
1026 // force-closing. The monitor update on the required in-memory copy should broadcast
1027 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1028 // ignore the result here.
1029 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1033 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: Option<&PublicKey>) -> Result<PublicKey, APIError> {
1035 let mut channel_state_lock = self.channel_state.lock().unwrap();
1036 let channel_state = &mut *channel_state_lock;
1037 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1038 if let Some(node_id) = peer_node_id {
1039 if chan.get().get_counterparty_node_id() != *node_id {
1040 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1043 if let Some(short_id) = chan.get().get_short_channel_id() {
1044 channel_state.short_to_id.remove(&short_id);
1046 chan.remove_entry().1
1048 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1051 log_trace!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1052 self.finish_force_close_channel(chan.force_shutdown(true));
1053 if let Ok(update) = self.get_channel_update(&chan) {
1054 let mut channel_state = self.channel_state.lock().unwrap();
1055 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1060 Ok(chan.get_counterparty_node_id())
1063 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1064 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1065 pub fn force_close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1066 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1067 match self.force_close_channel_with_peer(channel_id, None) {
1068 Ok(counterparty_node_id) => {
1069 self.channel_state.lock().unwrap().pending_msg_events.push(
1070 events::MessageSendEvent::HandleError {
1071 node_id: counterparty_node_id,
1072 action: msgs::ErrorAction::SendErrorMessage {
1073 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1083 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1084 /// for each to the chain and rejecting new HTLCs on each.
1085 pub fn force_close_all_channels(&self) {
1086 for chan in self.list_channels() {
1087 let _ = self.force_close_channel(&chan.channel_id);
1091 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
1092 macro_rules! return_malformed_err {
1093 ($msg: expr, $err_code: expr) => {
1095 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1096 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1097 channel_id: msg.channel_id,
1098 htlc_id: msg.htlc_id,
1099 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1100 failure_code: $err_code,
1101 })), self.channel_state.lock().unwrap());
1106 if let Err(_) = msg.onion_routing_packet.public_key {
1107 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
1110 let shared_secret = {
1111 let mut arr = [0; 32];
1112 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
1115 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
1117 if msg.onion_routing_packet.version != 0 {
1118 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1119 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1120 //the hash doesn't really serve any purpose - in the case of hashing all data, the
1121 //receiving node would have to brute force to figure out which version was put in the
1122 //packet by the node that send us the message, in the case of hashing the hop_data, the
1123 //node knows the HMAC matched, so they already know what is there...
1124 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
1127 let mut hmac = HmacEngine::<Sha256>::new(&mu);
1128 hmac.input(&msg.onion_routing_packet.hop_data);
1129 hmac.input(&msg.payment_hash.0[..]);
1130 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
1131 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
1134 let mut channel_state = None;
1135 macro_rules! return_err {
1136 ($msg: expr, $err_code: expr, $data: expr) => {
1138 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1139 if channel_state.is_none() {
1140 channel_state = Some(self.channel_state.lock().unwrap());
1142 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1143 channel_id: msg.channel_id,
1144 htlc_id: msg.htlc_id,
1145 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1146 })), channel_state.unwrap());
1151 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1152 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1153 let (next_hop_data, next_hop_hmac) = {
1154 match msgs::OnionHopData::read(&mut chacha_stream) {
1156 let error_code = match err {
1157 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1158 msgs::DecodeError::UnknownRequiredFeature|
1159 msgs::DecodeError::InvalidValue|
1160 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1161 _ => 0x2000 | 2, // Should never happen
1163 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1166 let mut hmac = [0; 32];
1167 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1168 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1175 let pending_forward_info = if next_hop_hmac == [0; 32] {
1178 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1179 // We could do some fancy randomness test here, but, ehh, whatever.
1180 // This checks for the issue where you can calculate the path length given the
1181 // onion data as all the path entries that the originator sent will be here
1182 // as-is (and were originally 0s).
1183 // Of course reverse path calculation is still pretty easy given naive routing
1184 // algorithms, but this fixes the most-obvious case.
1185 let mut next_bytes = [0; 32];
1186 chacha_stream.read_exact(&mut next_bytes).unwrap();
1187 assert_ne!(next_bytes[..], [0; 32][..]);
1188 chacha_stream.read_exact(&mut next_bytes).unwrap();
1189 assert_ne!(next_bytes[..], [0; 32][..]);
1193 // final_expiry_too_soon
1194 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure we have at least
1195 // HTLC_FAIL_BACK_BUFFER blocks to go.
1196 // Also, ensure that, in the case of an unknown payment hash, our payment logic has enough time to fail the HTLC backward
1197 // before our onchain logic triggers a channel closure (see HTLC_FAIL_BACK_BUFFER rational).
1198 if (msg.cltv_expiry as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1199 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1201 // final_incorrect_htlc_amount
1202 if next_hop_data.amt_to_forward > msg.amount_msat {
1203 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1205 // final_incorrect_cltv_expiry
1206 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1207 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1210 let payment_data = match next_hop_data.format {
1211 msgs::OnionHopDataFormat::Legacy { .. } => None,
1212 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1213 msgs::OnionHopDataFormat::FinalNode { payment_data } => payment_data,
1216 // Note that we could obviously respond immediately with an update_fulfill_htlc
1217 // message, however that would leak that we are the recipient of this payment, so
1218 // instead we stay symmetric with the forwarding case, only responding (after a
1219 // delay) once they've send us a commitment_signed!
1221 PendingHTLCStatus::Forward(PendingHTLCInfo {
1222 routing: PendingHTLCRouting::Receive {
1224 incoming_cltv_expiry: msg.cltv_expiry,
1226 payment_hash: msg.payment_hash.clone(),
1227 incoming_shared_secret: shared_secret,
1228 amt_to_forward: next_hop_data.amt_to_forward,
1229 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1232 let mut new_packet_data = [0; 20*65];
1233 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1234 #[cfg(debug_assertions)]
1236 // Check two things:
1237 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1238 // read above emptied out our buffer and the unwrap() wont needlessly panic
1239 // b) that we didn't somehow magically end up with extra data.
1241 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1243 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1244 // fill the onion hop data we'll forward to our next-hop peer.
1245 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1247 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1249 let blinding_factor = {
1250 let mut sha = Sha256::engine();
1251 sha.input(&new_pubkey.serialize()[..]);
1252 sha.input(&shared_secret);
1253 Sha256::from_engine(sha).into_inner()
1256 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1258 } else { Ok(new_pubkey) };
1260 let outgoing_packet = msgs::OnionPacket {
1263 hop_data: new_packet_data,
1264 hmac: next_hop_hmac.clone(),
1267 let short_channel_id = match next_hop_data.format {
1268 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1269 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1270 msgs::OnionHopDataFormat::FinalNode { .. } => {
1271 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1275 PendingHTLCStatus::Forward(PendingHTLCInfo {
1276 routing: PendingHTLCRouting::Forward {
1277 onion_packet: outgoing_packet,
1280 payment_hash: msg.payment_hash.clone(),
1281 incoming_shared_secret: shared_secret,
1282 amt_to_forward: next_hop_data.amt_to_forward,
1283 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1287 channel_state = Some(self.channel_state.lock().unwrap());
1288 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1289 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1290 // with a short_channel_id of 0. This is important as various things later assume
1291 // short_channel_id is non-0 in any ::Forward.
1292 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1293 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1294 let forwarding_id = match id_option {
1295 None => { // unknown_next_peer
1296 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1298 Some(id) => id.clone(),
1300 if let Some((err, code, chan_update)) = loop {
1301 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1303 // Note that we could technically not return an error yet here and just hope
1304 // that the connection is reestablished or monitor updated by the time we get
1305 // around to doing the actual forward, but better to fail early if we can and
1306 // hopefully an attacker trying to path-trace payments cannot make this occur
1307 // on a small/per-node/per-channel scale.
1308 if !chan.is_live() { // channel_disabled
1309 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1311 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
1312 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1314 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_holder_fee_base_msat(&self.fee_estimator) as u64) });
1315 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1316 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())));
1318 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + chan.get_cltv_expiry_delta() as u64 { // incorrect_cltv_expiry
1319 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())));
1321 let cur_height = self.best_block.read().unwrap().height() + 1;
1322 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now, but we want to be robust wrt to counterparty
1323 // packet sanitization (see HTLC_FAIL_BACK_BUFFER rational)
1324 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
1325 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1327 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1328 break Some(("CLTV expiry is too far in the future", 21, None));
1330 // In theory, we would be safe against unitentional channel-closure, if we only required a margin of LATENCY_GRACE_PERIOD_BLOCKS.
1331 // But, to be safe against policy reception, we use a longuer delay.
1332 if (*outgoing_cltv_value) as u64 <= (cur_height + HTLC_FAIL_BACK_BUFFER) as u64 {
1333 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1339 let mut res = Vec::with_capacity(8 + 128);
1340 if let Some(chan_update) = chan_update {
1341 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1342 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1344 else if code == 0x1000 | 13 {
1345 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1347 else if code == 0x1000 | 20 {
1348 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
1349 res.extend_from_slice(&byte_utils::be16_to_array(0));
1351 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1353 return_err!(err, code, &res[..]);
1358 (pending_forward_info, channel_state.unwrap())
1361 /// only fails if the channel does not yet have an assigned short_id
1362 /// May be called with channel_state already locked!
1363 fn get_channel_update(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1364 let short_channel_id = match chan.get_short_channel_id() {
1365 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
1369 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
1371 let unsigned = msgs::UnsignedChannelUpdate {
1372 chain_hash: self.genesis_hash,
1374 timestamp: chan.get_update_time_counter(),
1375 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
1376 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
1377 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
1378 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
1379 fee_base_msat: chan.get_holder_fee_base_msat(&self.fee_estimator),
1380 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1381 excess_data: Vec::new(),
1384 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1385 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1387 Ok(msgs::ChannelUpdate {
1393 // Only public for testing, this should otherwise never be called direcly
1394 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32) -> Result<(), APIError> {
1395 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1396 let prng_seed = self.keys_manager.get_secure_random_bytes();
1397 let session_priv = SecretKey::from_slice(&self.keys_manager.get_secure_random_bytes()[..]).expect("RNG is busted");
1399 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1400 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1401 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height)?;
1402 if onion_utils::route_size_insane(&onion_payloads) {
1403 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1405 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1407 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1409 let err: Result<(), _> = loop {
1410 let mut channel_lock = self.channel_state.lock().unwrap();
1411 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1412 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
1413 Some(id) => id.clone(),
1416 let channel_state = &mut *channel_lock;
1417 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1419 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
1420 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1422 if !chan.get().is_live() {
1423 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
1425 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1427 session_priv: session_priv.clone(),
1428 first_hop_htlc_msat: htlc_msat,
1429 }, onion_packet, &self.logger), channel_state, chan)
1431 Some((update_add, commitment_signed, monitor_update)) => {
1432 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1433 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1434 // Note that MonitorUpdateFailed here indicates (per function docs)
1435 // that we will resend the commitment update once monitor updating
1436 // is restored. Therefore, we must return an error indicating that
1437 // it is unsafe to retry the payment wholesale, which we do in the
1438 // send_payment check for MonitorUpdateFailed, below.
1439 return Err(APIError::MonitorUpdateFailed);
1442 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1443 node_id: path.first().unwrap().pubkey,
1444 updates: msgs::CommitmentUpdate {
1445 update_add_htlcs: vec![update_add],
1446 update_fulfill_htlcs: Vec::new(),
1447 update_fail_htlcs: Vec::new(),
1448 update_fail_malformed_htlcs: Vec::new(),
1456 } else { unreachable!(); }
1460 match handle_error!(self, err, path.first().unwrap().pubkey) {
1461 Ok(_) => unreachable!(),
1463 Err(APIError::ChannelUnavailable { err: e.err })
1468 /// Sends a payment along a given route.
1470 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1471 /// fields for more info.
1473 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1474 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1475 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1476 /// specified in the last hop in the route! Thus, you should probably do your own
1477 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1478 /// payment") and prevent double-sends yourself.
1480 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1482 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1483 /// each entry matching the corresponding-index entry in the route paths, see
1484 /// PaymentSendFailure for more info.
1486 /// In general, a path may raise:
1487 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1488 /// node public key) is specified.
1489 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1490 /// (including due to previous monitor update failure or new permanent monitor update
1492 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1493 /// relevant updates.
1495 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1496 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1497 /// different route unless you intend to pay twice!
1499 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1500 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1501 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1502 /// must not contain multiple paths as multi-path payments require a recipient-provided
1504 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1505 /// bit set (either as required or as available). If multiple paths are present in the Route,
1506 /// we assume the invoice had the basic_mpp feature set.
1507 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<(), PaymentSendFailure> {
1508 if route.paths.len() < 1 {
1509 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
1511 if route.paths.len() > 10 {
1512 // This limit is completely arbitrary - there aren't any real fundamental path-count
1513 // limits. After we support retrying individual paths we should likely bump this, but
1514 // for now more than 10 paths likely carries too much one-path failure.
1515 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
1517 let mut total_value = 0;
1518 let our_node_id = self.get_our_node_id();
1519 let mut path_errs = Vec::with_capacity(route.paths.len());
1520 'path_check: for path in route.paths.iter() {
1521 if path.len() < 1 || path.len() > 20 {
1522 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
1523 continue 'path_check;
1525 for (idx, hop) in path.iter().enumerate() {
1526 if idx != path.len() - 1 && hop.pubkey == our_node_id {
1527 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
1528 continue 'path_check;
1531 total_value += path.last().unwrap().fee_msat;
1532 path_errs.push(Ok(()));
1534 if path_errs.iter().any(|e| e.is_err()) {
1535 return Err(PaymentSendFailure::PathParameterError(path_errs));
1538 let cur_height = self.best_block.read().unwrap().height() + 1;
1539 let mut results = Vec::new();
1540 for path in route.paths.iter() {
1541 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height));
1543 let mut has_ok = false;
1544 let mut has_err = false;
1545 for res in results.iter() {
1546 if res.is_ok() { has_ok = true; }
1547 if res.is_err() { has_err = true; }
1548 if let &Err(APIError::MonitorUpdateFailed) = res {
1549 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
1556 if has_err && has_ok {
1557 Err(PaymentSendFailure::PartialFailure(results))
1559 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
1565 /// Call this upon creation of a funding transaction for the given channel.
1567 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
1568 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
1570 /// Panics if a funding transaction has already been provided for this channel.
1572 /// May panic if the output found in the funding transaction is duplicative with some other
1573 /// channel (note that this should be trivially prevented by using unique funding transaction
1574 /// keys per-channel).
1576 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
1577 /// counterparty's signature the funding transaction will automatically be broadcast via the
1578 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
1580 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
1581 /// not currently support replacing a funding transaction on an existing channel. Instead,
1582 /// create a new channel with a conflicting funding transaction.
1583 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction) -> Result<(), APIError> {
1584 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1586 for inp in funding_transaction.input.iter() {
1587 if inp.witness.is_empty() {
1588 return Err(APIError::APIMisuseError {
1589 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
1595 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
1597 let mut output_index = None;
1598 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
1599 for (idx, outp) in funding_transaction.output.iter().enumerate() {
1600 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
1601 if output_index.is_some() {
1602 return Err(APIError::APIMisuseError {
1603 err: "Multiple outputs matched the expected script and value".to_owned()
1606 if idx > u16::max_value() as usize {
1607 return Err(APIError::APIMisuseError {
1608 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
1611 output_index = Some(idx as u16);
1614 if output_index.is_none() {
1615 return Err(APIError::APIMisuseError {
1616 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
1619 let funding_txo = OutPoint { txid: funding_transaction.txid(), index: output_index.unwrap() };
1621 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
1622 .map_err(|e| if let ChannelError::Close(msg) = e {
1623 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
1624 } else { unreachable!(); })
1627 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
1629 match handle_error!(self, res, chan.get_counterparty_node_id()) {
1630 Ok(funding_msg) => {
1633 Err(_) => { return Err(APIError::ChannelUnavailable {
1634 err: "Error deriving keys or signing initial commitment transactions - either our RNG or our counterparty's RNG is broken or the Signer refused to sign".to_owned()
1639 let mut channel_state = self.channel_state.lock().unwrap();
1640 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1641 node_id: chan.get_counterparty_node_id(),
1644 match channel_state.by_id.entry(chan.channel_id()) {
1645 hash_map::Entry::Occupied(_) => {
1646 panic!("Generated duplicate funding txid?");
1648 hash_map::Entry::Vacant(e) => {
1655 fn get_announcement_sigs(&self, chan: &Channel<Signer>) -> Option<msgs::AnnouncementSignatures> {
1656 if !chan.should_announce() {
1657 log_trace!(self.logger, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
1661 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1663 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1665 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1666 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1668 Some(msgs::AnnouncementSignatures {
1669 channel_id: chan.channel_id(),
1670 short_channel_id: chan.get_short_channel_id().unwrap(),
1671 node_signature: our_node_sig,
1672 bitcoin_signature: our_bitcoin_sig,
1677 // Messages of up to 64KB should never end up more than half full with addresses, as that would
1678 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
1679 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
1681 const HALF_MESSAGE_IS_ADDRS: u32 = ::std::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
1684 // ...by failing to compile if the number of addresses that would be half of a message is
1685 // smaller than 500:
1686 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
1688 /// Generates a signed node_announcement from the given arguments and creates a
1689 /// BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
1690 /// seen a channel_announcement from us (ie unless we have public channels open).
1692 /// RGB is a node "color" and alias is a printable human-readable string to describe this node
1693 /// to humans. They carry no in-protocol meaning.
1695 /// addresses represent the set (possibly empty) of socket addresses on which this node accepts
1696 /// incoming connections. These will be broadcast to the network, publicly tying these
1697 /// addresses together. If you wish to preserve user privacy, addresses should likely contain
1698 /// only Tor Onion addresses.
1700 /// Panics if addresses is absurdly large (more than 500).
1701 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], addresses: Vec<NetAddress>) {
1702 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1704 if addresses.len() > 500 {
1705 panic!("More than half the message size was taken up by public addresses!");
1708 let announcement = msgs::UnsignedNodeAnnouncement {
1709 features: NodeFeatures::known(),
1710 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
1711 node_id: self.get_our_node_id(),
1712 rgb, alias, addresses,
1713 excess_address_data: Vec::new(),
1714 excess_data: Vec::new(),
1716 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1718 let mut channel_state = self.channel_state.lock().unwrap();
1719 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
1720 msg: msgs::NodeAnnouncement {
1721 signature: self.secp_ctx.sign(&msghash, &self.our_network_key),
1722 contents: announcement
1727 /// Processes HTLCs which are pending waiting on random forward delay.
1729 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1730 /// Will likely generate further events.
1731 pub fn process_pending_htlc_forwards(&self) {
1732 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1734 let mut new_events = Vec::new();
1735 let mut failed_forwards = Vec::new();
1736 let mut handle_errors = Vec::new();
1738 let mut channel_state_lock = self.channel_state.lock().unwrap();
1739 let channel_state = &mut *channel_state_lock;
1741 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1742 if short_chan_id != 0 {
1743 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1744 Some(chan_id) => chan_id.clone(),
1746 failed_forwards.reserve(pending_forwards.len());
1747 for forward_info in pending_forwards.drain(..) {
1748 match forward_info {
1749 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info,
1750 prev_funding_outpoint } => {
1751 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1752 short_channel_id: prev_short_channel_id,
1753 outpoint: prev_funding_outpoint,
1754 htlc_id: prev_htlc_id,
1755 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1757 failed_forwards.push((htlc_source, forward_info.payment_hash,
1758 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
1761 HTLCForwardInfo::FailHTLC { .. } => {
1762 // Channel went away before we could fail it. This implies
1763 // the channel is now on chain and our counterparty is
1764 // trying to broadcast the HTLC-Timeout, but that's their
1765 // problem, not ours.
1772 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1773 let mut add_htlc_msgs = Vec::new();
1774 let mut fail_htlc_msgs = Vec::new();
1775 for forward_info in pending_forwards.drain(..) {
1776 match forward_info {
1777 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
1778 routing: PendingHTLCRouting::Forward {
1780 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
1781 prev_funding_outpoint } => {
1782 log_trace!(self.logger, "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);
1783 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1784 short_channel_id: prev_short_channel_id,
1785 outpoint: prev_funding_outpoint,
1786 htlc_id: prev_htlc_id,
1787 incoming_packet_shared_secret: incoming_shared_secret,
1789 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
1791 if let ChannelError::Ignore(msg) = e {
1792 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
1794 panic!("Stated return value requirements in send_htlc() were not met");
1796 let chan_update = self.get_channel_update(chan.get()).unwrap();
1797 failed_forwards.push((htlc_source, payment_hash,
1798 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
1804 Some(msg) => { add_htlc_msgs.push(msg); },
1806 // Nothing to do here...we're waiting on a remote
1807 // revoke_and_ack before we can add anymore HTLCs. The Channel
1808 // will automatically handle building the update_add_htlc and
1809 // commitment_signed messages when we can.
1810 // TODO: Do some kind of timer to set the channel as !is_live()
1811 // as we don't really want others relying on us relaying through
1812 // this channel currently :/.
1818 HTLCForwardInfo::AddHTLC { .. } => {
1819 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
1821 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1822 log_trace!(self.logger, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1823 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1825 if let ChannelError::Ignore(msg) = e {
1826 log_trace!(self.logger, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1828 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1830 // fail-backs are best-effort, we probably already have one
1831 // pending, and if not that's OK, if not, the channel is on
1832 // the chain and sending the HTLC-Timeout is their problem.
1835 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1837 // Nothing to do here...we're waiting on a remote
1838 // revoke_and_ack before we can update the commitment
1839 // transaction. The Channel will automatically handle
1840 // building the update_fail_htlc and commitment_signed
1841 // messages when we can.
1842 // We don't need any kind of timer here as they should fail
1843 // the channel onto the chain if they can't get our
1844 // update_fail_htlc in time, it's not our problem.
1851 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1852 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
1855 // We surely failed send_commitment due to bad keys, in that case
1856 // close channel and then send error message to peer.
1857 let counterparty_node_id = chan.get().get_counterparty_node_id();
1858 let err: Result<(), _> = match e {
1859 ChannelError::Ignore(_) => {
1860 panic!("Stated return value requirements in send_commitment() were not met");
1862 ChannelError::Close(msg) => {
1863 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1864 let (channel_id, mut channel) = chan.remove_entry();
1865 if let Some(short_id) = channel.get_short_channel_id() {
1866 channel_state.short_to_id.remove(&short_id);
1868 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update(&channel).ok()))
1870 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"); }
1872 handle_errors.push((counterparty_node_id, err));
1876 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1877 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1880 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1881 node_id: chan.get().get_counterparty_node_id(),
1882 updates: msgs::CommitmentUpdate {
1883 update_add_htlcs: add_htlc_msgs,
1884 update_fulfill_htlcs: Vec::new(),
1885 update_fail_htlcs: fail_htlc_msgs,
1886 update_fail_malformed_htlcs: Vec::new(),
1888 commitment_signed: commitment_msg,
1896 for forward_info in pending_forwards.drain(..) {
1897 match forward_info {
1898 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
1899 routing: PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry },
1900 incoming_shared_secret, payment_hash, amt_to_forward, .. },
1901 prev_funding_outpoint } => {
1902 let prev_hop = HTLCPreviousHopData {
1903 short_channel_id: prev_short_channel_id,
1904 outpoint: prev_funding_outpoint,
1905 htlc_id: prev_htlc_id,
1906 incoming_packet_shared_secret: incoming_shared_secret,
1909 let mut total_value = 0;
1910 let payment_secret_opt =
1911 if let &Some(ref data) = &payment_data { Some(data.payment_secret.clone()) } else { None };
1912 let htlcs = channel_state.claimable_htlcs.entry((payment_hash, payment_secret_opt))
1913 .or_insert(Vec::new());
1914 htlcs.push(ClaimableHTLC {
1916 value: amt_to_forward,
1917 payment_data: payment_data.clone(),
1918 cltv_expiry: incoming_cltv_expiry,
1920 if let &Some(ref data) = &payment_data {
1921 for htlc in htlcs.iter() {
1922 total_value += htlc.value;
1923 if htlc.payment_data.as_ref().unwrap().total_msat != data.total_msat {
1924 total_value = msgs::MAX_VALUE_MSAT;
1926 if total_value >= msgs::MAX_VALUE_MSAT { break; }
1928 if total_value >= msgs::MAX_VALUE_MSAT || total_value > data.total_msat {
1929 for htlc in htlcs.iter() {
1930 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
1931 htlc_msat_height_data.extend_from_slice(
1932 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
1934 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
1935 short_channel_id: htlc.prev_hop.short_channel_id,
1936 outpoint: prev_funding_outpoint,
1937 htlc_id: htlc.prev_hop.htlc_id,
1938 incoming_packet_shared_secret: htlc.prev_hop.incoming_packet_shared_secret,
1940 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
1943 } else if total_value == data.total_msat {
1944 new_events.push(events::Event::PaymentReceived {
1946 payment_secret: Some(data.payment_secret),
1951 new_events.push(events::Event::PaymentReceived {
1953 payment_secret: None,
1954 amt: amt_to_forward,
1958 HTLCForwardInfo::AddHTLC { .. } => {
1959 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
1961 HTLCForwardInfo::FailHTLC { .. } => {
1962 panic!("Got pending fail of our own HTLC");
1970 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
1971 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
1974 for (counterparty_node_id, err) in handle_errors.drain(..) {
1975 let _ = handle_error!(self, err, counterparty_node_id);
1978 if new_events.is_empty() { return }
1979 let mut events = self.pending_events.lock().unwrap();
1980 events.append(&mut new_events);
1983 /// Free the background events, generally called from timer_tick_occurred.
1985 /// Exposed for testing to allow us to process events quickly without generating accidental
1986 /// BroadcastChannelUpdate events in timer_tick_occurred.
1988 /// Expects the caller to have a total_consistency_lock read lock.
1989 fn process_background_events(&self) {
1990 let mut background_events = Vec::new();
1991 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
1992 for event in background_events.drain(..) {
1994 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
1995 // The channel has already been closed, so no use bothering to care about the
1996 // monitor updating completing.
1997 let _ = self.chain_monitor.update_channel(funding_txo, update);
2003 #[cfg(any(test, feature = "_test_utils"))]
2004 pub(crate) fn test_process_background_events(&self) {
2005 self.process_background_events();
2008 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
2009 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
2010 /// to inform the network about the uselessness of these channels.
2012 /// This method handles all the details, and must be called roughly once per minute.
2014 /// Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
2015 pub fn timer_tick_occurred(&self) {
2016 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2017 self.process_background_events();
2019 let mut channel_state_lock = self.channel_state.lock().unwrap();
2020 let channel_state = &mut *channel_state_lock;
2021 for (_, chan) in channel_state.by_id.iter_mut() {
2022 if chan.is_disabled_staged() && !chan.is_live() {
2023 if let Ok(update) = self.get_channel_update(&chan) {
2024 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2029 } else if chan.is_disabled_staged() && chan.is_live() {
2031 } else if chan.is_disabled_marked() {
2032 chan.to_disabled_staged();
2037 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2038 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
2039 /// along the path (including in our own channel on which we received it).
2040 /// Returns false if no payment was found to fail backwards, true if the process of failing the
2041 /// HTLC backwards has been started.
2042 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>) -> bool {
2043 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2045 let mut channel_state = Some(self.channel_state.lock().unwrap());
2046 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&(*payment_hash, *payment_secret));
2047 if let Some(mut sources) = removed_source {
2048 for htlc in sources.drain(..) {
2049 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2050 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2051 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2052 self.best_block.read().unwrap().height()));
2053 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2054 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
2055 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
2061 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
2062 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
2063 // be surfaced to the user.
2064 fn fail_holding_cell_htlcs(&self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32]) {
2065 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
2067 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
2068 let (failure_code, onion_failure_data) =
2069 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
2070 hash_map::Entry::Occupied(chan_entry) => {
2071 if let Ok(upd) = self.get_channel_update(&chan_entry.get()) {
2072 (0x1000|7, upd.encode_with_len())
2074 (0x4000|10, Vec::new())
2077 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
2079 let channel_state = self.channel_state.lock().unwrap();
2080 self.fail_htlc_backwards_internal(channel_state,
2081 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
2083 HTLCSource::OutboundRoute { .. } => {
2084 self.pending_events.lock().unwrap().push(
2085 events::Event::PaymentFailed {
2087 rejected_by_dest: false,
2099 /// Fails an HTLC backwards to the sender of it to us.
2100 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
2101 /// There are several callsites that do stupid things like loop over a list of payment_hashes
2102 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
2103 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
2104 /// still-available channels.
2105 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
2106 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
2107 //identify whether we sent it or not based on the (I presume) very different runtime
2108 //between the branches here. We should make this async and move it into the forward HTLCs
2111 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
2112 // from block_connected which may run during initialization prior to the chain_monitor
2113 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
2115 HTLCSource::OutboundRoute { ref path, .. } => {
2116 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2117 mem::drop(channel_state_lock);
2118 match &onion_error {
2119 &HTLCFailReason::LightningError { ref err } => {
2121 let (channel_update, payment_retryable, onion_error_code, onion_error_data) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2123 let (channel_update, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2124 // TODO: If we decided to blame ourselves (or one of our channels) in
2125 // process_onion_failure we should close that channel as it implies our
2126 // next-hop is needlessly blaming us!
2127 if let Some(update) = channel_update {
2128 self.channel_state.lock().unwrap().pending_msg_events.push(
2129 events::MessageSendEvent::PaymentFailureNetworkUpdate {
2134 self.pending_events.lock().unwrap().push(
2135 events::Event::PaymentFailed {
2136 payment_hash: payment_hash.clone(),
2137 rejected_by_dest: !payment_retryable,
2139 error_code: onion_error_code,
2141 error_data: onion_error_data
2145 &HTLCFailReason::Reason {
2151 // we get a fail_malformed_htlc from the first hop
2152 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
2153 // failures here, but that would be insufficient as get_route
2154 // generally ignores its view of our own channels as we provide them via
2156 // TODO: For non-temporary failures, we really should be closing the
2157 // channel here as we apparently can't relay through them anyway.
2158 self.pending_events.lock().unwrap().push(
2159 events::Event::PaymentFailed {
2160 payment_hash: payment_hash.clone(),
2161 rejected_by_dest: path.len() == 1,
2163 error_code: Some(*failure_code),
2165 error_data: Some(data.clone()),
2171 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, .. }) => {
2172 let err_packet = match onion_error {
2173 HTLCFailReason::Reason { failure_code, data } => {
2174 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
2175 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
2176 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
2178 HTLCFailReason::LightningError { err } => {
2179 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
2180 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
2184 let mut forward_event = None;
2185 if channel_state_lock.forward_htlcs.is_empty() {
2186 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
2188 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
2189 hash_map::Entry::Occupied(mut entry) => {
2190 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
2192 hash_map::Entry::Vacant(entry) => {
2193 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
2196 mem::drop(channel_state_lock);
2197 if let Some(time) = forward_event {
2198 let mut pending_events = self.pending_events.lock().unwrap();
2199 pending_events.push(events::Event::PendingHTLCsForwardable {
2200 time_forwardable: time
2207 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
2208 /// generating message events for the net layer to claim the payment, if possible. Thus, you
2209 /// should probably kick the net layer to go send messages if this returns true!
2211 /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
2212 /// available within a few percent of the expected amount. This is critical for several
2213 /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
2214 /// payment_preimage without having provided the full value and b) it avoids certain
2215 /// privacy-breaking recipient-probing attacks which may reveal payment activity to
2216 /// motivated attackers.
2218 /// Note that the privacy concerns in (b) are not relevant in payments with a payment_secret
2219 /// set. Thus, for such payments we will claim any payments which do not under-pay.
2221 /// May panic if called except in response to a PaymentReceived event.
2222 pub fn claim_funds(&self, payment_preimage: PaymentPreimage, payment_secret: &Option<PaymentSecret>, expected_amount: u64) -> bool {
2223 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2225 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2227 let mut channel_state = Some(self.channel_state.lock().unwrap());
2228 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&(payment_hash, *payment_secret));
2229 if let Some(mut sources) = removed_source {
2230 assert!(!sources.is_empty());
2232 // If we are claiming an MPP payment, we have to take special care to ensure that each
2233 // channel exists before claiming all of the payments (inside one lock).
2234 // Note that channel existance is sufficient as we should always get a monitor update
2235 // which will take care of the real HTLC claim enforcement.
2237 // If we find an HTLC which we would need to claim but for which we do not have a
2238 // channel, we will fail all parts of the MPP payment. While we could wait and see if
2239 // the sender retries the already-failed path(s), it should be a pretty rare case where
2240 // we got all the HTLCs and then a channel closed while we were waiting for the user to
2241 // provide the preimage, so worrying too much about the optimal handling isn't worth
2244 let (is_mpp, mut valid_mpp) = if let &Some(ref data) = &sources[0].payment_data {
2245 assert!(payment_secret.is_some());
2246 (true, data.total_msat >= expected_amount)
2248 assert!(payment_secret.is_none());
2252 for htlc in sources.iter() {
2253 if !is_mpp || !valid_mpp { break; }
2254 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
2259 let mut errs = Vec::new();
2260 let mut claimed_any_htlcs = false;
2261 for htlc in sources.drain(..) {
2262 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2263 if (is_mpp && !valid_mpp) || (!is_mpp && (htlc.value < expected_amount || htlc.value > expected_amount * 2)) {
2264 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2265 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2266 self.best_block.read().unwrap().height()));
2267 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2268 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
2269 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
2271 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
2273 if let msgs::ErrorAction::IgnoreError = e.1.err.action {
2274 // We got a temporary failure updating monitor, but will claim the
2275 // HTLC when the monitor updating is restored (or on chain).
2276 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", e.1.err.err);
2277 claimed_any_htlcs = true;
2278 } else { errs.push(e); }
2280 Err(None) if is_mpp => unreachable!("We already checked for channel existence, we can't fail here!"),
2282 log_warn!(self.logger, "Channel we expected to claim an HTLC from was closed.");
2284 Ok(()) => claimed_any_htlcs = true,
2289 // Now that we've done the entire above loop in one lock, we can handle any errors
2290 // which were generated.
2291 channel_state.take();
2293 for (counterparty_node_id, err) in errs.drain(..) {
2294 let res: Result<(), _> = Err(err);
2295 let _ = handle_error!(self, res, counterparty_node_id);
2302 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> Result<(), Option<(PublicKey, MsgHandleErrInternal)>> {
2303 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
2304 let channel_state = &mut **channel_state_lock;
2305 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
2306 Some(chan_id) => chan_id.clone(),
2312 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
2313 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2314 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
2315 Ok((msgs, monitor_option)) => {
2316 if let Some(monitor_update) = monitor_option {
2317 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2318 if was_frozen_for_monitor {
2319 assert!(msgs.is_none());
2321 return Err(Some((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err())));
2325 if let Some((msg, commitment_signed)) = msgs {
2326 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2327 node_id: chan.get().get_counterparty_node_id(),
2328 updates: msgs::CommitmentUpdate {
2329 update_add_htlcs: Vec::new(),
2330 update_fulfill_htlcs: vec![msg],
2331 update_fail_htlcs: Vec::new(),
2332 update_fail_malformed_htlcs: Vec::new(),
2341 // TODO: Do something with e?
2342 // This should only occur if we are claiming an HTLC at the same time as the
2343 // HTLC is being failed (eg because a block is being connected and this caused
2344 // an HTLC to time out). This should, of course, only occur if the user is the
2345 // one doing the claiming (as it being a part of a peer claim would imply we're
2346 // about to lose funds) and only if the lock in claim_funds was dropped as a
2347 // previous HTLC was failed (thus not for an MPP payment).
2348 debug_assert!(false, "This shouldn't be reachable except in absurdly rare cases between monitor updates and HTLC timeouts: {:?}", e);
2352 } else { unreachable!(); }
2355 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
2357 HTLCSource::OutboundRoute { .. } => {
2358 mem::drop(channel_state_lock);
2359 let mut pending_events = self.pending_events.lock().unwrap();
2360 pending_events.push(events::Event::PaymentSent {
2364 HTLCSource::PreviousHopData(hop_data) => {
2365 let prev_outpoint = hop_data.outpoint;
2366 if let Err((counterparty_node_id, err)) = match self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage) {
2369 let preimage_update = ChannelMonitorUpdate {
2370 update_id: CLOSED_CHANNEL_UPDATE_ID,
2371 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
2372 payment_preimage: payment_preimage.clone(),
2375 // We update the ChannelMonitor on the backward link, after
2376 // receiving an offchain preimage event from the forward link (the
2377 // event being update_fulfill_htlc).
2378 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
2379 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
2380 payment_preimage, e);
2384 Err(Some(res)) => Err(res),
2386 mem::drop(channel_state_lock);
2387 let res: Result<(), _> = Err(err);
2388 let _ = handle_error!(self, res, counterparty_node_id);
2394 /// Gets the node_id held by this ChannelManager
2395 pub fn get_our_node_id(&self) -> PublicKey {
2396 self.our_network_pubkey.clone()
2399 /// Restores a single, given channel to normal operation after a
2400 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
2403 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
2404 /// fully committed in every copy of the given channels' ChannelMonitors.
2406 /// Note that there is no effect to calling with a highest_applied_update_id other than the
2407 /// current latest ChannelMonitorUpdate and one call to this function after multiple
2408 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
2409 /// exists largely only to prevent races between this and concurrent update_monitor calls.
2411 /// Thus, the anticipated use is, at a high level:
2412 /// 1) You register a chain::Watch with this ChannelManager,
2413 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
2414 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
2415 /// any time it cannot do so instantly,
2416 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
2417 /// 4) once all remote copies are updated, you call this function with the update_id that
2418 /// completed, and once it is the latest the Channel will be re-enabled.
2419 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
2420 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2422 let mut close_results = Vec::new();
2423 let mut htlc_forwards = Vec::new();
2424 let mut htlc_failures = Vec::new();
2425 let mut pending_events = Vec::new();
2428 let mut channel_lock = self.channel_state.lock().unwrap();
2429 let channel_state = &mut *channel_lock;
2430 let short_to_id = &mut channel_state.short_to_id;
2431 let pending_msg_events = &mut channel_state.pending_msg_events;
2432 let channel = match channel_state.by_id.get_mut(&funding_txo.to_channel_id()) {
2436 if !channel.is_awaiting_monitor_update() || channel.get_latest_monitor_update_id() != highest_applied_update_id {
2440 let (raa, commitment_update, order, pending_forwards, mut pending_failures, funding_broadcastable, funding_locked) = channel.monitor_updating_restored(&self.logger);
2441 if !pending_forwards.is_empty() {
2442 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), funding_txo.clone(), pending_forwards));
2444 htlc_failures.append(&mut pending_failures);
2446 macro_rules! handle_cs { () => {
2447 if let Some(update) = commitment_update {
2448 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2449 node_id: channel.get_counterparty_node_id(),
2454 macro_rules! handle_raa { () => {
2455 if let Some(revoke_and_ack) = raa {
2456 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2457 node_id: channel.get_counterparty_node_id(),
2458 msg: revoke_and_ack,
2463 RAACommitmentOrder::CommitmentFirst => {
2467 RAACommitmentOrder::RevokeAndACKFirst => {
2472 if let Some(tx) = funding_broadcastable {
2473 self.tx_broadcaster.broadcast_transaction(&tx);
2475 if let Some(msg) = funding_locked {
2476 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2477 node_id: channel.get_counterparty_node_id(),
2480 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2481 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2482 node_id: channel.get_counterparty_node_id(),
2483 msg: announcement_sigs,
2486 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2490 self.pending_events.lock().unwrap().append(&mut pending_events);
2492 for failure in htlc_failures.drain(..) {
2493 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2495 self.forward_htlcs(&mut htlc_forwards[..]);
2497 for res in close_results.drain(..) {
2498 self.finish_force_close_channel(res);
2502 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
2503 if msg.chain_hash != self.genesis_hash {
2504 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
2507 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, counterparty_node_id.clone(), their_features, msg, 0, &self.default_configuration)
2508 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
2509 let mut channel_state_lock = self.channel_state.lock().unwrap();
2510 let channel_state = &mut *channel_state_lock;
2511 match channel_state.by_id.entry(channel.channel_id()) {
2512 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone())),
2513 hash_map::Entry::Vacant(entry) => {
2514 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
2515 node_id: counterparty_node_id.clone(),
2516 msg: channel.get_accept_channel(),
2518 entry.insert(channel);
2524 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
2525 let (value, output_script, user_id) = {
2526 let mut channel_lock = self.channel_state.lock().unwrap();
2527 let channel_state = &mut *channel_lock;
2528 match channel_state.by_id.entry(msg.temporary_channel_id) {
2529 hash_map::Entry::Occupied(mut chan) => {
2530 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2531 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
2533 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
2534 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
2536 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
2539 let mut pending_events = self.pending_events.lock().unwrap();
2540 pending_events.push(events::Event::FundingGenerationReady {
2541 temporary_channel_id: msg.temporary_channel_id,
2542 channel_value_satoshis: value,
2544 user_channel_id: user_id,
2549 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
2550 let ((funding_msg, monitor), mut chan) = {
2551 let last_block_hash = self.best_block.read().unwrap().block_hash();
2552 let mut channel_lock = self.channel_state.lock().unwrap();
2553 let channel_state = &mut *channel_lock;
2554 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
2555 hash_map::Entry::Occupied(mut chan) => {
2556 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2557 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
2559 (try_chan_entry!(self, chan.get_mut().funding_created(msg, last_block_hash, &self.logger), channel_state, chan), chan.remove())
2561 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
2564 // Because we have exclusive ownership of the channel here we can release the channel_state
2565 // lock before watch_channel
2566 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
2568 ChannelMonitorUpdateErr::PermanentFailure => {
2569 // Note that we reply with the new channel_id in error messages if we gave up on the
2570 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
2571 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
2572 // any messages referencing a previously-closed channel anyway.
2573 // We do not do a force-close here as that would generate a monitor update for
2574 // a monitor that we didn't manage to store (and that we don't care about - we
2575 // don't respond with the funding_signed so the channel can never go on chain).
2576 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
2577 assert!(failed_htlcs.is_empty());
2578 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
2580 ChannelMonitorUpdateErr::TemporaryFailure => {
2581 // There's no problem signing a counterparty's funding transaction if our monitor
2582 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
2583 // accepted payment from yet. We do, however, need to wait to send our funding_locked
2584 // until we have persisted our monitor.
2585 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
2589 let mut channel_state_lock = self.channel_state.lock().unwrap();
2590 let channel_state = &mut *channel_state_lock;
2591 match channel_state.by_id.entry(funding_msg.channel_id) {
2592 hash_map::Entry::Occupied(_) => {
2593 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
2595 hash_map::Entry::Vacant(e) => {
2596 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
2597 node_id: counterparty_node_id.clone(),
2606 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
2608 let last_block_hash = self.best_block.read().unwrap().block_hash();
2609 let mut channel_lock = self.channel_state.lock().unwrap();
2610 let channel_state = &mut *channel_lock;
2611 match channel_state.by_id.entry(msg.channel_id) {
2612 hash_map::Entry::Occupied(mut chan) => {
2613 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2614 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2616 let (monitor, funding_tx) = match chan.get_mut().funding_signed(&msg, last_block_hash, &self.logger) {
2617 Ok(update) => update,
2618 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
2620 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
2621 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2625 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2628 self.tx_broadcaster.broadcast_transaction(&funding_tx);
2632 fn internal_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2633 let mut channel_state_lock = self.channel_state.lock().unwrap();
2634 let channel_state = &mut *channel_state_lock;
2635 match channel_state.by_id.entry(msg.channel_id) {
2636 hash_map::Entry::Occupied(mut chan) => {
2637 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2638 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2640 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2641 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2642 log_trace!(self.logger, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
2643 // If we see locking block before receiving remote funding_locked, we broadcast our
2644 // announcement_sigs at remote funding_locked reception. If we receive remote
2645 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2646 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2647 // the order of the events but our peer may not receive it due to disconnection. The specs
2648 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2649 // connection in the future if simultaneous misses by both peers due to network/hardware
2650 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2651 // to be received, from then sigs are going to be flood to the whole network.
2652 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2653 node_id: counterparty_node_id.clone(),
2654 msg: announcement_sigs,
2659 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2663 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2664 let (mut dropped_htlcs, chan_option) = {
2665 let mut channel_state_lock = self.channel_state.lock().unwrap();
2666 let channel_state = &mut *channel_state_lock;
2668 match channel_state.by_id.entry(msg.channel_id.clone()) {
2669 hash_map::Entry::Occupied(mut chan_entry) => {
2670 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
2671 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2673 let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.fee_estimator, &their_features, &msg), channel_state, chan_entry);
2674 if let Some(msg) = shutdown {
2675 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2676 node_id: counterparty_node_id.clone(),
2680 if let Some(msg) = closing_signed {
2681 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2682 node_id: counterparty_node_id.clone(),
2686 if chan_entry.get().is_shutdown() {
2687 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2688 channel_state.short_to_id.remove(&short_id);
2690 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2691 } else { (dropped_htlcs, None) }
2693 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2696 for htlc_source in dropped_htlcs.drain(..) {
2697 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() });
2699 if let Some(chan) = chan_option {
2700 if let Ok(update) = self.get_channel_update(&chan) {
2701 let mut channel_state = self.channel_state.lock().unwrap();
2702 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2710 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2711 let (tx, chan_option) = {
2712 let mut channel_state_lock = self.channel_state.lock().unwrap();
2713 let channel_state = &mut *channel_state_lock;
2714 match channel_state.by_id.entry(msg.channel_id.clone()) {
2715 hash_map::Entry::Occupied(mut chan_entry) => {
2716 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
2717 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2719 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
2720 if let Some(msg) = closing_signed {
2721 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2722 node_id: counterparty_node_id.clone(),
2727 // We're done with this channel, we've got a signed closing transaction and
2728 // will send the closing_signed back to the remote peer upon return. This
2729 // also implies there are no pending HTLCs left on the channel, so we can
2730 // fully delete it from tracking (the channel monitor is still around to
2731 // watch for old state broadcasts)!
2732 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2733 channel_state.short_to_id.remove(&short_id);
2735 (tx, Some(chan_entry.remove_entry().1))
2736 } else { (tx, None) }
2738 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2741 if let Some(broadcast_tx) = tx {
2742 log_trace!(self.logger, "Broadcast onchain {}", log_tx!(broadcast_tx));
2743 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2745 if let Some(chan) = chan_option {
2746 if let Ok(update) = self.get_channel_update(&chan) {
2747 let mut channel_state = self.channel_state.lock().unwrap();
2748 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2756 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2757 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2758 //determine the state of the payment based on our response/if we forward anything/the time
2759 //we take to respond. We should take care to avoid allowing such an attack.
2761 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2762 //us repeatedly garbled in different ways, and compare our error messages, which are
2763 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2764 //but we should prevent it anyway.
2766 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2767 let channel_state = &mut *channel_state_lock;
2769 match channel_state.by_id.entry(msg.channel_id) {
2770 hash_map::Entry::Occupied(mut chan) => {
2771 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2772 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2775 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
2776 // Ensure error_code has the UPDATE flag set, since by default we send a
2777 // channel update along as part of failing the HTLC.
2778 assert!((error_code & 0x1000) != 0);
2779 // If the update_add is completely bogus, the call will Err and we will close,
2780 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2781 // want to reject the new HTLC and fail it backwards instead of forwarding.
2782 match pending_forward_info {
2783 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
2784 let reason = if let Ok(upd) = self.get_channel_update(chan) {
2785 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &{
2786 let mut res = Vec::with_capacity(8 + 128);
2787 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
2788 res.extend_from_slice(&byte_utils::be16_to_array(0));
2789 res.extend_from_slice(&upd.encode_with_len()[..]);
2793 // The only case where we'd be unable to
2794 // successfully get a channel update is if the
2795 // channel isn't in the fully-funded state yet,
2796 // implying our counterparty is trying to route
2797 // payments over the channel back to themselves
2798 // (cause no one else should know the short_id
2799 // is a lightning channel yet). We should have
2800 // no problem just calling this
2801 // unknown_next_peer (0x4000|10).
2802 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, 0x4000|10, &[])
2804 let msg = msgs::UpdateFailHTLC {
2805 channel_id: msg.channel_id,
2806 htlc_id: msg.htlc_id,
2809 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
2811 _ => pending_forward_info
2814 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
2816 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2821 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2822 let mut channel_lock = self.channel_state.lock().unwrap();
2824 let channel_state = &mut *channel_lock;
2825 match channel_state.by_id.entry(msg.channel_id) {
2826 hash_map::Entry::Occupied(mut chan) => {
2827 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2828 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2830 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2832 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2835 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2839 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2840 let mut channel_lock = self.channel_state.lock().unwrap();
2841 let channel_state = &mut *channel_lock;
2842 match channel_state.by_id.entry(msg.channel_id) {
2843 hash_map::Entry::Occupied(mut chan) => {
2844 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2845 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2847 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2849 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2854 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2855 let mut channel_lock = self.channel_state.lock().unwrap();
2856 let channel_state = &mut *channel_lock;
2857 match channel_state.by_id.entry(msg.channel_id) {
2858 hash_map::Entry::Occupied(mut chan) => {
2859 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2860 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2862 if (msg.failure_code & 0x8000) == 0 {
2863 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
2864 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2866 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);
2869 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2873 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2874 let mut channel_state_lock = self.channel_state.lock().unwrap();
2875 let channel_state = &mut *channel_state_lock;
2876 match channel_state.by_id.entry(msg.channel_id) {
2877 hash_map::Entry::Occupied(mut chan) => {
2878 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2879 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2881 let (revoke_and_ack, commitment_signed, closing_signed, monitor_update) =
2882 match chan.get_mut().commitment_signed(&msg, &self.fee_estimator, &self.logger) {
2883 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
2884 Err((Some(update), e)) => {
2885 assert!(chan.get().is_awaiting_monitor_update());
2886 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
2887 try_chan_entry!(self, Err(e), channel_state, chan);
2892 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2893 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2894 //TODO: Rebroadcast closing_signed if present on monitor update restoration
2896 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2897 node_id: counterparty_node_id.clone(),
2898 msg: revoke_and_ack,
2900 if let Some(msg) = commitment_signed {
2901 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2902 node_id: counterparty_node_id.clone(),
2903 updates: msgs::CommitmentUpdate {
2904 update_add_htlcs: Vec::new(),
2905 update_fulfill_htlcs: Vec::new(),
2906 update_fail_htlcs: Vec::new(),
2907 update_fail_malformed_htlcs: Vec::new(),
2909 commitment_signed: msg,
2913 if let Some(msg) = closing_signed {
2914 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2915 node_id: counterparty_node_id.clone(),
2921 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2926 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
2927 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
2928 let mut forward_event = None;
2929 if !pending_forwards.is_empty() {
2930 let mut channel_state = self.channel_state.lock().unwrap();
2931 if channel_state.forward_htlcs.is_empty() {
2932 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2934 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2935 match channel_state.forward_htlcs.entry(match forward_info.routing {
2936 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
2937 PendingHTLCRouting::Receive { .. } => 0,
2939 hash_map::Entry::Occupied(mut entry) => {
2940 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
2941 prev_htlc_id, forward_info });
2943 hash_map::Entry::Vacant(entry) => {
2944 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
2945 prev_htlc_id, forward_info }));
2950 match forward_event {
2952 let mut pending_events = self.pending_events.lock().unwrap();
2953 pending_events.push(events::Event::PendingHTLCsForwardable {
2954 time_forwardable: time
2962 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2963 let mut htlcs_to_fail = Vec::new();
2965 let mut channel_state_lock = self.channel_state.lock().unwrap();
2966 let channel_state = &mut *channel_state_lock;
2967 match channel_state.by_id.entry(msg.channel_id) {
2968 hash_map::Entry::Occupied(mut chan) => {
2969 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2970 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2972 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2973 let (commitment_update, pending_forwards, pending_failures, closing_signed, monitor_update, htlcs_to_fail_in) =
2974 break_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger), channel_state, chan);
2975 htlcs_to_fail = htlcs_to_fail_in;
2976 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2977 if was_frozen_for_monitor {
2978 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2979 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
2981 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures) {
2983 } else { unreachable!(); }
2986 if let Some(updates) = commitment_update {
2987 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2988 node_id: counterparty_node_id.clone(),
2992 if let Some(msg) = closing_signed {
2993 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2994 node_id: counterparty_node_id.clone(),
2998 break Ok((pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"), chan.get().get_funding_txo().unwrap()))
3000 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3003 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id);
3005 Ok((pending_forwards, mut pending_failures, short_channel_id, channel_outpoint)) => {
3006 for failure in pending_failures.drain(..) {
3007 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3009 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
3016 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
3017 let mut channel_lock = self.channel_state.lock().unwrap();
3018 let channel_state = &mut *channel_lock;
3019 match channel_state.by_id.entry(msg.channel_id) {
3020 hash_map::Entry::Occupied(mut chan) => {
3021 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3022 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3024 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
3026 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3031 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
3032 let mut channel_state_lock = self.channel_state.lock().unwrap();
3033 let channel_state = &mut *channel_state_lock;
3035 match channel_state.by_id.entry(msg.channel_id) {
3036 hash_map::Entry::Occupied(mut chan) => {
3037 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3038 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3040 if !chan.get().is_usable() {
3041 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
3044 let our_node_id = self.get_our_node_id();
3045 let (announcement, our_bitcoin_sig) =
3046 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
3048 let were_node_one = announcement.node_id_1 == our_node_id;
3049 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
3051 let their_node_key = if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 };
3052 let their_bitcoin_key = if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 };
3053 match (self.secp_ctx.verify(&msghash, &msg.node_signature, their_node_key),
3054 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, their_bitcoin_key)) {
3056 let chan_err: ChannelError = ChannelError::Close(format!("Bad announcement_signatures. Failed to verify node_signature: {:?}. Maybe using different node_secret for transport and routing msg? UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}", e, &announcement, their_node_key));
3057 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3060 let chan_err: ChannelError = ChannelError::Close(format!("Bad announcement_signatures. Failed to verify bitcoin_signature: {:?}. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})", e, &announcement, their_bitcoin_key));
3061 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3067 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
3069 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
3070 msg: msgs::ChannelAnnouncement {
3071 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
3072 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
3073 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
3074 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
3075 contents: announcement,
3077 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
3080 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3085 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<(), MsgHandleErrInternal> {
3086 let mut channel_state_lock = self.channel_state.lock().unwrap();
3087 let channel_state = &mut *channel_state_lock;
3088 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
3089 Some(chan_id) => chan_id.clone(),
3091 // It's not a local channel
3095 match channel_state.by_id.entry(chan_id) {
3096 hash_map::Entry::Occupied(mut chan) => {
3097 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3098 // TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
3099 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), chan_id));
3101 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
3103 hash_map::Entry::Vacant(_) => unreachable!()
3108 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
3109 let mut channel_state_lock = self.channel_state.lock().unwrap();
3110 let channel_state = &mut *channel_state_lock;
3112 match channel_state.by_id.entry(msg.channel_id) {
3113 hash_map::Entry::Occupied(mut chan) => {
3114 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3115 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3117 // Currently, we expect all holding cell update_adds to be dropped on peer
3118 // disconnect, so Channel's reestablish will never hand us any holding cell
3119 // freed HTLCs to fail backwards. If in the future we no longer drop pending
3120 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
3121 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, mut order, shutdown) =
3122 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg, &self.logger), channel_state, chan);
3123 if let Some(monitor_update) = monitor_update_opt {
3124 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3125 // channel_reestablish doesn't guarantee the order it returns is sensical
3126 // for the messages it returns, but if we're setting what messages to
3127 // re-transmit on monitor update success, we need to make sure it is sane.
3128 if revoke_and_ack.is_none() {
3129 order = RAACommitmentOrder::CommitmentFirst;
3131 if commitment_update.is_none() {
3132 order = RAACommitmentOrder::RevokeAndACKFirst;
3134 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
3135 //TODO: Resend the funding_locked if needed once we get the monitor running again
3138 if let Some(msg) = funding_locked {
3139 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
3140 node_id: counterparty_node_id.clone(),
3144 macro_rules! send_raa { () => {
3145 if let Some(msg) = revoke_and_ack {
3146 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
3147 node_id: counterparty_node_id.clone(),
3152 macro_rules! send_cu { () => {
3153 if let Some(updates) = commitment_update {
3154 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3155 node_id: counterparty_node_id.clone(),
3161 RAACommitmentOrder::RevokeAndACKFirst => {
3165 RAACommitmentOrder::CommitmentFirst => {
3170 if let Some(msg) = shutdown {
3171 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3172 node_id: counterparty_node_id.clone(),
3178 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3182 /// Begin Update fee process. Allowed only on an outbound channel.
3183 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
3184 /// PeerManager::process_events afterwards.
3185 /// Note: This API is likely to change!
3186 /// (C-not exported) Cause its doc(hidden) anyway
3188 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u32) -> Result<(), APIError> {
3189 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3190 let counterparty_node_id;
3191 let err: Result<(), _> = loop {
3192 let mut channel_state_lock = self.channel_state.lock().unwrap();
3193 let channel_state = &mut *channel_state_lock;
3195 match channel_state.by_id.entry(channel_id) {
3196 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: format!("Failed to find corresponding channel for id {}", channel_id.to_hex())}),
3197 hash_map::Entry::Occupied(mut chan) => {
3198 if !chan.get().is_outbound() {
3199 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel".to_owned()});
3201 if chan.get().is_awaiting_monitor_update() {
3202 return Err(APIError::MonitorUpdateFailed);
3204 if !chan.get().is_live() {
3205 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected".to_owned()});
3207 counterparty_node_id = chan.get().get_counterparty_node_id();
3208 if let Some((update_fee, commitment_signed, monitor_update)) =
3209 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw, &self.logger), channel_state, chan)
3211 if let Err(_e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3214 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3215 node_id: chan.get().get_counterparty_node_id(),
3216 updates: msgs::CommitmentUpdate {
3217 update_add_htlcs: Vec::new(),
3218 update_fulfill_htlcs: Vec::new(),
3219 update_fail_htlcs: Vec::new(),
3220 update_fail_malformed_htlcs: Vec::new(),
3221 update_fee: Some(update_fee),
3231 match handle_error!(self, err, counterparty_node_id) {
3232 Ok(_) => unreachable!(),
3233 Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
3237 /// Process pending events from the `chain::Watch`.
3238 fn process_pending_monitor_events(&self) {
3239 let mut failed_channels = Vec::new();
3241 for monitor_event in self.chain_monitor.release_pending_monitor_events() {
3242 match monitor_event {
3243 MonitorEvent::HTLCEvent(htlc_update) => {
3244 if let Some(preimage) = htlc_update.payment_preimage {
3245 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
3246 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
3248 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
3249 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() });
3252 MonitorEvent::CommitmentTxBroadcasted(funding_outpoint) => {
3253 let mut channel_lock = self.channel_state.lock().unwrap();
3254 let channel_state = &mut *channel_lock;
3255 let by_id = &mut channel_state.by_id;
3256 let short_to_id = &mut channel_state.short_to_id;
3257 let pending_msg_events = &mut channel_state.pending_msg_events;
3258 if let Some(mut chan) = by_id.remove(&funding_outpoint.to_channel_id()) {
3259 if let Some(short_id) = chan.get_short_channel_id() {
3260 short_to_id.remove(&short_id);
3262 failed_channels.push(chan.force_shutdown(false));
3263 if let Ok(update) = self.get_channel_update(&chan) {
3264 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3268 pending_msg_events.push(events::MessageSendEvent::HandleError {
3269 node_id: chan.get_counterparty_node_id(),
3270 action: msgs::ErrorAction::SendErrorMessage {
3271 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
3280 for failure in failed_channels.drain(..) {
3281 self.finish_force_close_channel(failure);
3285 /// Handle a list of channel failures during a block_connected or block_disconnected call,
3286 /// pushing the channel monitor update (if any) to the background events queue and removing the
3288 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
3289 for mut failure in failed_channels.drain(..) {
3290 // Either a commitment transactions has been confirmed on-chain or
3291 // Channel::block_disconnected detected that the funding transaction has been
3292 // reorganized out of the main chain.
3293 // We cannot broadcast our latest local state via monitor update (as
3294 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
3295 // so we track the update internally and handle it when the user next calls
3296 // timer_tick_occurred, guaranteeing we're running normally.
3297 if let Some((funding_txo, update)) = failure.0.take() {
3298 assert_eq!(update.updates.len(), 1);
3299 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
3300 assert!(should_broadcast);
3301 } else { unreachable!(); }
3302 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
3304 self.finish_force_close_channel(failure);
3309 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
3310 where M::Target: chain::Watch<Signer>,
3311 T::Target: BroadcasterInterface,
3312 K::Target: KeysInterface<Signer = Signer>,
3313 F::Target: FeeEstimator,
3316 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
3317 //TODO: This behavior should be documented. It's non-intuitive that we query
3318 // ChannelMonitors when clearing other events.
3319 self.process_pending_monitor_events();
3321 let mut ret = Vec::new();
3322 let mut channel_state = self.channel_state.lock().unwrap();
3323 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
3328 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
3329 where M::Target: chain::Watch<Signer>,
3330 T::Target: BroadcasterInterface,
3331 K::Target: KeysInterface<Signer = Signer>,
3332 F::Target: FeeEstimator,
3335 fn get_and_clear_pending_events(&self) -> Vec<Event> {
3336 //TODO: This behavior should be documented. It's non-intuitive that we query
3337 // ChannelMonitors when clearing other events.
3338 self.process_pending_monitor_events();
3340 let mut ret = Vec::new();
3341 let mut pending_events = self.pending_events.lock().unwrap();
3342 mem::swap(&mut ret, &mut *pending_events);
3347 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
3349 M::Target: chain::Watch<Signer>,
3350 T::Target: BroadcasterInterface,
3351 K::Target: KeysInterface<Signer = Signer>,
3352 F::Target: FeeEstimator,
3355 fn block_connected(&self, block: &Block, height: u32) {
3357 let best_block = self.best_block.read().unwrap();
3358 assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
3359 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
3360 assert_eq!(best_block.height(), height - 1,
3361 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
3364 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
3365 self.transactions_confirmed(&block.header, height, &txdata);
3366 self.update_best_block(&block.header, height);
3369 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
3370 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3371 let new_height = height - 1;
3373 let mut best_block = self.best_block.write().unwrap();
3374 assert_eq!(best_block.block_hash(), header.block_hash(),
3375 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
3376 assert_eq!(best_block.height(), height,
3377 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
3378 *best_block = BestBlock::new(header.prev_blockhash, new_height)
3381 self.do_chain_event(Some(new_height), |channel| channel.update_best_block(new_height, header.time));
3385 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
3386 where M::Target: chain::Watch<Signer>,
3387 T::Target: BroadcasterInterface,
3388 K::Target: KeysInterface<Signer = Signer>,
3389 F::Target: FeeEstimator,
3392 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
3393 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
3395 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage>>
3396 (&self, height_opt: Option<u32>, f: FN) {
3397 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3398 // during initialization prior to the chain_monitor being fully configured in some cases.
3399 // See the docs for `ChannelManagerReadArgs` for more.
3401 let mut failed_channels = Vec::new();
3402 let mut timed_out_htlcs = Vec::new();
3404 let mut channel_lock = self.channel_state.lock().unwrap();
3405 let channel_state = &mut *channel_lock;
3406 let short_to_id = &mut channel_state.short_to_id;
3407 let pending_msg_events = &mut channel_state.pending_msg_events;
3408 channel_state.by_id.retain(|_, channel| {
3409 let res = f(channel);
3410 if let Ok((chan_res, mut timed_out_pending_htlcs)) = res {
3411 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
3412 let chan_update = self.get_channel_update(&channel).map(|u| u.encode_with_len()).unwrap(); // Cannot add/recv HTLCs before we have a short_id so unwrap is safe
3413 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
3414 failure_code: 0x1000 | 14, // expiry_too_soon, or at least it is now
3418 if let Some(funding_locked) = chan_res {
3419 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
3420 node_id: channel.get_counterparty_node_id(),
3421 msg: funding_locked,
3423 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
3424 log_trace!(self.logger, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
3425 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3426 node_id: channel.get_counterparty_node_id(),
3427 msg: announcement_sigs,
3430 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
3432 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
3434 } else if let Err(e) = res {
3435 if let Some(short_id) = channel.get_short_channel_id() {
3436 short_to_id.remove(&short_id);
3438 // It looks like our counterparty went on-chain or funding transaction was
3439 // reorged out of the main chain. Close the channel.
3440 failed_channels.push(channel.force_shutdown(true));
3441 if let Ok(update) = self.get_channel_update(&channel) {
3442 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3446 pending_msg_events.push(events::MessageSendEvent::HandleError {
3447 node_id: channel.get_counterparty_node_id(),
3448 action: msgs::ErrorAction::SendErrorMessage { msg: e },
3455 if let Some(height) = height_opt {
3456 channel_state.claimable_htlcs.retain(|&(ref payment_hash, _), htlcs| {
3457 htlcs.retain(|htlc| {
3458 // If height is approaching the number of blocks we think it takes us to get
3459 // our commitment transaction confirmed before the HTLC expires, plus the
3460 // number of blocks we generally consider it to take to do a commitment update,
3461 // just give up on it and fail the HTLC.
3462 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
3463 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3464 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
3465 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
3466 failure_code: 0x4000 | 15,
3467 data: htlc_msat_height_data
3472 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
3477 self.handle_init_event_channel_failures(failed_channels);
3479 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
3480 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
3484 /// Updates channel state to take note of transactions which were confirmed in the given block
3485 /// at the given height.
3487 /// Note that you must still call (or have called) [`update_best_block`] with the block
3488 /// information which is included here.
3490 /// This method may be called before or after [`update_best_block`] for a given block's
3491 /// transaction data and may be called multiple times with additional transaction data for a
3494 /// This method may be called for a previous block after an [`update_best_block`] call has
3495 /// been made for a later block, however it must *not* be called with transaction data from a
3496 /// block which is no longer in the best chain (ie where [`update_best_block`] has already
3497 /// been informed about a blockchain reorganization which no longer includes the block which
3498 /// corresponds to `header`).
3500 /// [`update_best_block`]: `Self::update_best_block`
3501 pub fn transactions_confirmed(&self, header: &BlockHeader, height: u32, txdata: &TransactionData) {
3502 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3503 // during initialization prior to the chain_monitor being fully configured in some cases.
3504 // See the docs for `ChannelManagerReadArgs` for more.
3506 let block_hash = header.block_hash();
3507 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
3509 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3510 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, &self.logger).map(|a| (a, Vec::new())));
3513 /// Updates channel state with the current best blockchain tip. You should attempt to call this
3514 /// quickly after a new block becomes available, however if multiple new blocks become
3515 /// available at the same time, only a single `update_best_block()` call needs to be made.
3517 /// This method should also be called immediately after any block disconnections, once at the
3518 /// reorganization fork point, and once with the new chain tip. Calling this method at the
3519 /// blockchain reorganization fork point ensures we learn when a funding transaction which was
3520 /// previously confirmed is reorganized out of the blockchain, ensuring we do not continue to
3521 /// accept payments which cannot be enforced on-chain.
3523 /// In both the block-connection and block-disconnection case, this method may be called either
3524 /// once per block connected or disconnected, or simply at the fork point and new tip(s),
3525 /// skipping any intermediary blocks.
3526 pub fn update_best_block(&self, header: &BlockHeader, height: u32) {
3527 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3528 // during initialization prior to the chain_monitor being fully configured in some cases.
3529 // See the docs for `ChannelManagerReadArgs` for more.
3531 let block_hash = header.block_hash();
3532 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
3534 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3536 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
3538 self.do_chain_event(Some(height), |channel| channel.update_best_block(height, header.time));
3541 // Update last_node_announcement_serial to be the max of its current value and the
3542 // block timestamp. This should keep us close to the current time without relying on
3543 // having an explicit local time source.
3544 // Just in case we end up in a race, we loop until we either successfully update
3545 // last_node_announcement_serial or decide we don't need to.
3546 let old_serial = self.last_node_announcement_serial.load(Ordering::Acquire);
3547 if old_serial >= header.time as usize { break; }
3548 if self.last_node_announcement_serial.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
3554 /// Gets the set of txids which should be monitored for their confirmation state.
3556 /// If you're providing information about reorganizations via [`transaction_unconfirmed`], this
3557 /// is the set of transactions which you may need to call [`transaction_unconfirmed`] for.
3559 /// This may be useful to poll to determine the set of transactions which must be registered
3560 /// with an Electrum server or for which an Electrum server needs to be polled to determine
3561 /// transaction confirmation state.
3563 /// This may update after any [`transactions_confirmed`] or [`block_connected`] call.
3565 /// Note that this is NOT the set of transactions which must be included in calls to
3566 /// [`transactions_confirmed`] if they are confirmed, but a small subset of it.
3568 /// [`transactions_confirmed`]: Self::transactions_confirmed
3569 /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
3570 /// [`block_connected`]: chain::Listen::block_connected
3571 pub fn get_relevant_txids(&self) -> Vec<Txid> {
3572 let channel_state = self.channel_state.lock().unwrap();
3573 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
3574 for chan in channel_state.by_id.values() {
3575 if let Some(funding_txo) = chan.get_funding_txo() {
3576 res.push(funding_txo.txid);
3582 /// Marks a transaction as having been reorganized out of the blockchain.
3584 /// If a transaction is included in [`get_relevant_txids`], and is no longer in the main branch
3585 /// of the blockchain, this function should be called to indicate that the transaction should
3586 /// be considered reorganized out.
3588 /// Once this is called, the given transaction will no longer appear on [`get_relevant_txids`],
3589 /// though this may be called repeatedly for a given transaction without issue.
3591 /// Note that if the transaction is confirmed on the main chain in a different block (indicated
3592 /// via a call to [`transactions_confirmed`]), it may re-appear in [`get_relevant_txids`], thus
3593 /// be very wary of race-conditions wherein the final state of a transaction indicated via
3594 /// these APIs is not the same as its state on the blockchain.
3596 /// [`transactions_confirmed`]: Self::transactions_confirmed
3597 /// [`get_relevant_txids`]: Self::get_relevant_txids
3598 pub fn transaction_unconfirmed(&self, txid: &Txid) {
3599 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3600 self.do_chain_event(None, |channel| {
3601 if let Some(funding_txo) = channel.get_funding_txo() {
3602 if funding_txo.txid == *txid {
3603 channel.funding_transaction_unconfirmed().map(|_| (None, Vec::new()))
3604 } else { Ok((None, Vec::new())) }
3605 } else { Ok((None, Vec::new())) }
3609 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
3610 /// indicating whether persistence is necessary. Only one listener on
3611 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
3613 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
3614 #[cfg(any(test, feature = "allow_wallclock_use"))]
3615 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
3616 self.persistence_notifier.wait_timeout(max_wait)
3619 /// Blocks until ChannelManager needs to be persisted. Only one listener on
3620 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
3622 pub fn await_persistable_update(&self) {
3623 self.persistence_notifier.wait()
3626 #[cfg(any(test, feature = "_test_utils"))]
3627 pub fn get_persistence_condvar_value(&self) -> bool {
3628 let mutcond = &self.persistence_notifier.persistence_lock;
3629 let &(ref mtx, _) = mutcond;
3630 let guard = mtx.lock().unwrap();
3635 impl<Signer: Sign, M: Deref + Sync + Send, T: Deref + Sync + Send, K: Deref + Sync + Send, F: Deref + Sync + Send, L: Deref + Sync + Send>
3636 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
3637 where M::Target: chain::Watch<Signer>,
3638 T::Target: BroadcasterInterface,
3639 K::Target: KeysInterface<Signer = Signer>,
3640 F::Target: FeeEstimator,
3643 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
3644 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3645 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
3648 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
3649 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3650 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
3653 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
3654 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3655 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
3658 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
3659 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3660 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
3663 fn handle_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) {
3664 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3665 let _ = handle_error!(self, self.internal_funding_locked(counterparty_node_id, msg), *counterparty_node_id);
3668 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
3669 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3670 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
3673 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
3674 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3675 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
3678 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
3679 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3680 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
3683 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
3684 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3685 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
3688 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
3689 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3690 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
3693 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
3694 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3695 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
3698 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
3699 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3700 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
3703 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
3704 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3705 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
3708 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
3709 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3710 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
3713 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
3714 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3715 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
3718 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
3719 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3720 let _ = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id);
3723 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
3724 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3725 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
3728 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
3729 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3730 let mut failed_channels = Vec::new();
3731 let mut failed_payments = Vec::new();
3732 let mut no_channels_remain = true;
3734 let mut channel_state_lock = self.channel_state.lock().unwrap();
3735 let channel_state = &mut *channel_state_lock;
3736 let short_to_id = &mut channel_state.short_to_id;
3737 let pending_msg_events = &mut channel_state.pending_msg_events;
3738 if no_connection_possible {
3739 log_debug!(self.logger, "Failing all channels with {} due to no_connection_possible", log_pubkey!(counterparty_node_id));
3740 channel_state.by_id.retain(|_, chan| {
3741 if chan.get_counterparty_node_id() == *counterparty_node_id {
3742 if let Some(short_id) = chan.get_short_channel_id() {
3743 short_to_id.remove(&short_id);
3745 failed_channels.push(chan.force_shutdown(true));
3746 if let Ok(update) = self.get_channel_update(&chan) {
3747 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3757 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(counterparty_node_id));
3758 channel_state.by_id.retain(|_, chan| {
3759 if chan.get_counterparty_node_id() == *counterparty_node_id {
3760 // Note that currently on channel reestablish we assert that there are no
3761 // holding cell add-HTLCs, so if in the future we stop removing uncommitted HTLCs
3762 // on peer disconnect here, there will need to be corresponding changes in
3763 // reestablish logic.
3764 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
3765 chan.to_disabled_marked();
3766 if !failed_adds.is_empty() {
3767 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
3768 failed_payments.push((chan_update, failed_adds));
3770 if chan.is_shutdown() {
3771 if let Some(short_id) = chan.get_short_channel_id() {
3772 short_to_id.remove(&short_id);
3776 no_channels_remain = false;
3782 pending_msg_events.retain(|msg| {
3784 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
3785 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
3786 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
3787 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
3788 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != counterparty_node_id,
3789 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
3790 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
3791 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
3792 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
3793 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
3794 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
3795 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
3796 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
3797 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
3798 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
3799 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
3800 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
3801 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
3802 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
3806 if no_channels_remain {
3807 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
3810 for failure in failed_channels.drain(..) {
3811 self.finish_force_close_channel(failure);
3813 for (chan_update, mut htlc_sources) in failed_payments {
3814 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
3815 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
3820 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
3821 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
3823 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3826 let mut peer_state_lock = self.per_peer_state.write().unwrap();
3827 match peer_state_lock.entry(counterparty_node_id.clone()) {
3828 hash_map::Entry::Vacant(e) => {
3829 e.insert(Mutex::new(PeerState {
3830 latest_features: init_msg.features.clone(),
3833 hash_map::Entry::Occupied(e) => {
3834 e.get().lock().unwrap().latest_features = init_msg.features.clone();
3839 let mut channel_state_lock = self.channel_state.lock().unwrap();
3840 let channel_state = &mut *channel_state_lock;
3841 let pending_msg_events = &mut channel_state.pending_msg_events;
3842 channel_state.by_id.retain(|_, chan| {
3843 if chan.get_counterparty_node_id() == *counterparty_node_id {
3844 if !chan.have_received_message() {
3845 // If we created this (outbound) channel while we were disconnected from the
3846 // peer we probably failed to send the open_channel message, which is now
3847 // lost. We can't have had anything pending related to this channel, so we just
3851 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
3852 node_id: chan.get_counterparty_node_id(),
3853 msg: chan.get_channel_reestablish(&self.logger),
3859 //TODO: Also re-broadcast announcement_signatures
3862 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
3863 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3865 if msg.channel_id == [0; 32] {
3866 for chan in self.list_channels() {
3867 if chan.remote_network_id == *counterparty_node_id {
3868 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
3869 let _ = self.force_close_channel_with_peer(&chan.channel_id, Some(counterparty_node_id));
3873 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
3874 let _ = self.force_close_channel_with_peer(&msg.channel_id, Some(counterparty_node_id));
3879 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
3880 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
3881 struct PersistenceNotifier {
3882 /// Users won't access the persistence_lock directly, but rather wait on its bool using
3883 /// `wait_timeout` and `wait`.
3884 persistence_lock: (Mutex<bool>, Condvar),
3887 impl PersistenceNotifier {
3890 persistence_lock: (Mutex::new(false), Condvar::new()),
3896 let &(ref mtx, ref cvar) = &self.persistence_lock;
3897 let mut guard = mtx.lock().unwrap();
3898 guard = cvar.wait(guard).unwrap();
3899 let result = *guard;
3907 #[cfg(any(test, feature = "allow_wallclock_use"))]
3908 fn wait_timeout(&self, max_wait: Duration) -> bool {
3909 let current_time = Instant::now();
3911 let &(ref mtx, ref cvar) = &self.persistence_lock;
3912 let mut guard = mtx.lock().unwrap();
3913 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
3914 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
3915 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
3916 // time. Note that this logic can be highly simplified through the use of
3917 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
3919 let elapsed = current_time.elapsed();
3920 let result = *guard;
3921 if result || elapsed >= max_wait {
3925 match max_wait.checked_sub(elapsed) {
3926 None => return result,
3932 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
3934 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
3935 let mut persistence_lock = persist_mtx.lock().unwrap();
3936 *persistence_lock = true;
3937 mem::drop(persistence_lock);
3942 const SERIALIZATION_VERSION: u8 = 1;
3943 const MIN_SERIALIZATION_VERSION: u8 = 1;
3945 impl Writeable for PendingHTLCInfo {
3946 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3947 match &self.routing {
3948 &PendingHTLCRouting::Forward { ref onion_packet, ref short_channel_id } => {
3950 onion_packet.write(writer)?;
3951 short_channel_id.write(writer)?;
3953 &PendingHTLCRouting::Receive { ref payment_data, ref incoming_cltv_expiry } => {
3955 payment_data.write(writer)?;
3956 incoming_cltv_expiry.write(writer)?;
3959 self.incoming_shared_secret.write(writer)?;
3960 self.payment_hash.write(writer)?;
3961 self.amt_to_forward.write(writer)?;
3962 self.outgoing_cltv_value.write(writer)?;
3967 impl Readable for PendingHTLCInfo {
3968 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
3969 Ok(PendingHTLCInfo {
3970 routing: match Readable::read(reader)? {
3971 0u8 => PendingHTLCRouting::Forward {
3972 onion_packet: Readable::read(reader)?,
3973 short_channel_id: Readable::read(reader)?,
3975 1u8 => PendingHTLCRouting::Receive {
3976 payment_data: Readable::read(reader)?,
3977 incoming_cltv_expiry: Readable::read(reader)?,
3979 _ => return Err(DecodeError::InvalidValue),
3981 incoming_shared_secret: Readable::read(reader)?,
3982 payment_hash: Readable::read(reader)?,
3983 amt_to_forward: Readable::read(reader)?,
3984 outgoing_cltv_value: Readable::read(reader)?,
3989 impl Writeable for HTLCFailureMsg {
3990 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3992 &HTLCFailureMsg::Relay(ref fail_msg) => {
3994 fail_msg.write(writer)?;
3996 &HTLCFailureMsg::Malformed(ref fail_msg) => {
3998 fail_msg.write(writer)?;
4005 impl Readable for HTLCFailureMsg {
4006 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
4007 match <u8 as Readable>::read(reader)? {
4008 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
4009 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
4010 _ => Err(DecodeError::InvalidValue),
4015 impl Writeable for PendingHTLCStatus {
4016 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4018 &PendingHTLCStatus::Forward(ref forward_info) => {
4020 forward_info.write(writer)?;
4022 &PendingHTLCStatus::Fail(ref fail_msg) => {
4024 fail_msg.write(writer)?;
4031 impl Readable for PendingHTLCStatus {
4032 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
4033 match <u8 as Readable>::read(reader)? {
4034 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
4035 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
4036 _ => Err(DecodeError::InvalidValue),
4041 impl_writeable!(HTLCPreviousHopData, 0, {
4045 incoming_packet_shared_secret
4048 impl_writeable!(ClaimableHTLC, 0, {
4055 impl Writeable for HTLCSource {
4056 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4058 &HTLCSource::PreviousHopData(ref hop_data) => {
4060 hop_data.write(writer)?;
4062 &HTLCSource::OutboundRoute { ref path, ref session_priv, ref first_hop_htlc_msat } => {
4064 path.write(writer)?;
4065 session_priv.write(writer)?;
4066 first_hop_htlc_msat.write(writer)?;
4073 impl Readable for HTLCSource {
4074 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCSource, DecodeError> {
4075 match <u8 as Readable>::read(reader)? {
4076 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
4077 1 => Ok(HTLCSource::OutboundRoute {
4078 path: Readable::read(reader)?,
4079 session_priv: Readable::read(reader)?,
4080 first_hop_htlc_msat: Readable::read(reader)?,
4082 _ => Err(DecodeError::InvalidValue),
4087 impl Writeable for HTLCFailReason {
4088 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4090 &HTLCFailReason::LightningError { ref err } => {
4094 &HTLCFailReason::Reason { ref failure_code, ref data } => {
4096 failure_code.write(writer)?;
4097 data.write(writer)?;
4104 impl Readable for HTLCFailReason {
4105 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
4106 match <u8 as Readable>::read(reader)? {
4107 0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
4108 1 => Ok(HTLCFailReason::Reason {
4109 failure_code: Readable::read(reader)?,
4110 data: Readable::read(reader)?,
4112 _ => Err(DecodeError::InvalidValue),
4117 impl Writeable for HTLCForwardInfo {
4118 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4120 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_funding_outpoint, ref prev_htlc_id, ref forward_info } => {
4122 prev_short_channel_id.write(writer)?;
4123 prev_funding_outpoint.write(writer)?;
4124 prev_htlc_id.write(writer)?;
4125 forward_info.write(writer)?;
4127 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
4129 htlc_id.write(writer)?;
4130 err_packet.write(writer)?;
4137 impl Readable for HTLCForwardInfo {
4138 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
4139 match <u8 as Readable>::read(reader)? {
4140 0 => Ok(HTLCForwardInfo::AddHTLC {
4141 prev_short_channel_id: Readable::read(reader)?,
4142 prev_funding_outpoint: Readable::read(reader)?,
4143 prev_htlc_id: Readable::read(reader)?,
4144 forward_info: Readable::read(reader)?,
4146 1 => Ok(HTLCForwardInfo::FailHTLC {
4147 htlc_id: Readable::read(reader)?,
4148 err_packet: Readable::read(reader)?,
4150 _ => Err(DecodeError::InvalidValue),
4155 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
4156 where M::Target: chain::Watch<Signer>,
4157 T::Target: BroadcasterInterface,
4158 K::Target: KeysInterface<Signer = Signer>,
4159 F::Target: FeeEstimator,
4162 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4163 let _consistency_lock = self.total_consistency_lock.write().unwrap();
4165 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
4166 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
4168 self.genesis_hash.write(writer)?;
4170 let best_block = self.best_block.read().unwrap();
4171 best_block.height().write(writer)?;
4172 best_block.block_hash().write(writer)?;
4175 let channel_state = self.channel_state.lock().unwrap();
4176 let mut unfunded_channels = 0;
4177 for (_, channel) in channel_state.by_id.iter() {
4178 if !channel.is_funding_initiated() {
4179 unfunded_channels += 1;
4182 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
4183 for (_, channel) in channel_state.by_id.iter() {
4184 if channel.is_funding_initiated() {
4185 channel.write(writer)?;
4189 (channel_state.forward_htlcs.len() as u64).write(writer)?;
4190 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
4191 short_channel_id.write(writer)?;
4192 (pending_forwards.len() as u64).write(writer)?;
4193 for forward in pending_forwards {
4194 forward.write(writer)?;
4198 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
4199 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
4200 payment_hash.write(writer)?;
4201 (previous_hops.len() as u64).write(writer)?;
4202 for htlc in previous_hops.iter() {
4203 htlc.write(writer)?;
4207 let per_peer_state = self.per_peer_state.write().unwrap();
4208 (per_peer_state.len() as u64).write(writer)?;
4209 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
4210 peer_pubkey.write(writer)?;
4211 let peer_state = peer_state_mutex.lock().unwrap();
4212 peer_state.latest_features.write(writer)?;
4215 let events = self.pending_events.lock().unwrap();
4216 (events.len() as u64).write(writer)?;
4217 for event in events.iter() {
4218 event.write(writer)?;
4221 let background_events = self.pending_background_events.lock().unwrap();
4222 (background_events.len() as u64).write(writer)?;
4223 for event in background_events.iter() {
4225 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
4227 funding_txo.write(writer)?;
4228 monitor_update.write(writer)?;
4233 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
4239 /// Arguments for the creation of a ChannelManager that are not deserialized.
4241 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
4243 /// 1) Deserialize all stored ChannelMonitors.
4244 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
4245 /// <(BlockHash, ChannelManager)>::read(reader, args)
4246 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
4247 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
4248 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
4249 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
4250 /// ChannelMonitor::get_funding_txo().
4251 /// 4) Reconnect blocks on your ChannelMonitors.
4252 /// 5) Disconnect/connect blocks on the ChannelManager.
4253 /// 6) Move the ChannelMonitors into your local chain::Watch.
4255 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
4256 /// call any other methods on the newly-deserialized ChannelManager.
4258 /// Note that because some channels may be closed during deserialization, it is critical that you
4259 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
4260 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
4261 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
4262 /// not force-close the same channels but consider them live), you may end up revoking a state for
4263 /// which you've already broadcasted the transaction.
4264 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4265 where M::Target: chain::Watch<Signer>,
4266 T::Target: BroadcasterInterface,
4267 K::Target: KeysInterface<Signer = Signer>,
4268 F::Target: FeeEstimator,
4271 /// The keys provider which will give us relevant keys. Some keys will be loaded during
4272 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
4274 pub keys_manager: K,
4276 /// The fee_estimator for use in the ChannelManager in the future.
4278 /// No calls to the FeeEstimator will be made during deserialization.
4279 pub fee_estimator: F,
4280 /// The chain::Watch for use in the ChannelManager in the future.
4282 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
4283 /// you have deserialized ChannelMonitors separately and will add them to your
4284 /// chain::Watch after deserializing this ChannelManager.
4285 pub chain_monitor: M,
4287 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
4288 /// used to broadcast the latest local commitment transactions of channels which must be
4289 /// force-closed during deserialization.
4290 pub tx_broadcaster: T,
4291 /// The Logger for use in the ChannelManager and which may be used to log information during
4292 /// deserialization.
4294 /// Default settings used for new channels. Any existing channels will continue to use the
4295 /// runtime settings which were stored when the ChannelManager was serialized.
4296 pub default_config: UserConfig,
4298 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
4299 /// value.get_funding_txo() should be the key).
4301 /// If a monitor is inconsistent with the channel state during deserialization the channel will
4302 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
4303 /// is true for missing channels as well. If there is a monitor missing for which we find
4304 /// channel data Err(DecodeError::InvalidValue) will be returned.
4306 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
4309 /// (C-not exported) because we have no HashMap bindings
4310 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
4313 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4314 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
4315 where M::Target: chain::Watch<Signer>,
4316 T::Target: BroadcasterInterface,
4317 K::Target: KeysInterface<Signer = Signer>,
4318 F::Target: FeeEstimator,
4321 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
4322 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
4323 /// populate a HashMap directly from C.
4324 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
4325 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
4327 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
4328 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
4333 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
4334 // SipmleArcChannelManager type:
4335 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4336 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
4337 where M::Target: chain::Watch<Signer>,
4338 T::Target: BroadcasterInterface,
4339 K::Target: KeysInterface<Signer = Signer>,
4340 F::Target: FeeEstimator,
4343 fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4344 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
4345 Ok((blockhash, Arc::new(chan_manager)))
4349 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4350 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
4351 where M::Target: chain::Watch<Signer>,
4352 T::Target: BroadcasterInterface,
4353 K::Target: KeysInterface<Signer = Signer>,
4354 F::Target: FeeEstimator,
4357 fn read<R: ::std::io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4358 let _ver: u8 = Readable::read(reader)?;
4359 let min_ver: u8 = Readable::read(reader)?;
4360 if min_ver > SERIALIZATION_VERSION {
4361 return Err(DecodeError::UnknownVersion);
4364 let genesis_hash: BlockHash = Readable::read(reader)?;
4365 let best_block_height: u32 = Readable::read(reader)?;
4366 let best_block_hash: BlockHash = Readable::read(reader)?;
4368 let mut failed_htlcs = Vec::new();
4370 let channel_count: u64 = Readable::read(reader)?;
4371 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
4372 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4373 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4374 for _ in 0..channel_count {
4375 let mut channel: Channel<Signer> = Channel::read(reader, &args.keys_manager)?;
4376 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
4377 funding_txo_set.insert(funding_txo.clone());
4378 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
4379 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
4380 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
4381 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
4382 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
4383 // If the channel is ahead of the monitor, return InvalidValue:
4384 return Err(DecodeError::InvalidValue);
4385 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
4386 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
4387 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
4388 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
4389 // But if the channel is behind of the monitor, close the channel:
4390 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
4391 failed_htlcs.append(&mut new_failed_htlcs);
4392 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4394 if let Some(short_channel_id) = channel.get_short_channel_id() {
4395 short_to_id.insert(short_channel_id, channel.channel_id());
4397 by_id.insert(channel.channel_id(), channel);
4400 return Err(DecodeError::InvalidValue);
4404 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
4405 if !funding_txo_set.contains(funding_txo) {
4406 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4410 const MAX_ALLOC_SIZE: usize = 1024 * 64;
4411 let forward_htlcs_count: u64 = Readable::read(reader)?;
4412 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
4413 for _ in 0..forward_htlcs_count {
4414 let short_channel_id = Readable::read(reader)?;
4415 let pending_forwards_count: u64 = Readable::read(reader)?;
4416 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
4417 for _ in 0..pending_forwards_count {
4418 pending_forwards.push(Readable::read(reader)?);
4420 forward_htlcs.insert(short_channel_id, pending_forwards);
4423 let claimable_htlcs_count: u64 = Readable::read(reader)?;
4424 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
4425 for _ in 0..claimable_htlcs_count {
4426 let payment_hash = Readable::read(reader)?;
4427 let previous_hops_len: u64 = Readable::read(reader)?;
4428 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
4429 for _ in 0..previous_hops_len {
4430 previous_hops.push(Readable::read(reader)?);
4432 claimable_htlcs.insert(payment_hash, previous_hops);
4435 let peer_count: u64 = Readable::read(reader)?;
4436 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
4437 for _ in 0..peer_count {
4438 let peer_pubkey = Readable::read(reader)?;
4439 let peer_state = PeerState {
4440 latest_features: Readable::read(reader)?,
4442 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
4445 let event_count: u64 = Readable::read(reader)?;
4446 let mut pending_events_read: Vec<events::Event> = Vec::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<events::Event>()));
4447 for _ in 0..event_count {
4448 match MaybeReadable::read(reader)? {
4449 Some(event) => pending_events_read.push(event),
4454 let background_event_count: u64 = Readable::read(reader)?;
4455 let mut pending_background_events_read: Vec<BackgroundEvent> = Vec::with_capacity(cmp::min(background_event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<BackgroundEvent>()));
4456 for _ in 0..background_event_count {
4457 match <u8 as Readable>::read(reader)? {
4458 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
4459 _ => return Err(DecodeError::InvalidValue),
4463 let last_node_announcement_serial: u32 = Readable::read(reader)?;
4465 let mut secp_ctx = Secp256k1::new();
4466 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
4468 let channel_manager = ChannelManager {
4470 fee_estimator: args.fee_estimator,
4471 chain_monitor: args.chain_monitor,
4472 tx_broadcaster: args.tx_broadcaster,
4474 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
4476 channel_state: Mutex::new(ChannelHolder {
4481 pending_msg_events: Vec::new(),
4483 our_network_key: args.keys_manager.get_node_secret(),
4484 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &args.keys_manager.get_node_secret()),
4487 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
4489 per_peer_state: RwLock::new(per_peer_state),
4491 pending_events: Mutex::new(pending_events_read),
4492 pending_background_events: Mutex::new(pending_background_events_read),
4493 total_consistency_lock: RwLock::new(()),
4494 persistence_notifier: PersistenceNotifier::new(),
4496 keys_manager: args.keys_manager,
4497 logger: args.logger,
4498 default_configuration: args.default_config,
4501 for htlc_source in failed_htlcs.drain(..) {
4502 channel_manager.fail_htlc_backwards_internal(channel_manager.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
4505 //TODO: Broadcast channel update for closed channels, but only after we've made a
4506 //connection or two.
4508 Ok((best_block_hash.clone(), channel_manager))
4514 use ln::channelmanager::PersistenceNotifier;
4516 use std::sync::atomic::{AtomicBool, Ordering};
4518 use std::time::Duration;
4521 fn test_wait_timeout() {
4522 let persistence_notifier = Arc::new(PersistenceNotifier::new());
4523 let thread_notifier = Arc::clone(&persistence_notifier);
4525 let exit_thread = Arc::new(AtomicBool::new(false));
4526 let exit_thread_clone = exit_thread.clone();
4527 thread::spawn(move || {
4529 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
4530 let mut persistence_lock = persist_mtx.lock().unwrap();
4531 *persistence_lock = true;
4534 if exit_thread_clone.load(Ordering::SeqCst) {
4540 // Check that we can block indefinitely until updates are available.
4541 let _ = persistence_notifier.wait();
4543 // Check that the PersistenceNotifier will return after the given duration if updates are
4546 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
4551 exit_thread.store(true, Ordering::SeqCst);
4553 // Check that the PersistenceNotifier will return after the given duration even if no updates
4556 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
4563 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))]
4566 use chain::chainmonitor::ChainMonitor;
4567 use chain::channelmonitor::Persist;
4568 use chain::keysinterface::{KeysManager, InMemorySigner};
4569 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
4570 use ln::features::InitFeatures;
4571 use ln::functional_test_utils::*;
4572 use ln::msgs::ChannelMessageHandler;
4573 use routing::network_graph::NetworkGraph;
4574 use routing::router::get_route;
4575 use util::test_utils;
4576 use util::config::UserConfig;
4577 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
4579 use bitcoin::hashes::Hash;
4580 use bitcoin::hashes::sha256::Hash as Sha256;
4581 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
4583 use std::sync::Mutex;
4587 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
4588 node: &'a ChannelManager<InMemorySigner,
4589 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
4590 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
4591 &'a test_utils::TestLogger, &'a P>,
4592 &'a test_utils::TestBroadcaster, &'a KeysManager,
4593 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
4598 fn bench_sends(bench: &mut Bencher) {
4599 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
4602 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
4603 // Do a simple benchmark of sending a payment back and forth between two nodes.
4604 // Note that this is unrealistic as each payment send will require at least two fsync
4606 let network = bitcoin::Network::Testnet;
4607 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
4609 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
4610 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4612 let mut config: UserConfig = Default::default();
4613 config.own_channel_config.minimum_depth = 1;
4615 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
4616 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
4617 let seed_a = [1u8; 32];
4618 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
4619 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
4621 best_block: BestBlock::from_genesis(network),
4623 let node_a_holder = NodeHolder { node: &node_a };
4625 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
4626 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
4627 let seed_b = [2u8; 32];
4628 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
4629 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
4631 best_block: BestBlock::from_genesis(network),
4633 let node_b_holder = NodeHolder { node: &node_b };
4635 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
4636 node_b.handle_open_channel(&node_a.get_our_node_id(), InitFeatures::known(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
4637 node_a.handle_accept_channel(&node_b.get_our_node_id(), InitFeatures::known(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
4640 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
4641 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
4642 value: 8_000_000, script_pubkey: output_script,
4644 node_a.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4645 } else { panic!(); }
4647 node_b.handle_funding_created(&node_a.get_our_node_id(), &get_event_msg!(node_a_holder, MessageSendEvent::SendFundingCreated, node_b.get_our_node_id()));
4648 node_a.handle_funding_signed(&node_b.get_our_node_id(), &get_event_msg!(node_b_holder, MessageSendEvent::SendFundingSigned, node_a.get_our_node_id()));
4650 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
4653 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4656 Listen::block_connected(&node_a, &block, 1);
4657 Listen::block_connected(&node_b, &block, 1);
4659 node_a.handle_funding_locked(&node_b.get_our_node_id(), &get_event_msg!(node_b_holder, MessageSendEvent::SendFundingLocked, node_a.get_our_node_id()));
4660 node_b.handle_funding_locked(&node_a.get_our_node_id(), &get_event_msg!(node_a_holder, MessageSendEvent::SendFundingLocked, node_b.get_our_node_id()));
4662 let dummy_graph = NetworkGraph::new(genesis_hash);
4664 macro_rules! send_payment {
4665 ($node_a: expr, $node_b: expr) => {
4666 let usable_channels = $node_a.list_usable_channels();
4667 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), None, Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
4669 let payment_preimage = PaymentPreimage([0; 32]);
4670 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
4672 $node_a.send_payment(&route, payment_hash, &None).unwrap();
4673 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
4674 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
4675 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
4676 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
4677 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
4678 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
4679 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &get_event_msg!(NodeHolder { node: &$node_a }, MessageSendEvent::SendRevokeAndACK, $node_b.get_our_node_id()));
4681 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
4682 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
4683 assert!($node_b.claim_funds(payment_preimage, &None, 10_000));
4685 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
4686 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
4687 assert_eq!(node_id, $node_a.get_our_node_id());
4688 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4689 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
4691 _ => panic!("Failed to generate claim event"),
4694 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
4695 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
4696 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
4697 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &get_event_msg!(NodeHolder { node: &$node_b }, MessageSendEvent::SendRevokeAndACK, $node_a.get_our_node_id()));
4699 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
4704 send_payment!(node_a, node_b);
4705 send_payment!(node_b, node_a);