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 #[derive(Clone, Copy)]
482 pub struct BestBlock {
483 block_hash: BlockHash,
488 /// Returns the best block from the genesis of the given network.
489 pub fn from_genesis(network: Network) -> Self {
491 block_hash: genesis_block(network).header.block_hash(),
496 /// Returns the best block as identified by the given block hash and height.
497 pub fn new(block_hash: BlockHash, height: u32) -> Self {
498 BestBlock { block_hash, height }
501 /// Returns the best block hash.
502 pub fn block_hash(&self) -> BlockHash { self.block_hash }
504 /// Returns the best block height.
505 pub fn height(&self) -> u32 { self.height }
508 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
509 /// desirable to notify any listeners on `await_persistable_update_timeout`/
510 /// `await_persistable_update` that new updates are available for persistence. Therefore, this
511 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
512 /// sending the aforementioned notification (since the lock being released indicates that the
513 /// updates are ready for persistence).
514 struct PersistenceNotifierGuard<'a> {
515 persistence_notifier: &'a PersistenceNotifier,
516 // We hold onto this result so the lock doesn't get released immediately.
517 _read_guard: RwLockReadGuard<'a, ()>,
520 impl<'a> PersistenceNotifierGuard<'a> {
521 fn new(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> Self {
522 let read_guard = lock.read().unwrap();
525 persistence_notifier: notifier,
526 _read_guard: read_guard,
531 impl<'a> Drop for PersistenceNotifierGuard<'a> {
533 self.persistence_notifier.notify();
537 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
538 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
540 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
542 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
543 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
544 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
545 /// the maximum required amount in lnd as of March 2021.
546 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
548 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
549 /// HTLC's CLTV. The current default represents roughly six hours of blocks at six blocks/hour.
551 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
553 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
554 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
555 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
556 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
557 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
558 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6 * 6;
559 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
561 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
562 // ie that if the next-hop peer fails the HTLC within
563 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
564 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
565 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
566 // LATENCY_GRACE_PERIOD_BLOCKS.
569 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;
571 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
572 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
575 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
577 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
579 pub struct ChannelDetails {
580 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
581 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
582 /// Note that this means this value is *not* persistent - it can change once during the
583 /// lifetime of the channel.
584 pub channel_id: [u8; 32],
585 /// The position of the funding transaction in the chain. None if the funding transaction has
586 /// not yet been confirmed and the channel fully opened.
587 pub short_channel_id: Option<u64>,
588 /// The node_id of our counterparty
589 pub remote_network_id: PublicKey,
590 /// The Features the channel counterparty provided upon last connection.
591 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
592 /// many routing-relevant features are present in the init context.
593 pub counterparty_features: InitFeatures,
594 /// The value, in satoshis, of this channel as appears in the funding output
595 pub channel_value_satoshis: u64,
596 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
598 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
599 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
600 /// available for inclusion in new outbound HTLCs). This further does not include any pending
601 /// outgoing HTLCs which are awaiting some other resolution to be sent.
602 pub outbound_capacity_msat: u64,
603 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
604 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
605 /// available for inclusion in new inbound HTLCs).
606 /// Note that there are some corner cases not fully handled here, so the actual available
607 /// inbound capacity may be slightly higher than this.
608 pub inbound_capacity_msat: u64,
609 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
610 /// the peer is connected, and (c) no monitor update failure is pending resolution.
613 /// Information on the fees and requirements that the counterparty requires when forwarding
614 /// payments to us through this channel.
615 pub counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
618 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
619 /// Err() type describing which state the payment is in, see the description of individual enum
621 #[derive(Clone, Debug)]
622 pub enum PaymentSendFailure {
623 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
624 /// send the payment at all. No channel state has been changed or messages sent to peers, and
625 /// once you've changed the parameter at error, you can freely retry the payment in full.
626 ParameterError(APIError),
627 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
628 /// from attempting to send the payment at all. No channel state has been changed or messages
629 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
632 /// The results here are ordered the same as the paths in the route object which was passed to
634 PathParameterError(Vec<Result<(), APIError>>),
635 /// All paths which were attempted failed to send, with no channel state change taking place.
636 /// You can freely retry the payment in full (though you probably want to do so over different
637 /// paths than the ones selected).
638 AllFailedRetrySafe(Vec<APIError>),
639 /// Some paths which were attempted failed to send, though possibly not all. At least some
640 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
641 /// in over-/re-payment.
643 /// The results here are ordered the same as the paths in the route object which was passed to
644 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
645 /// retried (though there is currently no API with which to do so).
647 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
648 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
649 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
650 /// with the latest update_id.
651 PartialFailure(Vec<Result<(), APIError>>),
654 macro_rules! handle_error {
655 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
658 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
659 #[cfg(debug_assertions)]
661 // In testing, ensure there are no deadlocks where the lock is already held upon
662 // entering the macro.
663 assert!($self.channel_state.try_lock().is_ok());
666 let mut msg_events = Vec::with_capacity(2);
668 if let Some((shutdown_res, update_option)) = shutdown_finish {
669 $self.finish_force_close_channel(shutdown_res);
670 if let Some(update) = update_option {
671 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
677 log_error!($self.logger, "{}", err.err);
678 if let msgs::ErrorAction::IgnoreError = err.action {
680 msg_events.push(events::MessageSendEvent::HandleError {
681 node_id: $counterparty_node_id,
682 action: err.action.clone()
686 if !msg_events.is_empty() {
687 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
690 // Return error in case higher-API need one
697 macro_rules! break_chan_entry {
698 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
701 Err(ChannelError::Ignore(msg)) => {
702 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
704 Err(ChannelError::Close(msg)) => {
705 log_trace!($self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
706 let (channel_id, mut chan) = $entry.remove_entry();
707 if let Some(short_id) = chan.get_short_channel_id() {
708 $channel_state.short_to_id.remove(&short_id);
710 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()))
712 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"); }
717 macro_rules! try_chan_entry {
718 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
721 Err(ChannelError::Ignore(msg)) => {
722 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
724 Err(ChannelError::Close(msg)) => {
725 log_trace!($self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
726 let (channel_id, mut chan) = $entry.remove_entry();
727 if let Some(short_id) = chan.get_short_channel_id() {
728 $channel_state.short_to_id.remove(&short_id);
730 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()))
732 Err(ChannelError::CloseDelayBroadcast(msg)) => {
733 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
734 let (channel_id, mut chan) = $entry.remove_entry();
735 if let Some(short_id) = chan.get_short_channel_id() {
736 $channel_state.short_to_id.remove(&short_id);
738 let shutdown_res = chan.force_shutdown(false);
739 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
745 macro_rules! handle_monitor_err {
746 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
747 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
749 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
751 ChannelMonitorUpdateErr::PermanentFailure => {
752 log_error!($self.logger, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
753 let (channel_id, mut chan) = $entry.remove_entry();
754 if let Some(short_id) = chan.get_short_channel_id() {
755 $channel_state.short_to_id.remove(&short_id);
757 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
758 // chain in a confused state! We need to move them into the ChannelMonitor which
759 // will be responsible for failing backwards once things confirm on-chain.
760 // It's ok that we drop $failed_forwards here - at this point we'd rather they
761 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
762 // us bother trying to claim it just to forward on to another peer. If we're
763 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
764 // given up the preimage yet, so might as well just wait until the payment is
765 // retried, avoiding the on-chain fees.
766 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()));
769 ChannelMonitorUpdateErr::TemporaryFailure => {
770 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
771 log_bytes!($entry.key()[..]),
772 if $resend_commitment && $resend_raa {
774 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
775 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
777 } else if $resend_commitment { "commitment" }
778 else if $resend_raa { "RAA" }
780 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
781 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
782 if !$resend_commitment {
783 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
786 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
788 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
789 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$entry.key()))
795 macro_rules! return_monitor_err {
796 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
797 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
799 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
800 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
804 // Does not break in case of TemporaryFailure!
805 macro_rules! maybe_break_monitor_err {
806 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
807 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
808 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
811 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
816 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
817 where M::Target: chain::Watch<Signer>,
818 T::Target: BroadcasterInterface,
819 K::Target: KeysInterface<Signer = Signer>,
820 F::Target: FeeEstimator,
823 /// Constructs a new ChannelManager to hold several channels and route between them.
825 /// This is the main "logic hub" for all channel-related actions, and implements
826 /// ChannelMessageHandler.
828 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
830 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
832 /// Users need to notify the new ChannelManager when a new block is connected or
833 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
834 /// from after `params.latest_hash`.
835 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
836 let mut secp_ctx = Secp256k1::new();
837 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
840 default_configuration: config.clone(),
841 genesis_hash: genesis_block(params.network).header.block_hash(),
842 fee_estimator: fee_est,
846 best_block: RwLock::new(params.best_block),
848 channel_state: Mutex::new(ChannelHolder{
849 by_id: HashMap::new(),
850 short_to_id: HashMap::new(),
851 forward_htlcs: HashMap::new(),
852 claimable_htlcs: HashMap::new(),
853 pending_msg_events: Vec::new(),
855 our_network_key: keys_manager.get_node_secret(),
856 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()),
859 last_node_announcement_serial: AtomicUsize::new(0),
861 per_peer_state: RwLock::new(HashMap::new()),
863 pending_events: Mutex::new(Vec::new()),
864 pending_background_events: Mutex::new(Vec::new()),
865 total_consistency_lock: RwLock::new(()),
866 persistence_notifier: PersistenceNotifier::new(),
874 /// Gets the current configuration applied to all new channels, as
875 pub fn get_current_default_configuration(&self) -> &UserConfig {
876 &self.default_configuration
879 /// Creates a new outbound channel to the given remote node and with the given value.
881 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
882 /// tracking of which events correspond with which create_channel call. Note that the
883 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
884 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
885 /// otherwise ignored.
887 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
888 /// PeerManager::process_events afterwards.
890 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
891 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
892 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> {
893 if channel_value_satoshis < 1000 {
894 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
897 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
898 let channel = Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, config)?;
899 let res = channel.get_open_channel(self.genesis_hash.clone());
901 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
902 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
903 debug_assert!(&self.total_consistency_lock.try_write().is_err());
905 let mut channel_state = self.channel_state.lock().unwrap();
906 match channel_state.by_id.entry(channel.channel_id()) {
907 hash_map::Entry::Occupied(_) => {
908 if cfg!(feature = "fuzztarget") {
909 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
911 panic!("RNG is bad???");
914 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
916 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
917 node_id: their_network_key,
923 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
924 let mut res = Vec::new();
926 let channel_state = self.channel_state.lock().unwrap();
927 res.reserve(channel_state.by_id.len());
928 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
929 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
930 res.push(ChannelDetails {
931 channel_id: (*channel_id).clone(),
932 short_channel_id: channel.get_short_channel_id(),
933 remote_network_id: channel.get_counterparty_node_id(),
934 counterparty_features: InitFeatures::empty(),
935 channel_value_satoshis: channel.get_value_satoshis(),
936 inbound_capacity_msat,
937 outbound_capacity_msat,
938 user_id: channel.get_user_id(),
939 is_live: channel.is_live(),
940 counterparty_forwarding_info: channel.counterparty_forwarding_info(),
944 let per_peer_state = self.per_peer_state.read().unwrap();
945 for chan in res.iter_mut() {
946 if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
947 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
953 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
954 /// more information.
955 pub fn list_channels(&self) -> Vec<ChannelDetails> {
956 self.list_channels_with_filter(|_| true)
959 /// Gets the list of usable channels, in random order. Useful as an argument to
960 /// get_route to ensure non-announced channels are used.
962 /// These are guaranteed to have their is_live value set to true, see the documentation for
963 /// ChannelDetails::is_live for more info on exactly what the criteria are.
964 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
965 // Note we use is_live here instead of usable which leads to somewhat confused
966 // internal/external nomenclature, but that's ok cause that's probably what the user
967 // really wanted anyway.
968 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
971 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
972 /// will be accepted on the given channel, and after additional timeout/the closing of all
973 /// pending HTLCs, the channel will be closed on chain.
975 /// May generate a SendShutdown message event on success, which should be relayed.
976 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
977 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
979 let (mut failed_htlcs, chan_option) = {
980 let mut channel_state_lock = self.channel_state.lock().unwrap();
981 let channel_state = &mut *channel_state_lock;
982 match channel_state.by_id.entry(channel_id.clone()) {
983 hash_map::Entry::Occupied(mut chan_entry) => {
984 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
985 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
986 node_id: chan_entry.get().get_counterparty_node_id(),
989 if chan_entry.get().is_shutdown() {
990 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
991 channel_state.short_to_id.remove(&short_id);
993 (failed_htlcs, Some(chan_entry.remove_entry().1))
994 } else { (failed_htlcs, None) }
996 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
999 for htlc_source in failed_htlcs.drain(..) {
1000 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() });
1002 let chan_update = if let Some(chan) = chan_option {
1003 if let Ok(update) = self.get_channel_update(&chan) {
1008 if let Some(update) = chan_update {
1009 let mut channel_state = self.channel_state.lock().unwrap();
1010 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1019 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1020 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1021 log_trace!(self.logger, "Finishing force-closure of channel {} HTLCs to fail", failed_htlcs.len());
1022 for htlc_source in failed_htlcs.drain(..) {
1023 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() });
1025 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1026 // There isn't anything we can do if we get an update failure - we're already
1027 // force-closing. The monitor update on the required in-memory copy should broadcast
1028 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1029 // ignore the result here.
1030 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1034 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: Option<&PublicKey>) -> Result<PublicKey, APIError> {
1036 let mut channel_state_lock = self.channel_state.lock().unwrap();
1037 let channel_state = &mut *channel_state_lock;
1038 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1039 if let Some(node_id) = peer_node_id {
1040 if chan.get().get_counterparty_node_id() != *node_id {
1041 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1044 if let Some(short_id) = chan.get().get_short_channel_id() {
1045 channel_state.short_to_id.remove(&short_id);
1047 chan.remove_entry().1
1049 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1052 log_trace!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1053 self.finish_force_close_channel(chan.force_shutdown(true));
1054 if let Ok(update) = self.get_channel_update(&chan) {
1055 let mut channel_state = self.channel_state.lock().unwrap();
1056 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1061 Ok(chan.get_counterparty_node_id())
1064 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1065 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1066 pub fn force_close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1067 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1068 match self.force_close_channel_with_peer(channel_id, None) {
1069 Ok(counterparty_node_id) => {
1070 self.channel_state.lock().unwrap().pending_msg_events.push(
1071 events::MessageSendEvent::HandleError {
1072 node_id: counterparty_node_id,
1073 action: msgs::ErrorAction::SendErrorMessage {
1074 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1084 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1085 /// for each to the chain and rejecting new HTLCs on each.
1086 pub fn force_close_all_channels(&self) {
1087 for chan in self.list_channels() {
1088 let _ = self.force_close_channel(&chan.channel_id);
1092 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
1093 macro_rules! return_malformed_err {
1094 ($msg: expr, $err_code: expr) => {
1096 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1097 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1098 channel_id: msg.channel_id,
1099 htlc_id: msg.htlc_id,
1100 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1101 failure_code: $err_code,
1102 })), self.channel_state.lock().unwrap());
1107 if let Err(_) = msg.onion_routing_packet.public_key {
1108 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
1111 let shared_secret = {
1112 let mut arr = [0; 32];
1113 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
1116 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
1118 if msg.onion_routing_packet.version != 0 {
1119 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1120 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1121 //the hash doesn't really serve any purpose - in the case of hashing all data, the
1122 //receiving node would have to brute force to figure out which version was put in the
1123 //packet by the node that send us the message, in the case of hashing the hop_data, the
1124 //node knows the HMAC matched, so they already know what is there...
1125 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
1128 let mut hmac = HmacEngine::<Sha256>::new(&mu);
1129 hmac.input(&msg.onion_routing_packet.hop_data);
1130 hmac.input(&msg.payment_hash.0[..]);
1131 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
1132 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
1135 let mut channel_state = None;
1136 macro_rules! return_err {
1137 ($msg: expr, $err_code: expr, $data: expr) => {
1139 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1140 if channel_state.is_none() {
1141 channel_state = Some(self.channel_state.lock().unwrap());
1143 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1144 channel_id: msg.channel_id,
1145 htlc_id: msg.htlc_id,
1146 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1147 })), channel_state.unwrap());
1152 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1153 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1154 let (next_hop_data, next_hop_hmac) = {
1155 match msgs::OnionHopData::read(&mut chacha_stream) {
1157 let error_code = match err {
1158 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1159 msgs::DecodeError::UnknownRequiredFeature|
1160 msgs::DecodeError::InvalidValue|
1161 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1162 _ => 0x2000 | 2, // Should never happen
1164 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1167 let mut hmac = [0; 32];
1168 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1169 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1176 let pending_forward_info = if next_hop_hmac == [0; 32] {
1179 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1180 // We could do some fancy randomness test here, but, ehh, whatever.
1181 // This checks for the issue where you can calculate the path length given the
1182 // onion data as all the path entries that the originator sent will be here
1183 // as-is (and were originally 0s).
1184 // Of course reverse path calculation is still pretty easy given naive routing
1185 // algorithms, but this fixes the most-obvious case.
1186 let mut next_bytes = [0; 32];
1187 chacha_stream.read_exact(&mut next_bytes).unwrap();
1188 assert_ne!(next_bytes[..], [0; 32][..]);
1189 chacha_stream.read_exact(&mut next_bytes).unwrap();
1190 assert_ne!(next_bytes[..], [0; 32][..]);
1194 // final_expiry_too_soon
1195 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure we have at least
1196 // HTLC_FAIL_BACK_BUFFER blocks to go.
1197 // Also, ensure that, in the case of an unknown payment hash, our payment logic has enough time to fail the HTLC backward
1198 // before our onchain logic triggers a channel closure (see HTLC_FAIL_BACK_BUFFER rational).
1199 if (msg.cltv_expiry as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1200 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1202 // final_incorrect_htlc_amount
1203 if next_hop_data.amt_to_forward > msg.amount_msat {
1204 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1206 // final_incorrect_cltv_expiry
1207 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1208 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1211 let payment_data = match next_hop_data.format {
1212 msgs::OnionHopDataFormat::Legacy { .. } => None,
1213 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1214 msgs::OnionHopDataFormat::FinalNode { payment_data } => payment_data,
1217 // Note that we could obviously respond immediately with an update_fulfill_htlc
1218 // message, however that would leak that we are the recipient of this payment, so
1219 // instead we stay symmetric with the forwarding case, only responding (after a
1220 // delay) once they've send us a commitment_signed!
1222 PendingHTLCStatus::Forward(PendingHTLCInfo {
1223 routing: PendingHTLCRouting::Receive {
1225 incoming_cltv_expiry: msg.cltv_expiry,
1227 payment_hash: msg.payment_hash.clone(),
1228 incoming_shared_secret: shared_secret,
1229 amt_to_forward: next_hop_data.amt_to_forward,
1230 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1233 let mut new_packet_data = [0; 20*65];
1234 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1235 #[cfg(debug_assertions)]
1237 // Check two things:
1238 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1239 // read above emptied out our buffer and the unwrap() wont needlessly panic
1240 // b) that we didn't somehow magically end up with extra data.
1242 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1244 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1245 // fill the onion hop data we'll forward to our next-hop peer.
1246 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1248 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1250 let blinding_factor = {
1251 let mut sha = Sha256::engine();
1252 sha.input(&new_pubkey.serialize()[..]);
1253 sha.input(&shared_secret);
1254 Sha256::from_engine(sha).into_inner()
1257 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1259 } else { Ok(new_pubkey) };
1261 let outgoing_packet = msgs::OnionPacket {
1264 hop_data: new_packet_data,
1265 hmac: next_hop_hmac.clone(),
1268 let short_channel_id = match next_hop_data.format {
1269 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1270 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1271 msgs::OnionHopDataFormat::FinalNode { .. } => {
1272 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1276 PendingHTLCStatus::Forward(PendingHTLCInfo {
1277 routing: PendingHTLCRouting::Forward {
1278 onion_packet: outgoing_packet,
1281 payment_hash: msg.payment_hash.clone(),
1282 incoming_shared_secret: shared_secret,
1283 amt_to_forward: next_hop_data.amt_to_forward,
1284 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1288 channel_state = Some(self.channel_state.lock().unwrap());
1289 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1290 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1291 // with a short_channel_id of 0. This is important as various things later assume
1292 // short_channel_id is non-0 in any ::Forward.
1293 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1294 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1295 let forwarding_id = match id_option {
1296 None => { // unknown_next_peer
1297 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1299 Some(id) => id.clone(),
1301 if let Some((err, code, chan_update)) = loop {
1302 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1304 // Note that we could technically not return an error yet here and just hope
1305 // that the connection is reestablished or monitor updated by the time we get
1306 // around to doing the actual forward, but better to fail early if we can and
1307 // hopefully an attacker trying to path-trace payments cannot make this occur
1308 // on a small/per-node/per-channel scale.
1309 if !chan.is_live() { // channel_disabled
1310 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1312 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
1313 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1315 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) });
1316 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1317 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())));
1319 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + chan.get_cltv_expiry_delta() as u64 { // incorrect_cltv_expiry
1320 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())));
1322 let cur_height = self.best_block.read().unwrap().height() + 1;
1323 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now, but we want to be robust wrt to counterparty
1324 // packet sanitization (see HTLC_FAIL_BACK_BUFFER rational)
1325 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
1326 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1328 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1329 break Some(("CLTV expiry is too far in the future", 21, None));
1331 // In theory, we would be safe against unitentional channel-closure, if we only required a margin of LATENCY_GRACE_PERIOD_BLOCKS.
1332 // But, to be safe against policy reception, we use a longuer delay.
1333 if (*outgoing_cltv_value) as u64 <= (cur_height + HTLC_FAIL_BACK_BUFFER) as u64 {
1334 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1340 let mut res = Vec::with_capacity(8 + 128);
1341 if let Some(chan_update) = chan_update {
1342 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1343 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1345 else if code == 0x1000 | 13 {
1346 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1348 else if code == 0x1000 | 20 {
1349 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
1350 res.extend_from_slice(&byte_utils::be16_to_array(0));
1352 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1354 return_err!(err, code, &res[..]);
1359 (pending_forward_info, channel_state.unwrap())
1362 /// only fails if the channel does not yet have an assigned short_id
1363 /// May be called with channel_state already locked!
1364 fn get_channel_update(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1365 let short_channel_id = match chan.get_short_channel_id() {
1366 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
1370 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
1372 let unsigned = msgs::UnsignedChannelUpdate {
1373 chain_hash: self.genesis_hash,
1375 timestamp: chan.get_update_time_counter(),
1376 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
1377 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
1378 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
1379 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
1380 fee_base_msat: chan.get_holder_fee_base_msat(&self.fee_estimator),
1381 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1382 excess_data: Vec::new(),
1385 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1386 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1388 Ok(msgs::ChannelUpdate {
1394 // Only public for testing, this should otherwise never be called direcly
1395 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> {
1396 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1397 let prng_seed = self.keys_manager.get_secure_random_bytes();
1398 let session_priv = SecretKey::from_slice(&self.keys_manager.get_secure_random_bytes()[..]).expect("RNG is busted");
1400 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1401 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1402 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height)?;
1403 if onion_utils::route_size_insane(&onion_payloads) {
1404 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1406 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1408 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1410 let err: Result<(), _> = loop {
1411 let mut channel_lock = self.channel_state.lock().unwrap();
1412 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1413 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
1414 Some(id) => id.clone(),
1417 let channel_state = &mut *channel_lock;
1418 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1420 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
1421 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1423 if !chan.get().is_live() {
1424 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
1426 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1428 session_priv: session_priv.clone(),
1429 first_hop_htlc_msat: htlc_msat,
1430 }, onion_packet, &self.logger), channel_state, chan)
1432 Some((update_add, commitment_signed, monitor_update)) => {
1433 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1434 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1435 // Note that MonitorUpdateFailed here indicates (per function docs)
1436 // that we will resend the commitment update once monitor updating
1437 // is restored. Therefore, we must return an error indicating that
1438 // it is unsafe to retry the payment wholesale, which we do in the
1439 // send_payment check for MonitorUpdateFailed, below.
1440 return Err(APIError::MonitorUpdateFailed);
1443 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1444 node_id: path.first().unwrap().pubkey,
1445 updates: msgs::CommitmentUpdate {
1446 update_add_htlcs: vec![update_add],
1447 update_fulfill_htlcs: Vec::new(),
1448 update_fail_htlcs: Vec::new(),
1449 update_fail_malformed_htlcs: Vec::new(),
1457 } else { unreachable!(); }
1461 match handle_error!(self, err, path.first().unwrap().pubkey) {
1462 Ok(_) => unreachable!(),
1464 Err(APIError::ChannelUnavailable { err: e.err })
1469 /// Sends a payment along a given route.
1471 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1472 /// fields for more info.
1474 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1475 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1476 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1477 /// specified in the last hop in the route! Thus, you should probably do your own
1478 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1479 /// payment") and prevent double-sends yourself.
1481 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1483 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1484 /// each entry matching the corresponding-index entry in the route paths, see
1485 /// PaymentSendFailure for more info.
1487 /// In general, a path may raise:
1488 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1489 /// node public key) is specified.
1490 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1491 /// (including due to previous monitor update failure or new permanent monitor update
1493 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1494 /// relevant updates.
1496 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1497 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1498 /// different route unless you intend to pay twice!
1500 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1501 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1502 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1503 /// must not contain multiple paths as multi-path payments require a recipient-provided
1505 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1506 /// bit set (either as required or as available). If multiple paths are present in the Route,
1507 /// we assume the invoice had the basic_mpp feature set.
1508 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<(), PaymentSendFailure> {
1509 if route.paths.len() < 1 {
1510 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
1512 if route.paths.len() > 10 {
1513 // This limit is completely arbitrary - there aren't any real fundamental path-count
1514 // limits. After we support retrying individual paths we should likely bump this, but
1515 // for now more than 10 paths likely carries too much one-path failure.
1516 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
1518 let mut total_value = 0;
1519 let our_node_id = self.get_our_node_id();
1520 let mut path_errs = Vec::with_capacity(route.paths.len());
1521 'path_check: for path in route.paths.iter() {
1522 if path.len() < 1 || path.len() > 20 {
1523 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
1524 continue 'path_check;
1526 for (idx, hop) in path.iter().enumerate() {
1527 if idx != path.len() - 1 && hop.pubkey == our_node_id {
1528 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
1529 continue 'path_check;
1532 total_value += path.last().unwrap().fee_msat;
1533 path_errs.push(Ok(()));
1535 if path_errs.iter().any(|e| e.is_err()) {
1536 return Err(PaymentSendFailure::PathParameterError(path_errs));
1539 let cur_height = self.best_block.read().unwrap().height() + 1;
1540 let mut results = Vec::new();
1541 for path in route.paths.iter() {
1542 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height));
1544 let mut has_ok = false;
1545 let mut has_err = false;
1546 for res in results.iter() {
1547 if res.is_ok() { has_ok = true; }
1548 if res.is_err() { has_err = true; }
1549 if let &Err(APIError::MonitorUpdateFailed) = res {
1550 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
1557 if has_err && has_ok {
1558 Err(PaymentSendFailure::PartialFailure(results))
1560 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
1566 /// Call this upon creation of a funding transaction for the given channel.
1568 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
1569 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
1571 /// Panics if a funding transaction has already been provided for this channel.
1573 /// May panic if the output found in the funding transaction is duplicative with some other
1574 /// channel (note that this should be trivially prevented by using unique funding transaction
1575 /// keys per-channel).
1577 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
1578 /// counterparty's signature the funding transaction will automatically be broadcast via the
1579 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
1581 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
1582 /// not currently support replacing a funding transaction on an existing channel. Instead,
1583 /// create a new channel with a conflicting funding transaction.
1584 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction) -> Result<(), APIError> {
1585 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1587 for inp in funding_transaction.input.iter() {
1588 if inp.witness.is_empty() {
1589 return Err(APIError::APIMisuseError {
1590 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
1596 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
1598 let mut output_index = None;
1599 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
1600 for (idx, outp) in funding_transaction.output.iter().enumerate() {
1601 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
1602 if output_index.is_some() {
1603 return Err(APIError::APIMisuseError {
1604 err: "Multiple outputs matched the expected script and value".to_owned()
1607 if idx > u16::max_value() as usize {
1608 return Err(APIError::APIMisuseError {
1609 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
1612 output_index = Some(idx as u16);
1615 if output_index.is_none() {
1616 return Err(APIError::APIMisuseError {
1617 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
1620 let funding_txo = OutPoint { txid: funding_transaction.txid(), index: output_index.unwrap() };
1622 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
1623 .map_err(|e| if let ChannelError::Close(msg) = e {
1624 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
1625 } else { unreachable!(); })
1628 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
1630 match handle_error!(self, res, chan.get_counterparty_node_id()) {
1631 Ok(funding_msg) => {
1634 Err(_) => { return Err(APIError::ChannelUnavailable {
1635 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()
1640 let mut channel_state = self.channel_state.lock().unwrap();
1641 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1642 node_id: chan.get_counterparty_node_id(),
1645 match channel_state.by_id.entry(chan.channel_id()) {
1646 hash_map::Entry::Occupied(_) => {
1647 panic!("Generated duplicate funding txid?");
1649 hash_map::Entry::Vacant(e) => {
1656 fn get_announcement_sigs(&self, chan: &Channel<Signer>) -> Option<msgs::AnnouncementSignatures> {
1657 if !chan.should_announce() {
1658 log_trace!(self.logger, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
1662 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1664 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1666 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1667 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1669 Some(msgs::AnnouncementSignatures {
1670 channel_id: chan.channel_id(),
1671 short_channel_id: chan.get_short_channel_id().unwrap(),
1672 node_signature: our_node_sig,
1673 bitcoin_signature: our_bitcoin_sig,
1678 // Messages of up to 64KB should never end up more than half full with addresses, as that would
1679 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
1680 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
1682 const HALF_MESSAGE_IS_ADDRS: u32 = ::std::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
1685 // ...by failing to compile if the number of addresses that would be half of a message is
1686 // smaller than 500:
1687 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
1689 /// Generates a signed node_announcement from the given arguments and creates a
1690 /// BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
1691 /// seen a channel_announcement from us (ie unless we have public channels open).
1693 /// RGB is a node "color" and alias is a printable human-readable string to describe this node
1694 /// to humans. They carry no in-protocol meaning.
1696 /// addresses represent the set (possibly empty) of socket addresses on which this node accepts
1697 /// incoming connections. These will be broadcast to the network, publicly tying these
1698 /// addresses together. If you wish to preserve user privacy, addresses should likely contain
1699 /// only Tor Onion addresses.
1701 /// Panics if addresses is absurdly large (more than 500).
1702 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], addresses: Vec<NetAddress>) {
1703 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1705 if addresses.len() > 500 {
1706 panic!("More than half the message size was taken up by public addresses!");
1709 let announcement = msgs::UnsignedNodeAnnouncement {
1710 features: NodeFeatures::known(),
1711 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
1712 node_id: self.get_our_node_id(),
1713 rgb, alias, addresses,
1714 excess_address_data: Vec::new(),
1715 excess_data: Vec::new(),
1717 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1719 let mut channel_state = self.channel_state.lock().unwrap();
1720 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
1721 msg: msgs::NodeAnnouncement {
1722 signature: self.secp_ctx.sign(&msghash, &self.our_network_key),
1723 contents: announcement
1728 /// Processes HTLCs which are pending waiting on random forward delay.
1730 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1731 /// Will likely generate further events.
1732 pub fn process_pending_htlc_forwards(&self) {
1733 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1735 let mut new_events = Vec::new();
1736 let mut failed_forwards = Vec::new();
1737 let mut handle_errors = Vec::new();
1739 let mut channel_state_lock = self.channel_state.lock().unwrap();
1740 let channel_state = &mut *channel_state_lock;
1742 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1743 if short_chan_id != 0 {
1744 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1745 Some(chan_id) => chan_id.clone(),
1747 failed_forwards.reserve(pending_forwards.len());
1748 for forward_info in pending_forwards.drain(..) {
1749 match forward_info {
1750 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info,
1751 prev_funding_outpoint } => {
1752 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1753 short_channel_id: prev_short_channel_id,
1754 outpoint: prev_funding_outpoint,
1755 htlc_id: prev_htlc_id,
1756 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1758 failed_forwards.push((htlc_source, forward_info.payment_hash,
1759 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
1762 HTLCForwardInfo::FailHTLC { .. } => {
1763 // Channel went away before we could fail it. This implies
1764 // the channel is now on chain and our counterparty is
1765 // trying to broadcast the HTLC-Timeout, but that's their
1766 // problem, not ours.
1773 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1774 let mut add_htlc_msgs = Vec::new();
1775 let mut fail_htlc_msgs = Vec::new();
1776 for forward_info in pending_forwards.drain(..) {
1777 match forward_info {
1778 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
1779 routing: PendingHTLCRouting::Forward {
1781 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
1782 prev_funding_outpoint } => {
1783 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);
1784 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1785 short_channel_id: prev_short_channel_id,
1786 outpoint: prev_funding_outpoint,
1787 htlc_id: prev_htlc_id,
1788 incoming_packet_shared_secret: incoming_shared_secret,
1790 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
1792 if let ChannelError::Ignore(msg) = e {
1793 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
1795 panic!("Stated return value requirements in send_htlc() were not met");
1797 let chan_update = self.get_channel_update(chan.get()).unwrap();
1798 failed_forwards.push((htlc_source, payment_hash,
1799 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
1805 Some(msg) => { add_htlc_msgs.push(msg); },
1807 // Nothing to do here...we're waiting on a remote
1808 // revoke_and_ack before we can add anymore HTLCs. The Channel
1809 // will automatically handle building the update_add_htlc and
1810 // commitment_signed messages when we can.
1811 // TODO: Do some kind of timer to set the channel as !is_live()
1812 // as we don't really want others relying on us relaying through
1813 // this channel currently :/.
1819 HTLCForwardInfo::AddHTLC { .. } => {
1820 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
1822 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1823 log_trace!(self.logger, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1824 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1826 if let ChannelError::Ignore(msg) = e {
1827 log_trace!(self.logger, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1829 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1831 // fail-backs are best-effort, we probably already have one
1832 // pending, and if not that's OK, if not, the channel is on
1833 // the chain and sending the HTLC-Timeout is their problem.
1836 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1838 // Nothing to do here...we're waiting on a remote
1839 // revoke_and_ack before we can update the commitment
1840 // transaction. The Channel will automatically handle
1841 // building the update_fail_htlc and commitment_signed
1842 // messages when we can.
1843 // We don't need any kind of timer here as they should fail
1844 // the channel onto the chain if they can't get our
1845 // update_fail_htlc in time, it's not our problem.
1852 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1853 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
1856 // We surely failed send_commitment due to bad keys, in that case
1857 // close channel and then send error message to peer.
1858 let counterparty_node_id = chan.get().get_counterparty_node_id();
1859 let err: Result<(), _> = match e {
1860 ChannelError::Ignore(_) => {
1861 panic!("Stated return value requirements in send_commitment() were not met");
1863 ChannelError::Close(msg) => {
1864 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1865 let (channel_id, mut channel) = chan.remove_entry();
1866 if let Some(short_id) = channel.get_short_channel_id() {
1867 channel_state.short_to_id.remove(&short_id);
1869 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update(&channel).ok()))
1871 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"); }
1873 handle_errors.push((counterparty_node_id, err));
1877 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1878 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1881 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1882 node_id: chan.get().get_counterparty_node_id(),
1883 updates: msgs::CommitmentUpdate {
1884 update_add_htlcs: add_htlc_msgs,
1885 update_fulfill_htlcs: Vec::new(),
1886 update_fail_htlcs: fail_htlc_msgs,
1887 update_fail_malformed_htlcs: Vec::new(),
1889 commitment_signed: commitment_msg,
1897 for forward_info in pending_forwards.drain(..) {
1898 match forward_info {
1899 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
1900 routing: PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry },
1901 incoming_shared_secret, payment_hash, amt_to_forward, .. },
1902 prev_funding_outpoint } => {
1903 let prev_hop = HTLCPreviousHopData {
1904 short_channel_id: prev_short_channel_id,
1905 outpoint: prev_funding_outpoint,
1906 htlc_id: prev_htlc_id,
1907 incoming_packet_shared_secret: incoming_shared_secret,
1910 let mut total_value = 0;
1911 let payment_secret_opt =
1912 if let &Some(ref data) = &payment_data { Some(data.payment_secret.clone()) } else { None };
1913 let htlcs = channel_state.claimable_htlcs.entry((payment_hash, payment_secret_opt))
1914 .or_insert(Vec::new());
1915 htlcs.push(ClaimableHTLC {
1917 value: amt_to_forward,
1918 payment_data: payment_data.clone(),
1919 cltv_expiry: incoming_cltv_expiry,
1921 if let &Some(ref data) = &payment_data {
1922 for htlc in htlcs.iter() {
1923 total_value += htlc.value;
1924 if htlc.payment_data.as_ref().unwrap().total_msat != data.total_msat {
1925 total_value = msgs::MAX_VALUE_MSAT;
1927 if total_value >= msgs::MAX_VALUE_MSAT { break; }
1929 if total_value >= msgs::MAX_VALUE_MSAT || total_value > data.total_msat {
1930 for htlc in htlcs.iter() {
1931 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
1932 htlc_msat_height_data.extend_from_slice(
1933 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
1935 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
1936 short_channel_id: htlc.prev_hop.short_channel_id,
1937 outpoint: prev_funding_outpoint,
1938 htlc_id: htlc.prev_hop.htlc_id,
1939 incoming_packet_shared_secret: htlc.prev_hop.incoming_packet_shared_secret,
1941 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
1944 } else if total_value == data.total_msat {
1945 new_events.push(events::Event::PaymentReceived {
1947 payment_secret: Some(data.payment_secret),
1952 new_events.push(events::Event::PaymentReceived {
1954 payment_secret: None,
1955 amt: amt_to_forward,
1959 HTLCForwardInfo::AddHTLC { .. } => {
1960 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
1962 HTLCForwardInfo::FailHTLC { .. } => {
1963 panic!("Got pending fail of our own HTLC");
1971 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
1972 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
1975 for (counterparty_node_id, err) in handle_errors.drain(..) {
1976 let _ = handle_error!(self, err, counterparty_node_id);
1979 if new_events.is_empty() { return }
1980 let mut events = self.pending_events.lock().unwrap();
1981 events.append(&mut new_events);
1984 /// Free the background events, generally called from timer_tick_occurred.
1986 /// Exposed for testing to allow us to process events quickly without generating accidental
1987 /// BroadcastChannelUpdate events in timer_tick_occurred.
1989 /// Expects the caller to have a total_consistency_lock read lock.
1990 fn process_background_events(&self) {
1991 let mut background_events = Vec::new();
1992 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
1993 for event in background_events.drain(..) {
1995 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
1996 // The channel has already been closed, so no use bothering to care about the
1997 // monitor updating completing.
1998 let _ = self.chain_monitor.update_channel(funding_txo, update);
2004 #[cfg(any(test, feature = "_test_utils"))]
2005 pub(crate) fn test_process_background_events(&self) {
2006 self.process_background_events();
2009 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
2010 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
2011 /// to inform the network about the uselessness of these channels.
2013 /// This method handles all the details, and must be called roughly once per minute.
2015 /// Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
2016 pub fn timer_tick_occurred(&self) {
2017 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2018 self.process_background_events();
2020 let mut channel_state_lock = self.channel_state.lock().unwrap();
2021 let channel_state = &mut *channel_state_lock;
2022 for (_, chan) in channel_state.by_id.iter_mut() {
2023 if chan.is_disabled_staged() && !chan.is_live() {
2024 if let Ok(update) = self.get_channel_update(&chan) {
2025 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2030 } else if chan.is_disabled_staged() && chan.is_live() {
2032 } else if chan.is_disabled_marked() {
2033 chan.to_disabled_staged();
2038 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2039 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
2040 /// along the path (including in our own channel on which we received it).
2041 /// Returns false if no payment was found to fail backwards, true if the process of failing the
2042 /// HTLC backwards has been started.
2043 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>) -> bool {
2044 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2046 let mut channel_state = Some(self.channel_state.lock().unwrap());
2047 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&(*payment_hash, *payment_secret));
2048 if let Some(mut sources) = removed_source {
2049 for htlc in sources.drain(..) {
2050 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2051 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2052 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2053 self.best_block.read().unwrap().height()));
2054 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2055 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
2056 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
2062 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
2063 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
2064 // be surfaced to the user.
2065 fn fail_holding_cell_htlcs(&self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32]) {
2066 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
2068 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
2069 let (failure_code, onion_failure_data) =
2070 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
2071 hash_map::Entry::Occupied(chan_entry) => {
2072 if let Ok(upd) = self.get_channel_update(&chan_entry.get()) {
2073 (0x1000|7, upd.encode_with_len())
2075 (0x4000|10, Vec::new())
2078 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
2080 let channel_state = self.channel_state.lock().unwrap();
2081 self.fail_htlc_backwards_internal(channel_state,
2082 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
2084 HTLCSource::OutboundRoute { .. } => {
2085 self.pending_events.lock().unwrap().push(
2086 events::Event::PaymentFailed {
2088 rejected_by_dest: false,
2100 /// Fails an HTLC backwards to the sender of it to us.
2101 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
2102 /// There are several callsites that do stupid things like loop over a list of payment_hashes
2103 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
2104 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
2105 /// still-available channels.
2106 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
2107 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
2108 //identify whether we sent it or not based on the (I presume) very different runtime
2109 //between the branches here. We should make this async and move it into the forward HTLCs
2112 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
2113 // from block_connected which may run during initialization prior to the chain_monitor
2114 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
2116 HTLCSource::OutboundRoute { ref path, .. } => {
2117 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2118 mem::drop(channel_state_lock);
2119 match &onion_error {
2120 &HTLCFailReason::LightningError { ref err } => {
2122 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());
2124 let (channel_update, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2125 // TODO: If we decided to blame ourselves (or one of our channels) in
2126 // process_onion_failure we should close that channel as it implies our
2127 // next-hop is needlessly blaming us!
2128 if let Some(update) = channel_update {
2129 self.channel_state.lock().unwrap().pending_msg_events.push(
2130 events::MessageSendEvent::PaymentFailureNetworkUpdate {
2135 self.pending_events.lock().unwrap().push(
2136 events::Event::PaymentFailed {
2137 payment_hash: payment_hash.clone(),
2138 rejected_by_dest: !payment_retryable,
2140 error_code: onion_error_code,
2142 error_data: onion_error_data
2146 &HTLCFailReason::Reason {
2152 // we get a fail_malformed_htlc from the first hop
2153 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
2154 // failures here, but that would be insufficient as get_route
2155 // generally ignores its view of our own channels as we provide them via
2157 // TODO: For non-temporary failures, we really should be closing the
2158 // channel here as we apparently can't relay through them anyway.
2159 self.pending_events.lock().unwrap().push(
2160 events::Event::PaymentFailed {
2161 payment_hash: payment_hash.clone(),
2162 rejected_by_dest: path.len() == 1,
2164 error_code: Some(*failure_code),
2166 error_data: Some(data.clone()),
2172 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, .. }) => {
2173 let err_packet = match onion_error {
2174 HTLCFailReason::Reason { failure_code, data } => {
2175 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
2176 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
2177 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
2179 HTLCFailReason::LightningError { err } => {
2180 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
2181 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
2185 let mut forward_event = None;
2186 if channel_state_lock.forward_htlcs.is_empty() {
2187 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
2189 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
2190 hash_map::Entry::Occupied(mut entry) => {
2191 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
2193 hash_map::Entry::Vacant(entry) => {
2194 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
2197 mem::drop(channel_state_lock);
2198 if let Some(time) = forward_event {
2199 let mut pending_events = self.pending_events.lock().unwrap();
2200 pending_events.push(events::Event::PendingHTLCsForwardable {
2201 time_forwardable: time
2208 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
2209 /// generating message events for the net layer to claim the payment, if possible. Thus, you
2210 /// should probably kick the net layer to go send messages if this returns true!
2212 /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
2213 /// available within a few percent of the expected amount. This is critical for several
2214 /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
2215 /// payment_preimage without having provided the full value and b) it avoids certain
2216 /// privacy-breaking recipient-probing attacks which may reveal payment activity to
2217 /// motivated attackers.
2219 /// Note that the privacy concerns in (b) are not relevant in payments with a payment_secret
2220 /// set. Thus, for such payments we will claim any payments which do not under-pay.
2222 /// May panic if called except in response to a PaymentReceived event.
2223 pub fn claim_funds(&self, payment_preimage: PaymentPreimage, payment_secret: &Option<PaymentSecret>, expected_amount: u64) -> bool {
2224 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2226 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2228 let mut channel_state = Some(self.channel_state.lock().unwrap());
2229 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&(payment_hash, *payment_secret));
2230 if let Some(mut sources) = removed_source {
2231 assert!(!sources.is_empty());
2233 // If we are claiming an MPP payment, we have to take special care to ensure that each
2234 // channel exists before claiming all of the payments (inside one lock).
2235 // Note that channel existance is sufficient as we should always get a monitor update
2236 // which will take care of the real HTLC claim enforcement.
2238 // If we find an HTLC which we would need to claim but for which we do not have a
2239 // channel, we will fail all parts of the MPP payment. While we could wait and see if
2240 // the sender retries the already-failed path(s), it should be a pretty rare case where
2241 // we got all the HTLCs and then a channel closed while we were waiting for the user to
2242 // provide the preimage, so worrying too much about the optimal handling isn't worth
2245 let (is_mpp, mut valid_mpp) = if let &Some(ref data) = &sources[0].payment_data {
2246 assert!(payment_secret.is_some());
2247 (true, data.total_msat >= expected_amount)
2249 assert!(payment_secret.is_none());
2253 for htlc in sources.iter() {
2254 if !is_mpp || !valid_mpp { break; }
2255 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
2260 let mut errs = Vec::new();
2261 let mut claimed_any_htlcs = false;
2262 for htlc in sources.drain(..) {
2263 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2264 if (is_mpp && !valid_mpp) || (!is_mpp && (htlc.value < expected_amount || htlc.value > expected_amount * 2)) {
2265 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2266 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2267 self.best_block.read().unwrap().height()));
2268 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2269 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
2270 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
2272 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
2274 if let msgs::ErrorAction::IgnoreError = e.1.err.action {
2275 // We got a temporary failure updating monitor, but will claim the
2276 // HTLC when the monitor updating is restored (or on chain).
2277 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", e.1.err.err);
2278 claimed_any_htlcs = true;
2279 } else { errs.push(e); }
2281 Err(None) if is_mpp => unreachable!("We already checked for channel existence, we can't fail here!"),
2283 log_warn!(self.logger, "Channel we expected to claim an HTLC from was closed.");
2285 Ok(()) => claimed_any_htlcs = true,
2290 // Now that we've done the entire above loop in one lock, we can handle any errors
2291 // which were generated.
2292 channel_state.take();
2294 for (counterparty_node_id, err) in errs.drain(..) {
2295 let res: Result<(), _> = Err(err);
2296 let _ = handle_error!(self, res, counterparty_node_id);
2303 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> Result<(), Option<(PublicKey, MsgHandleErrInternal)>> {
2304 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
2305 let channel_state = &mut **channel_state_lock;
2306 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
2307 Some(chan_id) => chan_id.clone(),
2313 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
2314 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2315 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
2316 Ok((msgs, monitor_option)) => {
2317 if let Some(monitor_update) = monitor_option {
2318 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2319 if was_frozen_for_monitor {
2320 assert!(msgs.is_none());
2322 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())));
2326 if let Some((msg, commitment_signed)) = msgs {
2327 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2328 node_id: chan.get().get_counterparty_node_id(),
2329 updates: msgs::CommitmentUpdate {
2330 update_add_htlcs: Vec::new(),
2331 update_fulfill_htlcs: vec![msg],
2332 update_fail_htlcs: Vec::new(),
2333 update_fail_malformed_htlcs: Vec::new(),
2342 // TODO: Do something with e?
2343 // This should only occur if we are claiming an HTLC at the same time as the
2344 // HTLC is being failed (eg because a block is being connected and this caused
2345 // an HTLC to time out). This should, of course, only occur if the user is the
2346 // one doing the claiming (as it being a part of a peer claim would imply we're
2347 // about to lose funds) and only if the lock in claim_funds was dropped as a
2348 // previous HTLC was failed (thus not for an MPP payment).
2349 debug_assert!(false, "This shouldn't be reachable except in absurdly rare cases between monitor updates and HTLC timeouts: {:?}", e);
2353 } else { unreachable!(); }
2356 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
2358 HTLCSource::OutboundRoute { .. } => {
2359 mem::drop(channel_state_lock);
2360 let mut pending_events = self.pending_events.lock().unwrap();
2361 pending_events.push(events::Event::PaymentSent {
2365 HTLCSource::PreviousHopData(hop_data) => {
2366 let prev_outpoint = hop_data.outpoint;
2367 if let Err((counterparty_node_id, err)) = match self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage) {
2370 let preimage_update = ChannelMonitorUpdate {
2371 update_id: CLOSED_CHANNEL_UPDATE_ID,
2372 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
2373 payment_preimage: payment_preimage.clone(),
2376 // We update the ChannelMonitor on the backward link, after
2377 // receiving an offchain preimage event from the forward link (the
2378 // event being update_fulfill_htlc).
2379 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
2380 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
2381 payment_preimage, e);
2385 Err(Some(res)) => Err(res),
2387 mem::drop(channel_state_lock);
2388 let res: Result<(), _> = Err(err);
2389 let _ = handle_error!(self, res, counterparty_node_id);
2395 /// Gets the node_id held by this ChannelManager
2396 pub fn get_our_node_id(&self) -> PublicKey {
2397 self.our_network_pubkey.clone()
2400 /// Restores a single, given channel to normal operation after a
2401 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
2404 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
2405 /// fully committed in every copy of the given channels' ChannelMonitors.
2407 /// Note that there is no effect to calling with a highest_applied_update_id other than the
2408 /// current latest ChannelMonitorUpdate and one call to this function after multiple
2409 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
2410 /// exists largely only to prevent races between this and concurrent update_monitor calls.
2412 /// Thus, the anticipated use is, at a high level:
2413 /// 1) You register a chain::Watch with this ChannelManager,
2414 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
2415 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
2416 /// any time it cannot do so instantly,
2417 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
2418 /// 4) once all remote copies are updated, you call this function with the update_id that
2419 /// completed, and once it is the latest the Channel will be re-enabled.
2420 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
2421 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2423 let mut close_results = Vec::new();
2424 let mut htlc_forwards = Vec::new();
2425 let mut htlc_failures = Vec::new();
2426 let mut pending_events = Vec::new();
2429 let mut channel_lock = self.channel_state.lock().unwrap();
2430 let channel_state = &mut *channel_lock;
2431 let short_to_id = &mut channel_state.short_to_id;
2432 let pending_msg_events = &mut channel_state.pending_msg_events;
2433 let channel = match channel_state.by_id.get_mut(&funding_txo.to_channel_id()) {
2437 if !channel.is_awaiting_monitor_update() || channel.get_latest_monitor_update_id() != highest_applied_update_id {
2441 let (raa, commitment_update, order, pending_forwards, mut pending_failures, funding_broadcastable, funding_locked) = channel.monitor_updating_restored(&self.logger);
2442 if !pending_forwards.is_empty() {
2443 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), funding_txo.clone(), pending_forwards));
2445 htlc_failures.append(&mut pending_failures);
2447 macro_rules! handle_cs { () => {
2448 if let Some(update) = commitment_update {
2449 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2450 node_id: channel.get_counterparty_node_id(),
2455 macro_rules! handle_raa { () => {
2456 if let Some(revoke_and_ack) = raa {
2457 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2458 node_id: channel.get_counterparty_node_id(),
2459 msg: revoke_and_ack,
2464 RAACommitmentOrder::CommitmentFirst => {
2468 RAACommitmentOrder::RevokeAndACKFirst => {
2473 if let Some(tx) = funding_broadcastable {
2474 self.tx_broadcaster.broadcast_transaction(&tx);
2476 if let Some(msg) = funding_locked {
2477 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2478 node_id: channel.get_counterparty_node_id(),
2481 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2482 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2483 node_id: channel.get_counterparty_node_id(),
2484 msg: announcement_sigs,
2487 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2491 self.pending_events.lock().unwrap().append(&mut pending_events);
2493 for failure in htlc_failures.drain(..) {
2494 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2496 self.forward_htlcs(&mut htlc_forwards[..]);
2498 for res in close_results.drain(..) {
2499 self.finish_force_close_channel(res);
2503 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
2504 if msg.chain_hash != self.genesis_hash {
2505 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
2508 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, counterparty_node_id.clone(), their_features, msg, 0, &self.default_configuration)
2509 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
2510 let mut channel_state_lock = self.channel_state.lock().unwrap();
2511 let channel_state = &mut *channel_state_lock;
2512 match channel_state.by_id.entry(channel.channel_id()) {
2513 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone())),
2514 hash_map::Entry::Vacant(entry) => {
2515 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
2516 node_id: counterparty_node_id.clone(),
2517 msg: channel.get_accept_channel(),
2519 entry.insert(channel);
2525 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
2526 let (value, output_script, user_id) = {
2527 let mut channel_lock = self.channel_state.lock().unwrap();
2528 let channel_state = &mut *channel_lock;
2529 match channel_state.by_id.entry(msg.temporary_channel_id) {
2530 hash_map::Entry::Occupied(mut chan) => {
2531 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2532 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
2534 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
2535 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
2537 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
2540 let mut pending_events = self.pending_events.lock().unwrap();
2541 pending_events.push(events::Event::FundingGenerationReady {
2542 temporary_channel_id: msg.temporary_channel_id,
2543 channel_value_satoshis: value,
2545 user_channel_id: user_id,
2550 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
2551 let ((funding_msg, monitor), mut chan) = {
2552 let best_block = *self.best_block.read().unwrap();
2553 let mut channel_lock = self.channel_state.lock().unwrap();
2554 let channel_state = &mut *channel_lock;
2555 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
2556 hash_map::Entry::Occupied(mut chan) => {
2557 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2558 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
2560 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
2562 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
2565 // Because we have exclusive ownership of the channel here we can release the channel_state
2566 // lock before watch_channel
2567 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
2569 ChannelMonitorUpdateErr::PermanentFailure => {
2570 // Note that we reply with the new channel_id in error messages if we gave up on the
2571 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
2572 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
2573 // any messages referencing a previously-closed channel anyway.
2574 // We do not do a force-close here as that would generate a monitor update for
2575 // a monitor that we didn't manage to store (and that we don't care about - we
2576 // don't respond with the funding_signed so the channel can never go on chain).
2577 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
2578 assert!(failed_htlcs.is_empty());
2579 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
2581 ChannelMonitorUpdateErr::TemporaryFailure => {
2582 // There's no problem signing a counterparty's funding transaction if our monitor
2583 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
2584 // accepted payment from yet. We do, however, need to wait to send our funding_locked
2585 // until we have persisted our monitor.
2586 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
2590 let mut channel_state_lock = self.channel_state.lock().unwrap();
2591 let channel_state = &mut *channel_state_lock;
2592 match channel_state.by_id.entry(funding_msg.channel_id) {
2593 hash_map::Entry::Occupied(_) => {
2594 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
2596 hash_map::Entry::Vacant(e) => {
2597 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
2598 node_id: counterparty_node_id.clone(),
2607 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
2609 let best_block = *self.best_block.read().unwrap();
2610 let mut channel_lock = self.channel_state.lock().unwrap();
2611 let channel_state = &mut *channel_lock;
2612 match channel_state.by_id.entry(msg.channel_id) {
2613 hash_map::Entry::Occupied(mut chan) => {
2614 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2615 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2617 let (monitor, funding_tx) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
2618 Ok(update) => update,
2619 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
2621 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
2622 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2626 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2629 self.tx_broadcaster.broadcast_transaction(&funding_tx);
2633 fn internal_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2634 let mut channel_state_lock = self.channel_state.lock().unwrap();
2635 let channel_state = &mut *channel_state_lock;
2636 match channel_state.by_id.entry(msg.channel_id) {
2637 hash_map::Entry::Occupied(mut chan) => {
2638 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2639 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2641 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2642 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2643 log_trace!(self.logger, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
2644 // If we see locking block before receiving remote funding_locked, we broadcast our
2645 // announcement_sigs at remote funding_locked reception. If we receive remote
2646 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2647 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2648 // the order of the events but our peer may not receive it due to disconnection. The specs
2649 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2650 // connection in the future if simultaneous misses by both peers due to network/hardware
2651 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2652 // to be received, from then sigs are going to be flood to the whole network.
2653 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2654 node_id: counterparty_node_id.clone(),
2655 msg: announcement_sigs,
2660 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2664 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2665 let (mut dropped_htlcs, chan_option) = {
2666 let mut channel_state_lock = self.channel_state.lock().unwrap();
2667 let channel_state = &mut *channel_state_lock;
2669 match channel_state.by_id.entry(msg.channel_id.clone()) {
2670 hash_map::Entry::Occupied(mut chan_entry) => {
2671 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
2672 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2674 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);
2675 if let Some(msg) = shutdown {
2676 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2677 node_id: counterparty_node_id.clone(),
2681 if let Some(msg) = closing_signed {
2682 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2683 node_id: counterparty_node_id.clone(),
2687 if chan_entry.get().is_shutdown() {
2688 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2689 channel_state.short_to_id.remove(&short_id);
2691 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2692 } else { (dropped_htlcs, None) }
2694 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2697 for htlc_source in dropped_htlcs.drain(..) {
2698 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() });
2700 if let Some(chan) = chan_option {
2701 if let Ok(update) = self.get_channel_update(&chan) {
2702 let mut channel_state = self.channel_state.lock().unwrap();
2703 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2711 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2712 let (tx, chan_option) = {
2713 let mut channel_state_lock = self.channel_state.lock().unwrap();
2714 let channel_state = &mut *channel_state_lock;
2715 match channel_state.by_id.entry(msg.channel_id.clone()) {
2716 hash_map::Entry::Occupied(mut chan_entry) => {
2717 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
2718 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2720 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
2721 if let Some(msg) = closing_signed {
2722 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2723 node_id: counterparty_node_id.clone(),
2728 // We're done with this channel, we've got a signed closing transaction and
2729 // will send the closing_signed back to the remote peer upon return. This
2730 // also implies there are no pending HTLCs left on the channel, so we can
2731 // fully delete it from tracking (the channel monitor is still around to
2732 // watch for old state broadcasts)!
2733 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2734 channel_state.short_to_id.remove(&short_id);
2736 (tx, Some(chan_entry.remove_entry().1))
2737 } else { (tx, None) }
2739 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2742 if let Some(broadcast_tx) = tx {
2743 log_trace!(self.logger, "Broadcast onchain {}", log_tx!(broadcast_tx));
2744 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2746 if let Some(chan) = chan_option {
2747 if let Ok(update) = self.get_channel_update(&chan) {
2748 let mut channel_state = self.channel_state.lock().unwrap();
2749 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2757 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2758 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2759 //determine the state of the payment based on our response/if we forward anything/the time
2760 //we take to respond. We should take care to avoid allowing such an attack.
2762 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2763 //us repeatedly garbled in different ways, and compare our error messages, which are
2764 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2765 //but we should prevent it anyway.
2767 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2768 let channel_state = &mut *channel_state_lock;
2770 match channel_state.by_id.entry(msg.channel_id) {
2771 hash_map::Entry::Occupied(mut chan) => {
2772 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2773 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2776 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
2777 // Ensure error_code has the UPDATE flag set, since by default we send a
2778 // channel update along as part of failing the HTLC.
2779 assert!((error_code & 0x1000) != 0);
2780 // If the update_add is completely bogus, the call will Err and we will close,
2781 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2782 // want to reject the new HTLC and fail it backwards instead of forwarding.
2783 match pending_forward_info {
2784 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
2785 let reason = if let Ok(upd) = self.get_channel_update(chan) {
2786 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &{
2787 let mut res = Vec::with_capacity(8 + 128);
2788 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
2789 res.extend_from_slice(&byte_utils::be16_to_array(0));
2790 res.extend_from_slice(&upd.encode_with_len()[..]);
2794 // The only case where we'd be unable to
2795 // successfully get a channel update is if the
2796 // channel isn't in the fully-funded state yet,
2797 // implying our counterparty is trying to route
2798 // payments over the channel back to themselves
2799 // (cause no one else should know the short_id
2800 // is a lightning channel yet). We should have
2801 // no problem just calling this
2802 // unknown_next_peer (0x4000|10).
2803 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, 0x4000|10, &[])
2805 let msg = msgs::UpdateFailHTLC {
2806 channel_id: msg.channel_id,
2807 htlc_id: msg.htlc_id,
2810 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
2812 _ => pending_forward_info
2815 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
2817 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2822 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2823 let mut channel_lock = self.channel_state.lock().unwrap();
2825 let channel_state = &mut *channel_lock;
2826 match channel_state.by_id.entry(msg.channel_id) {
2827 hash_map::Entry::Occupied(mut chan) => {
2828 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2829 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2831 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2833 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2836 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2840 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2841 let mut channel_lock = self.channel_state.lock().unwrap();
2842 let channel_state = &mut *channel_lock;
2843 match channel_state.by_id.entry(msg.channel_id) {
2844 hash_map::Entry::Occupied(mut chan) => {
2845 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2846 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2848 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2850 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2855 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2856 let mut channel_lock = self.channel_state.lock().unwrap();
2857 let channel_state = &mut *channel_lock;
2858 match channel_state.by_id.entry(msg.channel_id) {
2859 hash_map::Entry::Occupied(mut chan) => {
2860 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2861 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2863 if (msg.failure_code & 0x8000) == 0 {
2864 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
2865 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2867 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);
2870 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2874 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2875 let mut channel_state_lock = self.channel_state.lock().unwrap();
2876 let channel_state = &mut *channel_state_lock;
2877 match channel_state.by_id.entry(msg.channel_id) {
2878 hash_map::Entry::Occupied(mut chan) => {
2879 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2880 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2882 let (revoke_and_ack, commitment_signed, closing_signed, monitor_update) =
2883 match chan.get_mut().commitment_signed(&msg, &self.fee_estimator, &self.logger) {
2884 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
2885 Err((Some(update), e)) => {
2886 assert!(chan.get().is_awaiting_monitor_update());
2887 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
2888 try_chan_entry!(self, Err(e), channel_state, chan);
2893 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2894 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2895 //TODO: Rebroadcast closing_signed if present on monitor update restoration
2897 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2898 node_id: counterparty_node_id.clone(),
2899 msg: revoke_and_ack,
2901 if let Some(msg) = commitment_signed {
2902 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2903 node_id: counterparty_node_id.clone(),
2904 updates: msgs::CommitmentUpdate {
2905 update_add_htlcs: Vec::new(),
2906 update_fulfill_htlcs: Vec::new(),
2907 update_fail_htlcs: Vec::new(),
2908 update_fail_malformed_htlcs: Vec::new(),
2910 commitment_signed: msg,
2914 if let Some(msg) = closing_signed {
2915 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2916 node_id: counterparty_node_id.clone(),
2922 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2927 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
2928 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
2929 let mut forward_event = None;
2930 if !pending_forwards.is_empty() {
2931 let mut channel_state = self.channel_state.lock().unwrap();
2932 if channel_state.forward_htlcs.is_empty() {
2933 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2935 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2936 match channel_state.forward_htlcs.entry(match forward_info.routing {
2937 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
2938 PendingHTLCRouting::Receive { .. } => 0,
2940 hash_map::Entry::Occupied(mut entry) => {
2941 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
2942 prev_htlc_id, forward_info });
2944 hash_map::Entry::Vacant(entry) => {
2945 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
2946 prev_htlc_id, forward_info }));
2951 match forward_event {
2953 let mut pending_events = self.pending_events.lock().unwrap();
2954 pending_events.push(events::Event::PendingHTLCsForwardable {
2955 time_forwardable: time
2963 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2964 let mut htlcs_to_fail = Vec::new();
2966 let mut channel_state_lock = self.channel_state.lock().unwrap();
2967 let channel_state = &mut *channel_state_lock;
2968 match channel_state.by_id.entry(msg.channel_id) {
2969 hash_map::Entry::Occupied(mut chan) => {
2970 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2971 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2973 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2974 let (commitment_update, pending_forwards, pending_failures, closing_signed, monitor_update, htlcs_to_fail_in) =
2975 break_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger), channel_state, chan);
2976 htlcs_to_fail = htlcs_to_fail_in;
2977 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2978 if was_frozen_for_monitor {
2979 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2980 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
2982 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures) {
2984 } else { unreachable!(); }
2987 if let Some(updates) = commitment_update {
2988 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2989 node_id: counterparty_node_id.clone(),
2993 if let Some(msg) = closing_signed {
2994 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2995 node_id: counterparty_node_id.clone(),
2999 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()))
3001 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3004 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id);
3006 Ok((pending_forwards, mut pending_failures, short_channel_id, channel_outpoint)) => {
3007 for failure in pending_failures.drain(..) {
3008 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3010 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
3017 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
3018 let mut channel_lock = self.channel_state.lock().unwrap();
3019 let channel_state = &mut *channel_lock;
3020 match channel_state.by_id.entry(msg.channel_id) {
3021 hash_map::Entry::Occupied(mut chan) => {
3022 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3023 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3025 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
3027 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3032 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
3033 let mut channel_state_lock = self.channel_state.lock().unwrap();
3034 let channel_state = &mut *channel_state_lock;
3036 match channel_state.by_id.entry(msg.channel_id) {
3037 hash_map::Entry::Occupied(mut chan) => {
3038 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3039 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3041 if !chan.get().is_usable() {
3042 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
3045 let our_node_id = self.get_our_node_id();
3046 let (announcement, our_bitcoin_sig) =
3047 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
3049 let were_node_one = announcement.node_id_1 == our_node_id;
3050 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
3052 let their_node_key = if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 };
3053 let their_bitcoin_key = if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 };
3054 match (self.secp_ctx.verify(&msghash, &msg.node_signature, their_node_key),
3055 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, their_bitcoin_key)) {
3057 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));
3058 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3061 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));
3062 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3068 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
3070 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
3071 msg: msgs::ChannelAnnouncement {
3072 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
3073 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
3074 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
3075 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
3076 contents: announcement,
3078 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
3081 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3086 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<(), MsgHandleErrInternal> {
3087 let mut channel_state_lock = self.channel_state.lock().unwrap();
3088 let channel_state = &mut *channel_state_lock;
3089 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
3090 Some(chan_id) => chan_id.clone(),
3092 // It's not a local channel
3096 match channel_state.by_id.entry(chan_id) {
3097 hash_map::Entry::Occupied(mut chan) => {
3098 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3099 // TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
3100 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), chan_id));
3102 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
3104 hash_map::Entry::Vacant(_) => unreachable!()
3109 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
3110 let mut channel_state_lock = self.channel_state.lock().unwrap();
3111 let channel_state = &mut *channel_state_lock;
3113 match channel_state.by_id.entry(msg.channel_id) {
3114 hash_map::Entry::Occupied(mut chan) => {
3115 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3116 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3118 // Currently, we expect all holding cell update_adds to be dropped on peer
3119 // disconnect, so Channel's reestablish will never hand us any holding cell
3120 // freed HTLCs to fail backwards. If in the future we no longer drop pending
3121 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
3122 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, mut order, shutdown) =
3123 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg, &self.logger), channel_state, chan);
3124 if let Some(monitor_update) = monitor_update_opt {
3125 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3126 // channel_reestablish doesn't guarantee the order it returns is sensical
3127 // for the messages it returns, but if we're setting what messages to
3128 // re-transmit on monitor update success, we need to make sure it is sane.
3129 if revoke_and_ack.is_none() {
3130 order = RAACommitmentOrder::CommitmentFirst;
3132 if commitment_update.is_none() {
3133 order = RAACommitmentOrder::RevokeAndACKFirst;
3135 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
3136 //TODO: Resend the funding_locked if needed once we get the monitor running again
3139 if let Some(msg) = funding_locked {
3140 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
3141 node_id: counterparty_node_id.clone(),
3145 macro_rules! send_raa { () => {
3146 if let Some(msg) = revoke_and_ack {
3147 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
3148 node_id: counterparty_node_id.clone(),
3153 macro_rules! send_cu { () => {
3154 if let Some(updates) = commitment_update {
3155 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3156 node_id: counterparty_node_id.clone(),
3162 RAACommitmentOrder::RevokeAndACKFirst => {
3166 RAACommitmentOrder::CommitmentFirst => {
3171 if let Some(msg) = shutdown {
3172 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3173 node_id: counterparty_node_id.clone(),
3179 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3183 /// Begin Update fee process. Allowed only on an outbound channel.
3184 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
3185 /// PeerManager::process_events afterwards.
3186 /// Note: This API is likely to change!
3187 /// (C-not exported) Cause its doc(hidden) anyway
3189 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u32) -> Result<(), APIError> {
3190 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3191 let counterparty_node_id;
3192 let err: Result<(), _> = loop {
3193 let mut channel_state_lock = self.channel_state.lock().unwrap();
3194 let channel_state = &mut *channel_state_lock;
3196 match channel_state.by_id.entry(channel_id) {
3197 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: format!("Failed to find corresponding channel for id {}", channel_id.to_hex())}),
3198 hash_map::Entry::Occupied(mut chan) => {
3199 if !chan.get().is_outbound() {
3200 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel".to_owned()});
3202 if chan.get().is_awaiting_monitor_update() {
3203 return Err(APIError::MonitorUpdateFailed);
3205 if !chan.get().is_live() {
3206 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected".to_owned()});
3208 counterparty_node_id = chan.get().get_counterparty_node_id();
3209 if let Some((update_fee, commitment_signed, monitor_update)) =
3210 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw, &self.logger), channel_state, chan)
3212 if let Err(_e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3215 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3216 node_id: chan.get().get_counterparty_node_id(),
3217 updates: msgs::CommitmentUpdate {
3218 update_add_htlcs: Vec::new(),
3219 update_fulfill_htlcs: Vec::new(),
3220 update_fail_htlcs: Vec::new(),
3221 update_fail_malformed_htlcs: Vec::new(),
3222 update_fee: Some(update_fee),
3232 match handle_error!(self, err, counterparty_node_id) {
3233 Ok(_) => unreachable!(),
3234 Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
3238 /// Process pending events from the `chain::Watch`.
3239 fn process_pending_monitor_events(&self) {
3240 let mut failed_channels = Vec::new();
3242 for monitor_event in self.chain_monitor.release_pending_monitor_events() {
3243 match monitor_event {
3244 MonitorEvent::HTLCEvent(htlc_update) => {
3245 if let Some(preimage) = htlc_update.payment_preimage {
3246 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
3247 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
3249 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
3250 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() });
3253 MonitorEvent::CommitmentTxBroadcasted(funding_outpoint) => {
3254 let mut channel_lock = self.channel_state.lock().unwrap();
3255 let channel_state = &mut *channel_lock;
3256 let by_id = &mut channel_state.by_id;
3257 let short_to_id = &mut channel_state.short_to_id;
3258 let pending_msg_events = &mut channel_state.pending_msg_events;
3259 if let Some(mut chan) = by_id.remove(&funding_outpoint.to_channel_id()) {
3260 if let Some(short_id) = chan.get_short_channel_id() {
3261 short_to_id.remove(&short_id);
3263 failed_channels.push(chan.force_shutdown(false));
3264 if let Ok(update) = self.get_channel_update(&chan) {
3265 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3269 pending_msg_events.push(events::MessageSendEvent::HandleError {
3270 node_id: chan.get_counterparty_node_id(),
3271 action: msgs::ErrorAction::SendErrorMessage {
3272 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
3281 for failure in failed_channels.drain(..) {
3282 self.finish_force_close_channel(failure);
3286 /// Handle a list of channel failures during a block_connected or block_disconnected call,
3287 /// pushing the channel monitor update (if any) to the background events queue and removing the
3289 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
3290 for mut failure in failed_channels.drain(..) {
3291 // Either a commitment transactions has been confirmed on-chain or
3292 // Channel::block_disconnected detected that the funding transaction has been
3293 // reorganized out of the main chain.
3294 // We cannot broadcast our latest local state via monitor update (as
3295 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
3296 // so we track the update internally and handle it when the user next calls
3297 // timer_tick_occurred, guaranteeing we're running normally.
3298 if let Some((funding_txo, update)) = failure.0.take() {
3299 assert_eq!(update.updates.len(), 1);
3300 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
3301 assert!(should_broadcast);
3302 } else { unreachable!(); }
3303 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
3305 self.finish_force_close_channel(failure);
3310 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
3311 where M::Target: chain::Watch<Signer>,
3312 T::Target: BroadcasterInterface,
3313 K::Target: KeysInterface<Signer = Signer>,
3314 F::Target: FeeEstimator,
3317 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
3318 //TODO: This behavior should be documented. It's non-intuitive that we query
3319 // ChannelMonitors when clearing other events.
3320 self.process_pending_monitor_events();
3322 let mut ret = Vec::new();
3323 let mut channel_state = self.channel_state.lock().unwrap();
3324 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
3329 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
3330 where M::Target: chain::Watch<Signer>,
3331 T::Target: BroadcasterInterface,
3332 K::Target: KeysInterface<Signer = Signer>,
3333 F::Target: FeeEstimator,
3336 fn get_and_clear_pending_events(&self) -> Vec<Event> {
3337 //TODO: This behavior should be documented. It's non-intuitive that we query
3338 // ChannelMonitors when clearing other events.
3339 self.process_pending_monitor_events();
3341 let mut ret = Vec::new();
3342 let mut pending_events = self.pending_events.lock().unwrap();
3343 mem::swap(&mut ret, &mut *pending_events);
3348 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
3350 M::Target: chain::Watch<Signer>,
3351 T::Target: BroadcasterInterface,
3352 K::Target: KeysInterface<Signer = Signer>,
3353 F::Target: FeeEstimator,
3356 fn block_connected(&self, block: &Block, height: u32) {
3358 let best_block = self.best_block.read().unwrap();
3359 assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
3360 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
3361 assert_eq!(best_block.height(), height - 1,
3362 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
3365 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
3366 self.transactions_confirmed(&block.header, height, &txdata);
3367 self.update_best_block(&block.header, height);
3370 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
3371 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3372 let new_height = height - 1;
3374 let mut best_block = self.best_block.write().unwrap();
3375 assert_eq!(best_block.block_hash(), header.block_hash(),
3376 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
3377 assert_eq!(best_block.height(), height,
3378 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
3379 *best_block = BestBlock::new(header.prev_blockhash, new_height)
3382 self.do_chain_event(Some(new_height), |channel| channel.update_best_block(new_height, header.time));
3386 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
3387 where M::Target: chain::Watch<Signer>,
3388 T::Target: BroadcasterInterface,
3389 K::Target: KeysInterface<Signer = Signer>,
3390 F::Target: FeeEstimator,
3393 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
3394 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
3396 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage>>
3397 (&self, height_opt: Option<u32>, f: FN) {
3398 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3399 // during initialization prior to the chain_monitor being fully configured in some cases.
3400 // See the docs for `ChannelManagerReadArgs` for more.
3402 let mut failed_channels = Vec::new();
3403 let mut timed_out_htlcs = Vec::new();
3405 let mut channel_lock = self.channel_state.lock().unwrap();
3406 let channel_state = &mut *channel_lock;
3407 let short_to_id = &mut channel_state.short_to_id;
3408 let pending_msg_events = &mut channel_state.pending_msg_events;
3409 channel_state.by_id.retain(|_, channel| {
3410 let res = f(channel);
3411 if let Ok((chan_res, mut timed_out_pending_htlcs)) = res {
3412 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
3413 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
3414 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
3415 failure_code: 0x1000 | 14, // expiry_too_soon, or at least it is now
3419 if let Some(funding_locked) = chan_res {
3420 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
3421 node_id: channel.get_counterparty_node_id(),
3422 msg: funding_locked,
3424 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
3425 log_trace!(self.logger, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
3426 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3427 node_id: channel.get_counterparty_node_id(),
3428 msg: announcement_sigs,
3431 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
3433 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
3435 } else if let Err(e) = res {
3436 if let Some(short_id) = channel.get_short_channel_id() {
3437 short_to_id.remove(&short_id);
3439 // It looks like our counterparty went on-chain or funding transaction was
3440 // reorged out of the main chain. Close the channel.
3441 failed_channels.push(channel.force_shutdown(true));
3442 if let Ok(update) = self.get_channel_update(&channel) {
3443 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3447 pending_msg_events.push(events::MessageSendEvent::HandleError {
3448 node_id: channel.get_counterparty_node_id(),
3449 action: msgs::ErrorAction::SendErrorMessage { msg: e },
3456 if let Some(height) = height_opt {
3457 channel_state.claimable_htlcs.retain(|&(ref payment_hash, _), htlcs| {
3458 htlcs.retain(|htlc| {
3459 // If height is approaching the number of blocks we think it takes us to get
3460 // our commitment transaction confirmed before the HTLC expires, plus the
3461 // number of blocks we generally consider it to take to do a commitment update,
3462 // just give up on it and fail the HTLC.
3463 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
3464 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3465 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
3466 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
3467 failure_code: 0x4000 | 15,
3468 data: htlc_msat_height_data
3473 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
3478 self.handle_init_event_channel_failures(failed_channels);
3480 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
3481 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
3485 /// Updates channel state to take note of transactions which were confirmed in the given block
3486 /// at the given height.
3488 /// Note that you must still call (or have called) [`update_best_block`] with the block
3489 /// information which is included here.
3491 /// This method may be called before or after [`update_best_block`] for a given block's
3492 /// transaction data and may be called multiple times with additional transaction data for a
3495 /// This method may be called for a previous block after an [`update_best_block`] call has
3496 /// been made for a later block, however it must *not* be called with transaction data from a
3497 /// block which is no longer in the best chain (ie where [`update_best_block`] has already
3498 /// been informed about a blockchain reorganization which no longer includes the block which
3499 /// corresponds to `header`).
3501 /// [`update_best_block`]: `Self::update_best_block`
3502 pub fn transactions_confirmed(&self, header: &BlockHeader, height: u32, txdata: &TransactionData) {
3503 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3504 // during initialization prior to the chain_monitor being fully configured in some cases.
3505 // See the docs for `ChannelManagerReadArgs` for more.
3507 let block_hash = header.block_hash();
3508 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
3510 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3511 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, &self.logger).map(|a| (a, Vec::new())));
3514 /// Updates channel state with the current best blockchain tip. You should attempt to call this
3515 /// quickly after a new block becomes available, however if multiple new blocks become
3516 /// available at the same time, only a single `update_best_block()` call needs to be made.
3518 /// This method should also be called immediately after any block disconnections, once at the
3519 /// reorganization fork point, and once with the new chain tip. Calling this method at the
3520 /// blockchain reorganization fork point ensures we learn when a funding transaction which was
3521 /// previously confirmed is reorganized out of the blockchain, ensuring we do not continue to
3522 /// accept payments which cannot be enforced on-chain.
3524 /// In both the block-connection and block-disconnection case, this method may be called either
3525 /// once per block connected or disconnected, or simply at the fork point and new tip(s),
3526 /// skipping any intermediary blocks.
3527 pub fn update_best_block(&self, header: &BlockHeader, height: u32) {
3528 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3529 // during initialization prior to the chain_monitor being fully configured in some cases.
3530 // See the docs for `ChannelManagerReadArgs` for more.
3532 let block_hash = header.block_hash();
3533 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
3535 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3537 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
3539 self.do_chain_event(Some(height), |channel| channel.update_best_block(height, header.time));
3542 // Update last_node_announcement_serial to be the max of its current value and the
3543 // block timestamp. This should keep us close to the current time without relying on
3544 // having an explicit local time source.
3545 // Just in case we end up in a race, we loop until we either successfully update
3546 // last_node_announcement_serial or decide we don't need to.
3547 let old_serial = self.last_node_announcement_serial.load(Ordering::Acquire);
3548 if old_serial >= header.time as usize { break; }
3549 if self.last_node_announcement_serial.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
3555 /// Gets the set of txids which should be monitored for their confirmation state.
3557 /// If you're providing information about reorganizations via [`transaction_unconfirmed`], this
3558 /// is the set of transactions which you may need to call [`transaction_unconfirmed`] for.
3560 /// This may be useful to poll to determine the set of transactions which must be registered
3561 /// with an Electrum server or for which an Electrum server needs to be polled to determine
3562 /// transaction confirmation state.
3564 /// This may update after any [`transactions_confirmed`] or [`block_connected`] call.
3566 /// Note that this is NOT the set of transactions which must be included in calls to
3567 /// [`transactions_confirmed`] if they are confirmed, but a small subset of it.
3569 /// [`transactions_confirmed`]: Self::transactions_confirmed
3570 /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
3571 /// [`block_connected`]: chain::Listen::block_connected
3572 pub fn get_relevant_txids(&self) -> Vec<Txid> {
3573 let channel_state = self.channel_state.lock().unwrap();
3574 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
3575 for chan in channel_state.by_id.values() {
3576 if let Some(funding_txo) = chan.get_funding_txo() {
3577 res.push(funding_txo.txid);
3583 /// Marks a transaction as having been reorganized out of the blockchain.
3585 /// If a transaction is included in [`get_relevant_txids`], and is no longer in the main branch
3586 /// of the blockchain, this function should be called to indicate that the transaction should
3587 /// be considered reorganized out.
3589 /// Once this is called, the given transaction will no longer appear on [`get_relevant_txids`],
3590 /// though this may be called repeatedly for a given transaction without issue.
3592 /// Note that if the transaction is confirmed on the main chain in a different block (indicated
3593 /// via a call to [`transactions_confirmed`]), it may re-appear in [`get_relevant_txids`], thus
3594 /// be very wary of race-conditions wherein the final state of a transaction indicated via
3595 /// these APIs is not the same as its state on the blockchain.
3597 /// [`transactions_confirmed`]: Self::transactions_confirmed
3598 /// [`get_relevant_txids`]: Self::get_relevant_txids
3599 pub fn transaction_unconfirmed(&self, txid: &Txid) {
3600 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3601 self.do_chain_event(None, |channel| {
3602 if let Some(funding_txo) = channel.get_funding_txo() {
3603 if funding_txo.txid == *txid {
3604 channel.funding_transaction_unconfirmed().map(|_| (None, Vec::new()))
3605 } else { Ok((None, Vec::new())) }
3606 } else { Ok((None, Vec::new())) }
3610 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
3611 /// indicating whether persistence is necessary. Only one listener on
3612 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
3614 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
3615 #[cfg(any(test, feature = "allow_wallclock_use"))]
3616 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
3617 self.persistence_notifier.wait_timeout(max_wait)
3620 /// Blocks until ChannelManager needs to be persisted. Only one listener on
3621 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
3623 pub fn await_persistable_update(&self) {
3624 self.persistence_notifier.wait()
3627 #[cfg(any(test, feature = "_test_utils"))]
3628 pub fn get_persistence_condvar_value(&self) -> bool {
3629 let mutcond = &self.persistence_notifier.persistence_lock;
3630 let &(ref mtx, _) = mutcond;
3631 let guard = mtx.lock().unwrap();
3636 impl<Signer: Sign, M: Deref + Sync + Send, T: Deref + Sync + Send, K: Deref + Sync + Send, F: Deref + Sync + Send, L: Deref + Sync + Send>
3637 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
3638 where M::Target: chain::Watch<Signer>,
3639 T::Target: BroadcasterInterface,
3640 K::Target: KeysInterface<Signer = Signer>,
3641 F::Target: FeeEstimator,
3644 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
3645 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3646 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
3649 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
3650 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3651 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
3654 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
3655 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3656 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
3659 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
3660 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3661 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
3664 fn handle_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) {
3665 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3666 let _ = handle_error!(self, self.internal_funding_locked(counterparty_node_id, msg), *counterparty_node_id);
3669 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
3670 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3671 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
3674 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
3675 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3676 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
3679 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
3680 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3681 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
3684 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
3685 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3686 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
3689 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
3690 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3691 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
3694 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
3695 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3696 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
3699 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
3700 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3701 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
3704 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
3705 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3706 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
3709 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
3710 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3711 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
3714 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
3715 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3716 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
3719 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
3720 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3721 let _ = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id);
3724 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
3725 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3726 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
3729 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
3730 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3731 let mut failed_channels = Vec::new();
3732 let mut failed_payments = Vec::new();
3733 let mut no_channels_remain = true;
3735 let mut channel_state_lock = self.channel_state.lock().unwrap();
3736 let channel_state = &mut *channel_state_lock;
3737 let short_to_id = &mut channel_state.short_to_id;
3738 let pending_msg_events = &mut channel_state.pending_msg_events;
3739 if no_connection_possible {
3740 log_debug!(self.logger, "Failing all channels with {} due to no_connection_possible", log_pubkey!(counterparty_node_id));
3741 channel_state.by_id.retain(|_, chan| {
3742 if chan.get_counterparty_node_id() == *counterparty_node_id {
3743 if let Some(short_id) = chan.get_short_channel_id() {
3744 short_to_id.remove(&short_id);
3746 failed_channels.push(chan.force_shutdown(true));
3747 if let Ok(update) = self.get_channel_update(&chan) {
3748 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3758 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(counterparty_node_id));
3759 channel_state.by_id.retain(|_, chan| {
3760 if chan.get_counterparty_node_id() == *counterparty_node_id {
3761 // Note that currently on channel reestablish we assert that there are no
3762 // holding cell add-HTLCs, so if in the future we stop removing uncommitted HTLCs
3763 // on peer disconnect here, there will need to be corresponding changes in
3764 // reestablish logic.
3765 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
3766 chan.to_disabled_marked();
3767 if !failed_adds.is_empty() {
3768 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
3769 failed_payments.push((chan_update, failed_adds));
3771 if chan.is_shutdown() {
3772 if let Some(short_id) = chan.get_short_channel_id() {
3773 short_to_id.remove(&short_id);
3777 no_channels_remain = false;
3783 pending_msg_events.retain(|msg| {
3785 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
3786 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
3787 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
3788 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
3789 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != counterparty_node_id,
3790 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
3791 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
3792 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
3793 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
3794 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
3795 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
3796 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
3797 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
3798 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
3799 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
3800 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
3801 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
3802 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
3803 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
3807 if no_channels_remain {
3808 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
3811 for failure in failed_channels.drain(..) {
3812 self.finish_force_close_channel(failure);
3814 for (chan_update, mut htlc_sources) in failed_payments {
3815 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
3816 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
3821 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
3822 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
3824 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3827 let mut peer_state_lock = self.per_peer_state.write().unwrap();
3828 match peer_state_lock.entry(counterparty_node_id.clone()) {
3829 hash_map::Entry::Vacant(e) => {
3830 e.insert(Mutex::new(PeerState {
3831 latest_features: init_msg.features.clone(),
3834 hash_map::Entry::Occupied(e) => {
3835 e.get().lock().unwrap().latest_features = init_msg.features.clone();
3840 let mut channel_state_lock = self.channel_state.lock().unwrap();
3841 let channel_state = &mut *channel_state_lock;
3842 let pending_msg_events = &mut channel_state.pending_msg_events;
3843 channel_state.by_id.retain(|_, chan| {
3844 if chan.get_counterparty_node_id() == *counterparty_node_id {
3845 if !chan.have_received_message() {
3846 // If we created this (outbound) channel while we were disconnected from the
3847 // peer we probably failed to send the open_channel message, which is now
3848 // lost. We can't have had anything pending related to this channel, so we just
3852 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
3853 node_id: chan.get_counterparty_node_id(),
3854 msg: chan.get_channel_reestablish(&self.logger),
3860 //TODO: Also re-broadcast announcement_signatures
3863 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
3864 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3866 if msg.channel_id == [0; 32] {
3867 for chan in self.list_channels() {
3868 if chan.remote_network_id == *counterparty_node_id {
3869 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
3870 let _ = self.force_close_channel_with_peer(&chan.channel_id, Some(counterparty_node_id));
3874 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
3875 let _ = self.force_close_channel_with_peer(&msg.channel_id, Some(counterparty_node_id));
3880 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
3881 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
3882 struct PersistenceNotifier {
3883 /// Users won't access the persistence_lock directly, but rather wait on its bool using
3884 /// `wait_timeout` and `wait`.
3885 persistence_lock: (Mutex<bool>, Condvar),
3888 impl PersistenceNotifier {
3891 persistence_lock: (Mutex::new(false), Condvar::new()),
3897 let &(ref mtx, ref cvar) = &self.persistence_lock;
3898 let mut guard = mtx.lock().unwrap();
3899 guard = cvar.wait(guard).unwrap();
3900 let result = *guard;
3908 #[cfg(any(test, feature = "allow_wallclock_use"))]
3909 fn wait_timeout(&self, max_wait: Duration) -> bool {
3910 let current_time = Instant::now();
3912 let &(ref mtx, ref cvar) = &self.persistence_lock;
3913 let mut guard = mtx.lock().unwrap();
3914 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
3915 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
3916 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
3917 // time. Note that this logic can be highly simplified through the use of
3918 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
3920 let elapsed = current_time.elapsed();
3921 let result = *guard;
3922 if result || elapsed >= max_wait {
3926 match max_wait.checked_sub(elapsed) {
3927 None => return result,
3933 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
3935 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
3936 let mut persistence_lock = persist_mtx.lock().unwrap();
3937 *persistence_lock = true;
3938 mem::drop(persistence_lock);
3943 const SERIALIZATION_VERSION: u8 = 1;
3944 const MIN_SERIALIZATION_VERSION: u8 = 1;
3946 impl Writeable for PendingHTLCInfo {
3947 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3948 match &self.routing {
3949 &PendingHTLCRouting::Forward { ref onion_packet, ref short_channel_id } => {
3951 onion_packet.write(writer)?;
3952 short_channel_id.write(writer)?;
3954 &PendingHTLCRouting::Receive { ref payment_data, ref incoming_cltv_expiry } => {
3956 payment_data.write(writer)?;
3957 incoming_cltv_expiry.write(writer)?;
3960 self.incoming_shared_secret.write(writer)?;
3961 self.payment_hash.write(writer)?;
3962 self.amt_to_forward.write(writer)?;
3963 self.outgoing_cltv_value.write(writer)?;
3968 impl Readable for PendingHTLCInfo {
3969 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
3970 Ok(PendingHTLCInfo {
3971 routing: match Readable::read(reader)? {
3972 0u8 => PendingHTLCRouting::Forward {
3973 onion_packet: Readable::read(reader)?,
3974 short_channel_id: Readable::read(reader)?,
3976 1u8 => PendingHTLCRouting::Receive {
3977 payment_data: Readable::read(reader)?,
3978 incoming_cltv_expiry: Readable::read(reader)?,
3980 _ => return Err(DecodeError::InvalidValue),
3982 incoming_shared_secret: Readable::read(reader)?,
3983 payment_hash: Readable::read(reader)?,
3984 amt_to_forward: Readable::read(reader)?,
3985 outgoing_cltv_value: Readable::read(reader)?,
3990 impl Writeable for HTLCFailureMsg {
3991 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3993 &HTLCFailureMsg::Relay(ref fail_msg) => {
3995 fail_msg.write(writer)?;
3997 &HTLCFailureMsg::Malformed(ref fail_msg) => {
3999 fail_msg.write(writer)?;
4006 impl Readable for HTLCFailureMsg {
4007 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
4008 match <u8 as Readable>::read(reader)? {
4009 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
4010 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
4011 _ => Err(DecodeError::InvalidValue),
4016 impl Writeable for PendingHTLCStatus {
4017 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4019 &PendingHTLCStatus::Forward(ref forward_info) => {
4021 forward_info.write(writer)?;
4023 &PendingHTLCStatus::Fail(ref fail_msg) => {
4025 fail_msg.write(writer)?;
4032 impl Readable for PendingHTLCStatus {
4033 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
4034 match <u8 as Readable>::read(reader)? {
4035 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
4036 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
4037 _ => Err(DecodeError::InvalidValue),
4042 impl_writeable!(HTLCPreviousHopData, 0, {
4046 incoming_packet_shared_secret
4049 impl_writeable!(ClaimableHTLC, 0, {
4056 impl Writeable for HTLCSource {
4057 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4059 &HTLCSource::PreviousHopData(ref hop_data) => {
4061 hop_data.write(writer)?;
4063 &HTLCSource::OutboundRoute { ref path, ref session_priv, ref first_hop_htlc_msat } => {
4065 path.write(writer)?;
4066 session_priv.write(writer)?;
4067 first_hop_htlc_msat.write(writer)?;
4074 impl Readable for HTLCSource {
4075 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCSource, DecodeError> {
4076 match <u8 as Readable>::read(reader)? {
4077 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
4078 1 => Ok(HTLCSource::OutboundRoute {
4079 path: Readable::read(reader)?,
4080 session_priv: Readable::read(reader)?,
4081 first_hop_htlc_msat: Readable::read(reader)?,
4083 _ => Err(DecodeError::InvalidValue),
4088 impl Writeable for HTLCFailReason {
4089 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4091 &HTLCFailReason::LightningError { ref err } => {
4095 &HTLCFailReason::Reason { ref failure_code, ref data } => {
4097 failure_code.write(writer)?;
4098 data.write(writer)?;
4105 impl Readable for HTLCFailReason {
4106 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
4107 match <u8 as Readable>::read(reader)? {
4108 0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
4109 1 => Ok(HTLCFailReason::Reason {
4110 failure_code: Readable::read(reader)?,
4111 data: Readable::read(reader)?,
4113 _ => Err(DecodeError::InvalidValue),
4118 impl Writeable for HTLCForwardInfo {
4119 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4121 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_funding_outpoint, ref prev_htlc_id, ref forward_info } => {
4123 prev_short_channel_id.write(writer)?;
4124 prev_funding_outpoint.write(writer)?;
4125 prev_htlc_id.write(writer)?;
4126 forward_info.write(writer)?;
4128 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
4130 htlc_id.write(writer)?;
4131 err_packet.write(writer)?;
4138 impl Readable for HTLCForwardInfo {
4139 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
4140 match <u8 as Readable>::read(reader)? {
4141 0 => Ok(HTLCForwardInfo::AddHTLC {
4142 prev_short_channel_id: Readable::read(reader)?,
4143 prev_funding_outpoint: Readable::read(reader)?,
4144 prev_htlc_id: Readable::read(reader)?,
4145 forward_info: Readable::read(reader)?,
4147 1 => Ok(HTLCForwardInfo::FailHTLC {
4148 htlc_id: Readable::read(reader)?,
4149 err_packet: Readable::read(reader)?,
4151 _ => Err(DecodeError::InvalidValue),
4156 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
4157 where M::Target: chain::Watch<Signer>,
4158 T::Target: BroadcasterInterface,
4159 K::Target: KeysInterface<Signer = Signer>,
4160 F::Target: FeeEstimator,
4163 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4164 let _consistency_lock = self.total_consistency_lock.write().unwrap();
4166 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
4167 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
4169 self.genesis_hash.write(writer)?;
4171 let best_block = self.best_block.read().unwrap();
4172 best_block.height().write(writer)?;
4173 best_block.block_hash().write(writer)?;
4176 let channel_state = self.channel_state.lock().unwrap();
4177 let mut unfunded_channels = 0;
4178 for (_, channel) in channel_state.by_id.iter() {
4179 if !channel.is_funding_initiated() {
4180 unfunded_channels += 1;
4183 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
4184 for (_, channel) in channel_state.by_id.iter() {
4185 if channel.is_funding_initiated() {
4186 channel.write(writer)?;
4190 (channel_state.forward_htlcs.len() as u64).write(writer)?;
4191 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
4192 short_channel_id.write(writer)?;
4193 (pending_forwards.len() as u64).write(writer)?;
4194 for forward in pending_forwards {
4195 forward.write(writer)?;
4199 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
4200 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
4201 payment_hash.write(writer)?;
4202 (previous_hops.len() as u64).write(writer)?;
4203 for htlc in previous_hops.iter() {
4204 htlc.write(writer)?;
4208 let per_peer_state = self.per_peer_state.write().unwrap();
4209 (per_peer_state.len() as u64).write(writer)?;
4210 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
4211 peer_pubkey.write(writer)?;
4212 let peer_state = peer_state_mutex.lock().unwrap();
4213 peer_state.latest_features.write(writer)?;
4216 let events = self.pending_events.lock().unwrap();
4217 (events.len() as u64).write(writer)?;
4218 for event in events.iter() {
4219 event.write(writer)?;
4222 let background_events = self.pending_background_events.lock().unwrap();
4223 (background_events.len() as u64).write(writer)?;
4224 for event in background_events.iter() {
4226 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
4228 funding_txo.write(writer)?;
4229 monitor_update.write(writer)?;
4234 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
4240 /// Arguments for the creation of a ChannelManager that are not deserialized.
4242 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
4244 /// 1) Deserialize all stored ChannelMonitors.
4245 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
4246 /// <(BlockHash, ChannelManager)>::read(reader, args)
4247 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
4248 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
4249 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
4250 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
4251 /// ChannelMonitor::get_funding_txo().
4252 /// 4) Reconnect blocks on your ChannelMonitors.
4253 /// 5) Disconnect/connect blocks on the ChannelManager.
4254 /// 6) Move the ChannelMonitors into your local chain::Watch.
4256 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
4257 /// call any other methods on the newly-deserialized ChannelManager.
4259 /// Note that because some channels may be closed during deserialization, it is critical that you
4260 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
4261 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
4262 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
4263 /// not force-close the same channels but consider them live), you may end up revoking a state for
4264 /// which you've already broadcasted the transaction.
4265 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4266 where M::Target: chain::Watch<Signer>,
4267 T::Target: BroadcasterInterface,
4268 K::Target: KeysInterface<Signer = Signer>,
4269 F::Target: FeeEstimator,
4272 /// The keys provider which will give us relevant keys. Some keys will be loaded during
4273 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
4275 pub keys_manager: K,
4277 /// The fee_estimator for use in the ChannelManager in the future.
4279 /// No calls to the FeeEstimator will be made during deserialization.
4280 pub fee_estimator: F,
4281 /// The chain::Watch for use in the ChannelManager in the future.
4283 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
4284 /// you have deserialized ChannelMonitors separately and will add them to your
4285 /// chain::Watch after deserializing this ChannelManager.
4286 pub chain_monitor: M,
4288 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
4289 /// used to broadcast the latest local commitment transactions of channels which must be
4290 /// force-closed during deserialization.
4291 pub tx_broadcaster: T,
4292 /// The Logger for use in the ChannelManager and which may be used to log information during
4293 /// deserialization.
4295 /// Default settings used for new channels. Any existing channels will continue to use the
4296 /// runtime settings which were stored when the ChannelManager was serialized.
4297 pub default_config: UserConfig,
4299 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
4300 /// value.get_funding_txo() should be the key).
4302 /// If a monitor is inconsistent with the channel state during deserialization the channel will
4303 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
4304 /// is true for missing channels as well. If there is a monitor missing for which we find
4305 /// channel data Err(DecodeError::InvalidValue) will be returned.
4307 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
4310 /// (C-not exported) because we have no HashMap bindings
4311 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
4314 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4315 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
4316 where M::Target: chain::Watch<Signer>,
4317 T::Target: BroadcasterInterface,
4318 K::Target: KeysInterface<Signer = Signer>,
4319 F::Target: FeeEstimator,
4322 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
4323 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
4324 /// populate a HashMap directly from C.
4325 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
4326 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
4328 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
4329 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
4334 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
4335 // SipmleArcChannelManager type:
4336 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4337 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
4338 where M::Target: chain::Watch<Signer>,
4339 T::Target: BroadcasterInterface,
4340 K::Target: KeysInterface<Signer = Signer>,
4341 F::Target: FeeEstimator,
4344 fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4345 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
4346 Ok((blockhash, Arc::new(chan_manager)))
4350 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4351 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
4352 where M::Target: chain::Watch<Signer>,
4353 T::Target: BroadcasterInterface,
4354 K::Target: KeysInterface<Signer = Signer>,
4355 F::Target: FeeEstimator,
4358 fn read<R: ::std::io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4359 let _ver: u8 = Readable::read(reader)?;
4360 let min_ver: u8 = Readable::read(reader)?;
4361 if min_ver > SERIALIZATION_VERSION {
4362 return Err(DecodeError::UnknownVersion);
4365 let genesis_hash: BlockHash = Readable::read(reader)?;
4366 let best_block_height: u32 = Readable::read(reader)?;
4367 let best_block_hash: BlockHash = Readable::read(reader)?;
4369 let mut failed_htlcs = Vec::new();
4371 let channel_count: u64 = Readable::read(reader)?;
4372 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
4373 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4374 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4375 for _ in 0..channel_count {
4376 let mut channel: Channel<Signer> = Channel::read(reader, &args.keys_manager)?;
4377 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
4378 funding_txo_set.insert(funding_txo.clone());
4379 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
4380 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
4381 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
4382 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
4383 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
4384 // If the channel is ahead of the monitor, return InvalidValue:
4385 return Err(DecodeError::InvalidValue);
4386 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
4387 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
4388 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
4389 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
4390 // But if the channel is behind of the monitor, close the channel:
4391 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
4392 failed_htlcs.append(&mut new_failed_htlcs);
4393 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4395 if let Some(short_channel_id) = channel.get_short_channel_id() {
4396 short_to_id.insert(short_channel_id, channel.channel_id());
4398 by_id.insert(channel.channel_id(), channel);
4401 return Err(DecodeError::InvalidValue);
4405 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
4406 if !funding_txo_set.contains(funding_txo) {
4407 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4411 const MAX_ALLOC_SIZE: usize = 1024 * 64;
4412 let forward_htlcs_count: u64 = Readable::read(reader)?;
4413 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
4414 for _ in 0..forward_htlcs_count {
4415 let short_channel_id = Readable::read(reader)?;
4416 let pending_forwards_count: u64 = Readable::read(reader)?;
4417 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
4418 for _ in 0..pending_forwards_count {
4419 pending_forwards.push(Readable::read(reader)?);
4421 forward_htlcs.insert(short_channel_id, pending_forwards);
4424 let claimable_htlcs_count: u64 = Readable::read(reader)?;
4425 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
4426 for _ in 0..claimable_htlcs_count {
4427 let payment_hash = Readable::read(reader)?;
4428 let previous_hops_len: u64 = Readable::read(reader)?;
4429 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
4430 for _ in 0..previous_hops_len {
4431 previous_hops.push(Readable::read(reader)?);
4433 claimable_htlcs.insert(payment_hash, previous_hops);
4436 let peer_count: u64 = Readable::read(reader)?;
4437 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
4438 for _ in 0..peer_count {
4439 let peer_pubkey = Readable::read(reader)?;
4440 let peer_state = PeerState {
4441 latest_features: Readable::read(reader)?,
4443 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
4446 let event_count: u64 = Readable::read(reader)?;
4447 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>()));
4448 for _ in 0..event_count {
4449 match MaybeReadable::read(reader)? {
4450 Some(event) => pending_events_read.push(event),
4455 let background_event_count: u64 = Readable::read(reader)?;
4456 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>()));
4457 for _ in 0..background_event_count {
4458 match <u8 as Readable>::read(reader)? {
4459 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
4460 _ => return Err(DecodeError::InvalidValue),
4464 let last_node_announcement_serial: u32 = Readable::read(reader)?;
4466 let mut secp_ctx = Secp256k1::new();
4467 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
4469 let channel_manager = ChannelManager {
4471 fee_estimator: args.fee_estimator,
4472 chain_monitor: args.chain_monitor,
4473 tx_broadcaster: args.tx_broadcaster,
4475 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
4477 channel_state: Mutex::new(ChannelHolder {
4482 pending_msg_events: Vec::new(),
4484 our_network_key: args.keys_manager.get_node_secret(),
4485 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &args.keys_manager.get_node_secret()),
4488 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
4490 per_peer_state: RwLock::new(per_peer_state),
4492 pending_events: Mutex::new(pending_events_read),
4493 pending_background_events: Mutex::new(pending_background_events_read),
4494 total_consistency_lock: RwLock::new(()),
4495 persistence_notifier: PersistenceNotifier::new(),
4497 keys_manager: args.keys_manager,
4498 logger: args.logger,
4499 default_configuration: args.default_config,
4502 for htlc_source in failed_htlcs.drain(..) {
4503 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() });
4506 //TODO: Broadcast channel update for closed channels, but only after we've made a
4507 //connection or two.
4509 Ok((best_block_hash.clone(), channel_manager))
4515 use ln::channelmanager::PersistenceNotifier;
4517 use std::sync::atomic::{AtomicBool, Ordering};
4519 use std::time::Duration;
4522 fn test_wait_timeout() {
4523 let persistence_notifier = Arc::new(PersistenceNotifier::new());
4524 let thread_notifier = Arc::clone(&persistence_notifier);
4526 let exit_thread = Arc::new(AtomicBool::new(false));
4527 let exit_thread_clone = exit_thread.clone();
4528 thread::spawn(move || {
4530 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
4531 let mut persistence_lock = persist_mtx.lock().unwrap();
4532 *persistence_lock = true;
4535 if exit_thread_clone.load(Ordering::SeqCst) {
4541 // Check that we can block indefinitely until updates are available.
4542 let _ = persistence_notifier.wait();
4544 // Check that the PersistenceNotifier will return after the given duration if updates are
4547 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
4552 exit_thread.store(true, Ordering::SeqCst);
4554 // Check that the PersistenceNotifier will return after the given duration even if no updates
4557 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
4564 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))]
4567 use chain::chainmonitor::ChainMonitor;
4568 use chain::channelmonitor::Persist;
4569 use chain::keysinterface::{KeysManager, InMemorySigner};
4570 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
4571 use ln::features::InitFeatures;
4572 use ln::functional_test_utils::*;
4573 use ln::msgs::ChannelMessageHandler;
4574 use routing::network_graph::NetworkGraph;
4575 use routing::router::get_route;
4576 use util::test_utils;
4577 use util::config::UserConfig;
4578 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
4580 use bitcoin::hashes::Hash;
4581 use bitcoin::hashes::sha256::Hash as Sha256;
4582 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
4584 use std::sync::Mutex;
4588 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
4589 node: &'a ChannelManager<InMemorySigner,
4590 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
4591 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
4592 &'a test_utils::TestLogger, &'a P>,
4593 &'a test_utils::TestBroadcaster, &'a KeysManager,
4594 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
4599 fn bench_sends(bench: &mut Bencher) {
4600 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
4603 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
4604 // Do a simple benchmark of sending a payment back and forth between two nodes.
4605 // Note that this is unrealistic as each payment send will require at least two fsync
4607 let network = bitcoin::Network::Testnet;
4608 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
4610 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
4611 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4613 let mut config: UserConfig = Default::default();
4614 config.own_channel_config.minimum_depth = 1;
4616 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
4617 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
4618 let seed_a = [1u8; 32];
4619 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
4620 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
4622 best_block: BestBlock::from_genesis(network),
4624 let node_a_holder = NodeHolder { node: &node_a };
4626 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
4627 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
4628 let seed_b = [2u8; 32];
4629 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
4630 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
4632 best_block: BestBlock::from_genesis(network),
4634 let node_b_holder = NodeHolder { node: &node_b };
4636 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
4637 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()));
4638 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()));
4641 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
4642 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
4643 value: 8_000_000, script_pubkey: output_script,
4645 node_a.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4646 } else { panic!(); }
4648 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()));
4649 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()));
4651 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
4654 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4657 Listen::block_connected(&node_a, &block, 1);
4658 Listen::block_connected(&node_b, &block, 1);
4660 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()));
4661 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()));
4663 let dummy_graph = NetworkGraph::new(genesis_hash);
4665 macro_rules! send_payment {
4666 ($node_a: expr, $node_b: expr) => {
4667 let usable_channels = $node_a.list_usable_channels();
4668 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();
4670 let payment_preimage = PaymentPreimage([0; 32]);
4671 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
4673 $node_a.send_payment(&route, payment_hash, &None).unwrap();
4674 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
4675 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
4676 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
4677 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
4678 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
4679 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
4680 $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()));
4682 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
4683 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
4684 assert!($node_b.claim_funds(payment_preimage, &None, 10_000));
4686 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
4687 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
4688 assert_eq!(node_id, $node_a.get_our_node_id());
4689 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4690 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
4692 _ => panic!("Failed to generate claim event"),
4695 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
4696 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
4697 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
4698 $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()));
4700 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
4705 send_payment!(node_a, node_b);
4706 send_payment!(node_b, node_a);