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 [`find_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).
20 //! [`find_route`]: crate::routing::router::find_route
22 use bitcoin::blockdata::block::BlockHeader;
23 use bitcoin::blockdata::transaction::Transaction;
24 use bitcoin::blockdata::constants::genesis_block;
25 use bitcoin::network::constants::Network;
27 use bitcoin::hashes::Hash;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
30 use bitcoin::hash_types::{BlockHash, Txid};
32 use bitcoin::secp256k1::{SecretKey,PublicKey};
33 use bitcoin::secp256k1::Secp256k1;
34 use bitcoin::secp256k1::ecdh::SharedSecret;
35 use bitcoin::{LockTime, secp256k1, Sequence};
38 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
39 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
40 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
41 use crate::chain::transaction::{OutPoint, TransactionData};
42 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
43 // construct one themselves.
44 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
45 use crate::ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
46 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
47 #[cfg(any(feature = "_test_utils", test))]
48 use crate::ln::features::InvoiceFeatures;
49 use crate::routing::router::{PaymentParameters, Route, RouteHop, RoutePath, RouteParameters};
51 use crate::ln::onion_utils;
52 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
53 use crate::ln::wire::Encode;
54 use crate::chain::keysinterface::{Sign, KeysInterface, KeysManager, Recipient};
55 use crate::util::config::{UserConfig, ChannelConfig};
56 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
57 use crate::util::{byte_utils, events};
58 use crate::util::wakers::{Future, Notifier};
59 use crate::util::scid_utils::fake_scid;
60 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
61 use crate::util::logger::{Level, Logger};
62 use crate::util::errors::APIError;
65 use crate::prelude::*;
67 use core::cell::RefCell;
69 use crate::sync::{Arc, Mutex, MutexGuard, RwLock, RwLockReadGuard, FairRwLock};
70 use core::sync::atomic::{AtomicUsize, Ordering};
71 use core::time::Duration;
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 pub(super) enum PendingHTLCRouting {
94 onion_packet: msgs::OnionPacket,
95 /// The SCID from the onion that we should forward to. This could be a "real" SCID, an
96 /// outbound SCID alias, or a phantom node SCID.
97 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
100 payment_data: msgs::FinalOnionHopData,
101 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
102 phantom_shared_secret: Option<[u8; 32]>,
105 payment_preimage: PaymentPreimage,
106 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
110 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
111 pub(super) struct PendingHTLCInfo {
112 pub(super) routing: PendingHTLCRouting,
113 pub(super) incoming_shared_secret: [u8; 32],
114 payment_hash: PaymentHash,
115 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
116 pub(super) outgoing_amt_msat: u64,
117 pub(super) outgoing_cltv_value: u32,
120 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
121 pub(super) enum HTLCFailureMsg {
122 Relay(msgs::UpdateFailHTLC),
123 Malformed(msgs::UpdateFailMalformedHTLC),
126 /// Stores whether we can't forward an HTLC or relevant forwarding info
127 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
128 pub(super) enum PendingHTLCStatus {
129 Forward(PendingHTLCInfo),
130 Fail(HTLCFailureMsg),
133 pub(super) struct PendingAddHTLCInfo {
134 pub(super) forward_info: PendingHTLCInfo,
136 // These fields are produced in `forward_htlcs()` and consumed in
137 // `process_pending_htlc_forwards()` for constructing the
138 // `HTLCSource::PreviousHopData` for failed and forwarded
141 // Note that this may be an outbound SCID alias for the associated channel.
142 prev_short_channel_id: u64,
144 prev_funding_outpoint: OutPoint,
147 pub(super) enum HTLCForwardInfo {
148 AddHTLC(PendingAddHTLCInfo),
151 err_packet: msgs::OnionErrorPacket,
155 /// Tracks the inbound corresponding to an outbound HTLC
156 #[derive(Clone, Hash, PartialEq, Eq)]
157 pub(crate) struct HTLCPreviousHopData {
158 // Note that this may be an outbound SCID alias for the associated channel.
159 short_channel_id: u64,
161 incoming_packet_shared_secret: [u8; 32],
162 phantom_shared_secret: Option<[u8; 32]>,
164 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
165 // channel with a preimage provided by the forward channel.
170 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
172 /// This is only here for backwards-compatibility in serialization, in the future it can be
173 /// removed, breaking clients running 0.0.106 and earlier.
174 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
176 /// Contains the payer-provided preimage.
177 Spontaneous(PaymentPreimage),
180 /// HTLCs that are to us and can be failed/claimed by the user
181 struct ClaimableHTLC {
182 prev_hop: HTLCPreviousHopData,
184 /// The amount (in msats) of this MPP part
186 onion_payload: OnionPayload,
188 /// The sum total of all MPP parts
192 /// A payment identifier used to uniquely identify a payment to LDK.
193 /// (C-not exported) as we just use [u8; 32] directly
194 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
195 pub struct PaymentId(pub [u8; 32]);
197 impl Writeable for PaymentId {
198 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
203 impl Readable for PaymentId {
204 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
205 let buf: [u8; 32] = Readable::read(r)?;
209 /// Tracks the inbound corresponding to an outbound HTLC
210 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
211 #[derive(Clone, PartialEq, Eq)]
212 pub(crate) enum HTLCSource {
213 PreviousHopData(HTLCPreviousHopData),
216 session_priv: SecretKey,
217 /// Technically we can recalculate this from the route, but we cache it here to avoid
218 /// doing a double-pass on route when we get a failure back
219 first_hop_htlc_msat: u64,
220 payment_id: PaymentId,
221 payment_secret: Option<PaymentSecret>,
222 payment_params: Option<PaymentParameters>,
225 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
226 impl core::hash::Hash for HTLCSource {
227 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
229 HTLCSource::PreviousHopData(prev_hop_data) => {
231 prev_hop_data.hash(hasher);
233 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
236 session_priv[..].hash(hasher);
237 payment_id.hash(hasher);
238 payment_secret.hash(hasher);
239 first_hop_htlc_msat.hash(hasher);
240 payment_params.hash(hasher);
245 #[cfg(not(feature = "grind_signatures"))]
248 pub fn dummy() -> Self {
249 HTLCSource::OutboundRoute {
251 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
252 first_hop_htlc_msat: 0,
253 payment_id: PaymentId([2; 32]),
254 payment_secret: None,
255 payment_params: None,
260 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
261 pub(super) enum HTLCFailReason {
263 err: msgs::OnionErrorPacket,
271 struct ReceiveError {
277 /// Return value for claim_funds_from_hop
278 enum ClaimFundsFromHop {
280 MonitorUpdateFail(PublicKey, MsgHandleErrInternal, Option<u64>),
285 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
287 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
288 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
289 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
290 /// channel_state lock. We then return the set of things that need to be done outside the lock in
291 /// this struct and call handle_error!() on it.
293 struct MsgHandleErrInternal {
294 err: msgs::LightningError,
295 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
296 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
298 impl MsgHandleErrInternal {
300 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
302 err: LightningError {
304 action: msgs::ErrorAction::SendErrorMessage {
305 msg: msgs::ErrorMessage {
312 shutdown_finish: None,
316 fn ignore_no_close(err: String) -> Self {
318 err: LightningError {
320 action: msgs::ErrorAction::IgnoreError,
323 shutdown_finish: None,
327 fn from_no_close(err: msgs::LightningError) -> Self {
328 Self { err, chan_id: None, shutdown_finish: None }
331 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
333 err: LightningError {
335 action: msgs::ErrorAction::SendErrorMessage {
336 msg: msgs::ErrorMessage {
342 chan_id: Some((channel_id, user_channel_id)),
343 shutdown_finish: Some((shutdown_res, channel_update)),
347 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
350 ChannelError::Warn(msg) => LightningError {
352 action: msgs::ErrorAction::SendWarningMessage {
353 msg: msgs::WarningMessage {
357 log_level: Level::Warn,
360 ChannelError::Ignore(msg) => LightningError {
362 action: msgs::ErrorAction::IgnoreError,
364 ChannelError::Close(msg) => LightningError {
366 action: msgs::ErrorAction::SendErrorMessage {
367 msg: msgs::ErrorMessage {
375 shutdown_finish: None,
380 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
381 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
382 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
383 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
384 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
386 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
387 /// be sent in the order they appear in the return value, however sometimes the order needs to be
388 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
389 /// they were originally sent). In those cases, this enum is also returned.
390 #[derive(Clone, PartialEq)]
391 pub(super) enum RAACommitmentOrder {
392 /// Send the CommitmentUpdate messages first
394 /// Send the RevokeAndACK message first
398 // Note this is only exposed in cfg(test):
399 pub(super) struct ChannelHolder<Signer: Sign> {
400 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
401 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
402 /// failed/claimed by the user.
404 /// Note that while this is held in the same mutex as the channels themselves, no consistency
405 /// guarantees are made about the channels given here actually existing anymore by the time you
407 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
408 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
409 /// for broadcast messages, where ordering isn't as strict).
410 pub(super) pending_msg_events: Vec<MessageSendEvent>,
413 /// Events which we process internally but cannot be procsesed immediately at the generation site
414 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
415 /// quite some time lag.
416 enum BackgroundEvent {
417 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
418 /// commitment transaction.
419 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
422 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
423 /// the latest Init features we heard from the peer.
425 latest_features: InitFeatures,
428 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
429 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
431 /// For users who don't want to bother doing their own payment preimage storage, we also store that
434 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
435 /// and instead encoding it in the payment secret.
436 struct PendingInboundPayment {
437 /// The payment secret that the sender must use for us to accept this payment
438 payment_secret: PaymentSecret,
439 /// Time at which this HTLC expires - blocks with a header time above this value will result in
440 /// this payment being removed.
442 /// Arbitrary identifier the user specifies (or not)
443 user_payment_id: u64,
444 // Other required attributes of the payment, optionally enforced:
445 payment_preimage: Option<PaymentPreimage>,
446 min_value_msat: Option<u64>,
449 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
450 /// and later, also stores information for retrying the payment.
451 pub(crate) enum PendingOutboundPayment {
453 session_privs: HashSet<[u8; 32]>,
456 session_privs: HashSet<[u8; 32]>,
457 payment_hash: PaymentHash,
458 payment_secret: Option<PaymentSecret>,
459 pending_amt_msat: u64,
460 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
461 pending_fee_msat: Option<u64>,
462 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
464 /// Our best known block height at the time this payment was initiated.
465 starting_block_height: u32,
467 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
468 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
469 /// and add a pending payment that was already fulfilled.
471 session_privs: HashSet<[u8; 32]>,
472 payment_hash: Option<PaymentHash>,
473 timer_ticks_without_htlcs: u8,
475 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
476 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
477 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
478 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
479 /// downstream event handler as to when a payment has actually failed.
481 /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
483 session_privs: HashSet<[u8; 32]>,
484 payment_hash: PaymentHash,
488 impl PendingOutboundPayment {
489 fn is_fulfilled(&self) -> bool {
491 PendingOutboundPayment::Fulfilled { .. } => true,
495 fn abandoned(&self) -> bool {
497 PendingOutboundPayment::Abandoned { .. } => true,
501 fn get_pending_fee_msat(&self) -> Option<u64> {
503 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
508 fn payment_hash(&self) -> Option<PaymentHash> {
510 PendingOutboundPayment::Legacy { .. } => None,
511 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
512 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
513 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
517 fn mark_fulfilled(&mut self) {
518 let mut session_privs = HashSet::new();
519 core::mem::swap(&mut session_privs, match self {
520 PendingOutboundPayment::Legacy { session_privs } |
521 PendingOutboundPayment::Retryable { session_privs, .. } |
522 PendingOutboundPayment::Fulfilled { session_privs, .. } |
523 PendingOutboundPayment::Abandoned { session_privs, .. }
526 let payment_hash = self.payment_hash();
527 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
530 fn mark_abandoned(&mut self) -> Result<(), ()> {
531 let mut session_privs = HashSet::new();
532 let our_payment_hash;
533 core::mem::swap(&mut session_privs, match self {
534 PendingOutboundPayment::Legacy { .. } |
535 PendingOutboundPayment::Fulfilled { .. } =>
537 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
538 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
539 our_payment_hash = *payment_hash;
543 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
547 /// panics if path is None and !self.is_fulfilled
548 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
549 let remove_res = match self {
550 PendingOutboundPayment::Legacy { session_privs } |
551 PendingOutboundPayment::Retryable { session_privs, .. } |
552 PendingOutboundPayment::Fulfilled { session_privs, .. } |
553 PendingOutboundPayment::Abandoned { session_privs, .. } => {
554 session_privs.remove(session_priv)
558 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
559 let path = path.expect("Fulfilling a payment should always come with a path");
560 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
561 *pending_amt_msat -= path_last_hop.fee_msat;
562 if let Some(fee_msat) = pending_fee_msat.as_mut() {
563 *fee_msat -= path.get_path_fees();
570 fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
571 let insert_res = match self {
572 PendingOutboundPayment::Legacy { session_privs } |
573 PendingOutboundPayment::Retryable { session_privs, .. } => {
574 session_privs.insert(session_priv)
576 PendingOutboundPayment::Fulfilled { .. } => false,
577 PendingOutboundPayment::Abandoned { .. } => false,
580 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
581 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
582 *pending_amt_msat += path_last_hop.fee_msat;
583 if let Some(fee_msat) = pending_fee_msat.as_mut() {
584 *fee_msat += path.get_path_fees();
591 fn remaining_parts(&self) -> usize {
593 PendingOutboundPayment::Legacy { session_privs } |
594 PendingOutboundPayment::Retryable { session_privs, .. } |
595 PendingOutboundPayment::Fulfilled { session_privs, .. } |
596 PendingOutboundPayment::Abandoned { session_privs, .. } => {
603 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
604 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
605 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
606 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
607 /// issues such as overly long function definitions. Note that the ChannelManager can take any
608 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
609 /// concrete type of the KeysManager.
611 /// (C-not exported) as Arcs don't make sense in bindings
612 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
614 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
615 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
616 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
617 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
618 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
619 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
620 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
621 /// concrete type of the KeysManager.
623 /// (C-not exported) as Arcs don't make sense in bindings
624 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
626 /// Manager which keeps track of a number of channels and sends messages to the appropriate
627 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
629 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
630 /// to individual Channels.
632 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
633 /// all peers during write/read (though does not modify this instance, only the instance being
634 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
635 /// called funding_transaction_generated for outbound channels).
637 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
638 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
639 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
640 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
641 /// the serialization process). If the deserialized version is out-of-date compared to the
642 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
643 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
645 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
646 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
647 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
648 /// block_connected() to step towards your best block) upon deserialization before using the
651 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
652 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
653 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
654 /// offline for a full minute. In order to track this, you must call
655 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
657 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
658 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
659 /// essentially you should default to using a SimpleRefChannelManager, and use a
660 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
661 /// you're using lightning-net-tokio.
664 // The tree structure below illustrates the lock order requirements for the different locks of the
665 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
666 // and should then be taken in the order of the lowest to the highest level in the tree.
667 // Note that locks on different branches shall not be taken at the same time, as doing so will
668 // create a new lock order for those specific locks in the order they were taken.
672 // `total_consistency_lock`
674 // |__`forward_htlcs`
676 // |__`channel_state`
680 // | |__`short_to_chan_info`
682 // | |__`per_peer_state`
684 // | |__`outbound_scid_aliases`
686 // | |__`pending_inbound_payments`
688 // | |__`pending_outbound_payments`
692 // | |__`pending_events`
694 // | |__`pending_background_events`
696 pub struct ChannelManager<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
697 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
698 T::Target: BroadcasterInterface,
699 K::Target: KeysInterface,
700 F::Target: FeeEstimator,
703 default_configuration: UserConfig,
704 genesis_hash: BlockHash,
705 fee_estimator: LowerBoundedFeeEstimator<F>,
709 /// See `ChannelManager` struct-level documentation for lock order requirements.
711 pub(super) best_block: RwLock<BestBlock>,
713 best_block: RwLock<BestBlock>,
714 secp_ctx: Secp256k1<secp256k1::All>,
716 /// See `ChannelManager` struct-level documentation for lock order requirements.
717 #[cfg(any(test, feature = "_test_utils"))]
718 pub(super) channel_state: Mutex<ChannelHolder<<K::Target as KeysInterface>::Signer>>,
719 #[cfg(not(any(test, feature = "_test_utils")))]
720 channel_state: Mutex<ChannelHolder<<K::Target as KeysInterface>::Signer>>,
722 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
723 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
724 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
725 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
727 /// See `ChannelManager` struct-level documentation for lock order requirements.
728 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
730 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
731 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
732 /// (if the channel has been force-closed), however we track them here to prevent duplicative
733 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
734 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
735 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
736 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
737 /// after reloading from disk while replaying blocks against ChannelMonitors.
739 /// See `PendingOutboundPayment` documentation for more info.
741 /// See `ChannelManager` struct-level documentation for lock order requirements.
742 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
744 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
746 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
747 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
748 /// and via the classic SCID.
750 /// Note that no consistency guarantees are made about the existence of a channel with the
751 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
753 /// See `ChannelManager` struct-level documentation for lock order requirements.
755 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
757 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
759 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
760 /// and some closed channels which reached a usable state prior to being closed. This is used
761 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
762 /// active channel list on load.
764 /// See `ChannelManager` struct-level documentation for lock order requirements.
765 outbound_scid_aliases: Mutex<HashSet<u64>>,
767 /// `channel_id` -> `counterparty_node_id`.
769 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
770 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
771 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
773 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
774 /// the corresponding channel for the event, as we only have access to the `channel_id` during
775 /// the handling of the events.
778 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
779 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
780 /// would break backwards compatability.
781 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
782 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
783 /// required to access the channel with the `counterparty_node_id`.
785 /// See `ChannelManager` struct-level documentation for lock order requirements.
786 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
788 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
790 /// Outbound SCID aliases are added here once the channel is available for normal use, with
791 /// SCIDs being added once the funding transaction is confirmed at the channel's required
792 /// confirmation depth.
794 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
795 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
796 /// channel with the `channel_id` in our other maps.
798 /// See `ChannelManager` struct-level documentation for lock order requirements.
800 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
802 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
804 our_network_key: SecretKey,
805 our_network_pubkey: PublicKey,
807 inbound_payment_key: inbound_payment::ExpandedKey,
809 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
810 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
811 /// we encrypt the namespace identifier using these bytes.
813 /// [fake scids]: crate::util::scid_utils::fake_scid
814 fake_scid_rand_bytes: [u8; 32],
816 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
817 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
818 /// keeping additional state.
819 probing_cookie_secret: [u8; 32],
821 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
822 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
823 /// very far in the past, and can only ever be up to two hours in the future.
824 highest_seen_timestamp: AtomicUsize,
826 /// The bulk of our storage will eventually be here (channels and message queues and the like).
827 /// If we are connected to a peer we always at least have an entry here, even if no channels
828 /// are currently open with that peer.
829 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
830 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
833 /// See `ChannelManager` struct-level documentation for lock order requirements.
834 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
836 /// See `ChannelManager` struct-level documentation for lock order requirements.
837 pending_events: Mutex<Vec<events::Event>>,
838 /// See `ChannelManager` struct-level documentation for lock order requirements.
839 pending_background_events: Mutex<Vec<BackgroundEvent>>,
840 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
841 /// Essentially just when we're serializing ourselves out.
842 /// Taken first everywhere where we are making changes before any other locks.
843 /// When acquiring this lock in read mode, rather than acquiring it directly, call
844 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
845 /// Notifier the lock contains sends out a notification when the lock is released.
846 total_consistency_lock: RwLock<()>,
848 persistence_notifier: Notifier,
855 /// Chain-related parameters used to construct a new `ChannelManager`.
857 /// Typically, the block-specific parameters are derived from the best block hash for the network,
858 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
859 /// are not needed when deserializing a previously constructed `ChannelManager`.
860 #[derive(Clone, Copy, PartialEq)]
861 pub struct ChainParameters {
862 /// The network for determining the `chain_hash` in Lightning messages.
863 pub network: Network,
865 /// The hash and height of the latest block successfully connected.
867 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
868 pub best_block: BestBlock,
871 #[derive(Copy, Clone, PartialEq)]
877 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
878 /// desirable to notify any listeners on `await_persistable_update_timeout`/
879 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
880 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
881 /// sending the aforementioned notification (since the lock being released indicates that the
882 /// updates are ready for persistence).
884 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
885 /// notify or not based on whether relevant changes have been made, providing a closure to
886 /// `optionally_notify` which returns a `NotifyOption`.
887 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
888 persistence_notifier: &'a Notifier,
890 // We hold onto this result so the lock doesn't get released immediately.
891 _read_guard: RwLockReadGuard<'a, ()>,
894 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
895 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
896 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
899 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
900 let read_guard = lock.read().unwrap();
902 PersistenceNotifierGuard {
903 persistence_notifier: notifier,
904 should_persist: persist_check,
905 _read_guard: read_guard,
910 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
912 if (self.should_persist)() == NotifyOption::DoPersist {
913 self.persistence_notifier.notify();
918 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
919 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
921 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
923 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
924 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
925 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
926 /// the maximum required amount in lnd as of March 2021.
927 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
929 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
930 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
932 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
934 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
935 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
936 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
937 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
938 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
939 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
940 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
941 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
942 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
943 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
944 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
945 // routing failure for any HTLC sender picking up an LDK node among the first hops.
946 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
948 /// Minimum CLTV difference between the current block height and received inbound payments.
949 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
951 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
952 // any payments to succeed. Further, we don't want payments to fail if a block was found while
953 // a payment was being routed, so we add an extra block to be safe.
954 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
956 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
957 // ie that if the next-hop peer fails the HTLC within
958 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
959 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
960 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
961 // LATENCY_GRACE_PERIOD_BLOCKS.
964 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;
966 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
967 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
970 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
972 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
973 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
975 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
976 /// idempotency of payments by [`PaymentId`]. See
977 /// [`ChannelManager::remove_stale_resolved_payments`].
978 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
980 /// Information needed for constructing an invoice route hint for this channel.
981 #[derive(Clone, Debug, PartialEq)]
982 pub struct CounterpartyForwardingInfo {
983 /// Base routing fee in millisatoshis.
984 pub fee_base_msat: u32,
985 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
986 pub fee_proportional_millionths: u32,
987 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
988 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
989 /// `cltv_expiry_delta` for more details.
990 pub cltv_expiry_delta: u16,
993 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
994 /// to better separate parameters.
995 #[derive(Clone, Debug, PartialEq)]
996 pub struct ChannelCounterparty {
997 /// The node_id of our counterparty
998 pub node_id: PublicKey,
999 /// The Features the channel counterparty provided upon last connection.
1000 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1001 /// many routing-relevant features are present in the init context.
1002 pub features: InitFeatures,
1003 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1004 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1005 /// claiming at least this value on chain.
1007 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1009 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1010 pub unspendable_punishment_reserve: u64,
1011 /// Information on the fees and requirements that the counterparty requires when forwarding
1012 /// payments to us through this channel.
1013 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1014 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1015 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1016 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1017 pub outbound_htlc_minimum_msat: Option<u64>,
1018 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1019 pub outbound_htlc_maximum_msat: Option<u64>,
1022 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
1023 #[derive(Clone, Debug, PartialEq)]
1024 pub struct ChannelDetails {
1025 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1026 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1027 /// Note that this means this value is *not* persistent - it can change once during the
1028 /// lifetime of the channel.
1029 pub channel_id: [u8; 32],
1030 /// Parameters which apply to our counterparty. See individual fields for more information.
1031 pub counterparty: ChannelCounterparty,
1032 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1033 /// our counterparty already.
1035 /// Note that, if this has been set, `channel_id` will be equivalent to
1036 /// `funding_txo.unwrap().to_channel_id()`.
1037 pub funding_txo: Option<OutPoint>,
1038 /// The features which this channel operates with. See individual features for more info.
1040 /// `None` until negotiation completes and the channel type is finalized.
1041 pub channel_type: Option<ChannelTypeFeatures>,
1042 /// The position of the funding transaction in the chain. None if the funding transaction has
1043 /// not yet been confirmed and the channel fully opened.
1045 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1046 /// payments instead of this. See [`get_inbound_payment_scid`].
1048 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1049 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1051 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1052 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1053 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1054 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1055 /// [`confirmations_required`]: Self::confirmations_required
1056 pub short_channel_id: Option<u64>,
1057 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1058 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1059 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1062 /// This will be `None` as long as the channel is not available for routing outbound payments.
1064 /// [`short_channel_id`]: Self::short_channel_id
1065 /// [`confirmations_required`]: Self::confirmations_required
1066 pub outbound_scid_alias: Option<u64>,
1067 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1068 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1069 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1070 /// when they see a payment to be routed to us.
1072 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1073 /// previous values for inbound payment forwarding.
1075 /// [`short_channel_id`]: Self::short_channel_id
1076 pub inbound_scid_alias: Option<u64>,
1077 /// The value, in satoshis, of this channel as appears in the funding output
1078 pub channel_value_satoshis: u64,
1079 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1080 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1081 /// this value on chain.
1083 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1085 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1087 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1088 pub unspendable_punishment_reserve: Option<u64>,
1089 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1091 pub user_channel_id: u128,
1092 /// Our total balance. This is the amount we would get if we close the channel.
1093 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1094 /// amount is not likely to be recoverable on close.
1096 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1097 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1098 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1099 /// This does not consider any on-chain fees.
1101 /// See also [`ChannelDetails::outbound_capacity_msat`]
1102 pub balance_msat: u64,
1103 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1104 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1105 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1106 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1108 /// See also [`ChannelDetails::balance_msat`]
1110 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1111 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1112 /// should be able to spend nearly this amount.
1113 pub outbound_capacity_msat: u64,
1114 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1115 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1116 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1117 /// to use a limit as close as possible to the HTLC limit we can currently send.
1119 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1120 pub next_outbound_htlc_limit_msat: u64,
1121 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1122 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1123 /// available for inclusion in new inbound HTLCs).
1124 /// Note that there are some corner cases not fully handled here, so the actual available
1125 /// inbound capacity may be slightly higher than this.
1127 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1128 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1129 /// However, our counterparty should be able to spend nearly this amount.
1130 pub inbound_capacity_msat: u64,
1131 /// The number of required confirmations on the funding transaction before the funding will be
1132 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1133 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1134 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1135 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1137 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1139 /// [`is_outbound`]: ChannelDetails::is_outbound
1140 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1141 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1142 pub confirmations_required: Option<u32>,
1143 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1144 /// until we can claim our funds after we force-close the channel. During this time our
1145 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1146 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1147 /// time to claim our non-HTLC-encumbered funds.
1149 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1150 pub force_close_spend_delay: Option<u16>,
1151 /// True if the channel was initiated (and thus funded) by us.
1152 pub is_outbound: bool,
1153 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1154 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1155 /// required confirmation count has been reached (and we were connected to the peer at some
1156 /// point after the funding transaction received enough confirmations). The required
1157 /// confirmation count is provided in [`confirmations_required`].
1159 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1160 pub is_channel_ready: bool,
1161 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1162 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1164 /// This is a strict superset of `is_channel_ready`.
1165 pub is_usable: bool,
1166 /// True if this channel is (or will be) publicly-announced.
1167 pub is_public: bool,
1168 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1169 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1170 pub inbound_htlc_minimum_msat: Option<u64>,
1171 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1172 pub inbound_htlc_maximum_msat: Option<u64>,
1173 /// Set of configurable parameters that affect channel operation.
1175 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1176 pub config: Option<ChannelConfig>,
1179 impl ChannelDetails {
1180 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1181 /// This should be used for providing invoice hints or in any other context where our
1182 /// counterparty will forward a payment to us.
1184 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1185 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1186 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1187 self.inbound_scid_alias.or(self.short_channel_id)
1190 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1191 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1192 /// we're sending or forwarding a payment outbound over this channel.
1194 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1195 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1196 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1197 self.short_channel_id.or(self.outbound_scid_alias)
1201 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
1202 /// Err() type describing which state the payment is in, see the description of individual enum
1203 /// states for more.
1204 #[derive(Clone, Debug)]
1205 pub enum PaymentSendFailure {
1206 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
1207 /// send the payment at all. No channel state has been changed or messages sent to peers, and
1208 /// once you've changed the parameter at error, you can freely retry the payment in full.
1209 ParameterError(APIError),
1210 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
1211 /// from attempting to send the payment at all. No channel state has been changed or messages
1212 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
1213 /// payment in full.
1215 /// The results here are ordered the same as the paths in the route object which was passed to
1217 PathParameterError(Vec<Result<(), APIError>>),
1218 /// All paths which were attempted failed to send, with no channel state change taking place.
1219 /// You can freely retry the payment in full (though you probably want to do so over different
1220 /// paths than the ones selected).
1222 /// [`ChannelManager::abandon_payment`] does *not* need to be called for this payment and
1223 /// [`ChannelManager::retry_payment`] will *not* work for this payment.
1224 AllFailedRetrySafe(Vec<APIError>),
1225 /// Some paths which were attempted failed to send, though possibly not all. At least some
1226 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
1227 /// in over-/re-payment.
1229 /// The results here are ordered the same as the paths in the route object which was passed to
1230 /// send_payment, and any `Err`s which are not [`APIError::MonitorUpdateInProgress`] can be
1231 /// safely retried via [`ChannelManager::retry_payment`].
1233 /// Any entries which contain `Err(APIError::MonitorUpdateInprogress)` or `Ok(())` MUST NOT be
1234 /// retried as they will result in over-/re-payment. These HTLCs all either successfully sent
1235 /// (in the case of `Ok(())`) or will send once a [`MonitorEvent::Completed`] is provided for
1236 /// the next-hop channel with the latest update_id.
1238 /// The errors themselves, in the same order as the route hops.
1239 results: Vec<Result<(), APIError>>,
1240 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
1241 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
1242 /// will pay all remaining unpaid balance.
1243 failed_paths_retry: Option<RouteParameters>,
1244 /// The payment id for the payment, which is now at least partially pending.
1245 payment_id: PaymentId,
1249 /// Route hints used in constructing invoices for [phantom node payents].
1251 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1253 pub struct PhantomRouteHints {
1254 /// The list of channels to be included in the invoice route hints.
1255 pub channels: Vec<ChannelDetails>,
1256 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1258 pub phantom_scid: u64,
1259 /// The pubkey of the real backing node that would ultimately receive the payment.
1260 pub real_node_pubkey: PublicKey,
1263 macro_rules! handle_error {
1264 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1267 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1268 #[cfg(debug_assertions)]
1270 // In testing, ensure there are no deadlocks where the lock is already held upon
1271 // entering the macro.
1272 assert!($self.channel_state.try_lock().is_ok());
1273 assert!($self.pending_events.try_lock().is_ok());
1276 let mut msg_events = Vec::with_capacity(2);
1278 if let Some((shutdown_res, update_option)) = shutdown_finish {
1279 $self.finish_force_close_channel(shutdown_res);
1280 if let Some(update) = update_option {
1281 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1285 if let Some((channel_id, user_channel_id)) = chan_id {
1286 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1287 channel_id, user_channel_id,
1288 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1293 log_error!($self.logger, "{}", err.err);
1294 if let msgs::ErrorAction::IgnoreError = err.action {
1296 msg_events.push(events::MessageSendEvent::HandleError {
1297 node_id: $counterparty_node_id,
1298 action: err.action.clone()
1302 if !msg_events.is_empty() {
1303 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1306 // Return error in case higher-API need one
1313 macro_rules! update_maps_on_chan_removal {
1314 ($self: expr, $channel: expr) => {{
1315 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1316 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1317 if let Some(short_id) = $channel.get_short_channel_id() {
1318 short_to_chan_info.remove(&short_id);
1320 // If the channel was never confirmed on-chain prior to its closure, remove the
1321 // outbound SCID alias we used for it from the collision-prevention set. While we
1322 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1323 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1324 // opening a million channels with us which are closed before we ever reach the funding
1326 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1327 debug_assert!(alias_removed);
1329 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1333 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1334 macro_rules! convert_chan_err {
1335 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1337 ChannelError::Warn(msg) => {
1338 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1340 ChannelError::Ignore(msg) => {
1341 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1343 ChannelError::Close(msg) => {
1344 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1345 update_maps_on_chan_removal!($self, $channel);
1346 let shutdown_res = $channel.force_shutdown(true);
1347 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1348 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1354 macro_rules! break_chan_entry {
1355 ($self: ident, $res: expr, $entry: expr) => {
1359 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1361 $entry.remove_entry();
1369 macro_rules! try_chan_entry {
1370 ($self: ident, $res: expr, $entry: expr) => {
1374 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1376 $entry.remove_entry();
1384 macro_rules! remove_channel {
1385 ($self: expr, $entry: expr) => {
1387 let channel = $entry.remove_entry().1;
1388 update_maps_on_chan_removal!($self, channel);
1394 macro_rules! handle_monitor_update_res {
1395 ($self: ident, $err: expr, $chan: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $resend_channel_ready: expr, $failed_forwards: expr, $failed_fails: expr, $failed_finalized_fulfills: expr, $chan_id: expr) => {
1397 ChannelMonitorUpdateStatus::PermanentFailure => {
1398 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1399 update_maps_on_chan_removal!($self, $chan);
1400 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1401 // chain in a confused state! We need to move them into the ChannelMonitor which
1402 // will be responsible for failing backwards once things confirm on-chain.
1403 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1404 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1405 // us bother trying to claim it just to forward on to another peer. If we're
1406 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1407 // given up the preimage yet, so might as well just wait until the payment is
1408 // retried, avoiding the on-chain fees.
1409 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1410 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1413 ChannelMonitorUpdateStatus::InProgress => {
1414 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1415 log_bytes!($chan_id[..]),
1416 if $resend_commitment && $resend_raa {
1417 match $action_type {
1418 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1419 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1421 } else if $resend_commitment { "commitment" }
1422 else if $resend_raa { "RAA" }
1424 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1425 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1426 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1427 if !$resend_commitment {
1428 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1431 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1433 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1434 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1436 ChannelMonitorUpdateStatus::Completed => {
1441 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $resend_channel_ready: expr, $failed_forwards: expr, $failed_fails: expr, $failed_finalized_fulfills: expr) => { {
1442 let (res, drop) = handle_monitor_update_res!($self, $err, $entry.get_mut(), $action_type, $resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills, $entry.key());
1444 $entry.remove_entry();
1448 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1449 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1450 handle_monitor_update_res!($self, $err, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1452 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1453 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1455 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1456 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1458 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1459 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1461 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1462 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1466 macro_rules! send_channel_ready {
1467 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1468 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1469 node_id: $channel.get_counterparty_node_id(),
1470 msg: $channel_ready_msg,
1472 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1473 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1474 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1475 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1476 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1477 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1478 if let Some(real_scid) = $channel.get_short_channel_id() {
1479 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1480 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1481 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1486 macro_rules! emit_channel_ready_event {
1487 ($self: expr, $channel: expr) => {
1488 if $channel.should_emit_channel_ready_event() {
1490 let mut pending_events = $self.pending_events.lock().unwrap();
1491 pending_events.push(events::Event::ChannelReady {
1492 channel_id: $channel.channel_id(),
1493 user_channel_id: $channel.get_user_id(),
1494 counterparty_node_id: $channel.get_counterparty_node_id(),
1495 channel_type: $channel.get_channel_type().clone(),
1498 $channel.set_channel_ready_event_emitted();
1503 macro_rules! handle_chan_restoration_locked {
1504 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1505 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1506 $pending_forwards: expr, $funding_broadcastable: expr, $channel_ready: expr, $announcement_sigs: expr) => { {
1507 let mut htlc_forwards = None;
1509 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1510 let chanmon_update_is_none = chanmon_update.is_none();
1511 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1513 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1514 if !forwards.is_empty() {
1515 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().unwrap_or($channel_entry.get().outbound_scid_alias()),
1516 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1519 if chanmon_update.is_some() {
1520 // On reconnect, we, by definition, only resend a channel_ready if there have been
1521 // no commitment updates, so the only channel monitor update which could also be
1522 // associated with a channel_ready would be the funding_created/funding_signed
1523 // monitor update. That monitor update failing implies that we won't send
1524 // channel_ready until it's been updated, so we can't have a channel_ready and a
1525 // monitor update here (so we don't bother to handle it correctly below).
1526 assert!($channel_ready.is_none());
1527 // A channel monitor update makes no sense without either a channel_ready or a
1528 // commitment update to process after it. Since we can't have a channel_ready, we
1529 // only bother to handle the monitor-update + commitment_update case below.
1530 assert!($commitment_update.is_some());
1533 if let Some(msg) = $channel_ready {
1534 // Similar to the above, this implies that we're letting the channel_ready fly
1535 // before it should be allowed to.
1536 assert!(chanmon_update.is_none());
1537 send_channel_ready!($self, $channel_state.pending_msg_events, $channel_entry.get(), msg);
1539 if let Some(msg) = $announcement_sigs {
1540 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1541 node_id: counterparty_node_id,
1546 emit_channel_ready_event!($self, $channel_entry.get_mut());
1548 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1549 if let Some(monitor_update) = chanmon_update {
1550 // We only ever broadcast a funding transaction in response to a funding_signed
1551 // message and the resulting monitor update. Thus, on channel_reestablish
1552 // message handling we can't have a funding transaction to broadcast. When
1553 // processing a monitor update finishing resulting in a funding broadcast, we
1554 // cannot have a second monitor update, thus this case would indicate a bug.
1555 assert!(funding_broadcastable.is_none());
1556 // Given we were just reconnected or finished updating a channel monitor, the
1557 // only case where we can get a new ChannelMonitorUpdate would be if we also
1558 // have some commitment updates to send as well.
1559 assert!($commitment_update.is_some());
1560 match $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1561 ChannelMonitorUpdateStatus::Completed => {},
1563 // channel_reestablish doesn't guarantee the order it returns is sensical
1564 // for the messages it returns, but if we're setting what messages to
1565 // re-transmit on monitor update success, we need to make sure it is sane.
1566 let mut order = $order;
1568 order = RAACommitmentOrder::CommitmentFirst;
1570 break handle_monitor_update_res!($self, e, $channel_entry, order, $raa.is_some(), true);
1575 macro_rules! handle_cs { () => {
1576 if let Some(update) = $commitment_update {
1577 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1578 node_id: counterparty_node_id,
1583 macro_rules! handle_raa { () => {
1584 if let Some(revoke_and_ack) = $raa {
1585 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1586 node_id: counterparty_node_id,
1587 msg: revoke_and_ack,
1592 RAACommitmentOrder::CommitmentFirst => {
1596 RAACommitmentOrder::RevokeAndACKFirst => {
1601 if let Some(tx) = funding_broadcastable {
1602 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1603 $self.tx_broadcaster.broadcast_transaction(&tx);
1608 if chanmon_update_is_none {
1609 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1610 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1611 // should *never* end up calling back to `chain_monitor.update_channel()`.
1612 assert!(res.is_ok());
1615 (htlc_forwards, res, counterparty_node_id)
1619 macro_rules! post_handle_chan_restoration {
1620 ($self: ident, $locked_res: expr) => { {
1621 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1623 let _ = handle_error!($self, res, counterparty_node_id);
1625 if let Some(forwards) = htlc_forwards {
1626 $self.forward_htlcs(&mut [forwards][..]);
1631 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F, L>
1632 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
1633 T::Target: BroadcasterInterface,
1634 K::Target: KeysInterface,
1635 F::Target: FeeEstimator,
1638 /// Constructs a new ChannelManager to hold several channels and route between them.
1640 /// This is the main "logic hub" for all channel-related actions, and implements
1641 /// ChannelMessageHandler.
1643 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1645 /// Users need to notify the new ChannelManager when a new block is connected or
1646 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1647 /// from after `params.latest_hash`.
1648 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1649 let mut secp_ctx = Secp256k1::new();
1650 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1651 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1652 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1654 default_configuration: config.clone(),
1655 genesis_hash: genesis_block(params.network).header.block_hash(),
1656 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1660 best_block: RwLock::new(params.best_block),
1662 channel_state: Mutex::new(ChannelHolder{
1663 by_id: HashMap::new(),
1664 claimable_htlcs: HashMap::new(),
1665 pending_msg_events: Vec::new(),
1667 outbound_scid_aliases: Mutex::new(HashSet::new()),
1668 pending_inbound_payments: Mutex::new(HashMap::new()),
1669 pending_outbound_payments: Mutex::new(HashMap::new()),
1670 forward_htlcs: Mutex::new(HashMap::new()),
1671 id_to_peer: Mutex::new(HashMap::new()),
1672 short_to_chan_info: FairRwLock::new(HashMap::new()),
1674 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1675 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1678 inbound_payment_key: expanded_inbound_key,
1679 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1681 probing_cookie_secret: keys_manager.get_secure_random_bytes(),
1683 highest_seen_timestamp: AtomicUsize::new(0),
1685 per_peer_state: RwLock::new(HashMap::new()),
1687 pending_events: Mutex::new(Vec::new()),
1688 pending_background_events: Mutex::new(Vec::new()),
1689 total_consistency_lock: RwLock::new(()),
1690 persistence_notifier: Notifier::new(),
1698 /// Gets the current configuration applied to all new channels.
1699 pub fn get_current_default_configuration(&self) -> &UserConfig {
1700 &self.default_configuration
1703 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1704 let height = self.best_block.read().unwrap().height();
1705 let mut outbound_scid_alias = 0;
1708 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1709 outbound_scid_alias += 1;
1711 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1713 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1717 if i > 1_000_000 { panic!("Your RNG is busted or we ran out of possible outbound SCID aliases (which should never happen before we run out of memory to store channels"); }
1722 /// Creates a new outbound channel to the given remote node and with the given value.
1724 /// `user_channel_id` will be provided back as in
1725 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1726 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1727 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1728 /// is simply copied to events and otherwise ignored.
1730 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1731 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1733 /// Note that we do not check if you are currently connected to the given peer. If no
1734 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1735 /// the channel eventually being silently forgotten (dropped on reload).
1737 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1738 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1739 /// [`ChannelDetails::channel_id`] until after
1740 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1741 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1742 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1744 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1745 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1746 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1747 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, override_config: Option<UserConfig>) -> Result<[u8; 32], APIError> {
1748 if channel_value_satoshis < 1000 {
1749 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1753 let per_peer_state = self.per_peer_state.read().unwrap();
1754 match per_peer_state.get(&their_network_key) {
1755 Some(peer_state) => {
1756 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1757 let peer_state = peer_state.lock().unwrap();
1758 let their_features = &peer_state.latest_features;
1759 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1760 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1761 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1762 self.best_block.read().unwrap().height(), outbound_scid_alias)
1766 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1771 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1774 let res = channel.get_open_channel(self.genesis_hash.clone());
1776 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1777 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1778 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1780 let temporary_channel_id = channel.channel_id();
1781 let mut channel_state = self.channel_state.lock().unwrap();
1782 match channel_state.by_id.entry(temporary_channel_id) {
1783 hash_map::Entry::Occupied(_) => {
1785 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1787 panic!("RNG is bad???");
1790 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1792 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1793 node_id: their_network_key,
1796 Ok(temporary_channel_id)
1799 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<K::Target as KeysInterface>::Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1800 let mut res = Vec::new();
1802 let channel_state = self.channel_state.lock().unwrap();
1803 res.reserve(channel_state.by_id.len());
1804 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1805 let balance = channel.get_available_balances();
1806 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1807 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1808 res.push(ChannelDetails {
1809 channel_id: (*channel_id).clone(),
1810 counterparty: ChannelCounterparty {
1811 node_id: channel.get_counterparty_node_id(),
1812 features: InitFeatures::empty(),
1813 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1814 forwarding_info: channel.counterparty_forwarding_info(),
1815 // Ensures that we have actually received the `htlc_minimum_msat` value
1816 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1817 // message (as they are always the first message from the counterparty).
1818 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1819 // default `0` value set by `Channel::new_outbound`.
1820 outbound_htlc_minimum_msat: if channel.have_received_message() {
1821 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1822 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1824 funding_txo: channel.get_funding_txo(),
1825 // Note that accept_channel (or open_channel) is always the first message, so
1826 // `have_received_message` indicates that type negotiation has completed.
1827 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1828 short_channel_id: channel.get_short_channel_id(),
1829 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1830 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1831 channel_value_satoshis: channel.get_value_satoshis(),
1832 unspendable_punishment_reserve: to_self_reserve_satoshis,
1833 balance_msat: balance.balance_msat,
1834 inbound_capacity_msat: balance.inbound_capacity_msat,
1835 outbound_capacity_msat: balance.outbound_capacity_msat,
1836 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1837 user_channel_id: channel.get_user_id(),
1838 confirmations_required: channel.minimum_depth(),
1839 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1840 is_outbound: channel.is_outbound(),
1841 is_channel_ready: channel.is_usable(),
1842 is_usable: channel.is_live(),
1843 is_public: channel.should_announce(),
1844 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1845 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1846 config: Some(channel.config()),
1850 let per_peer_state = self.per_peer_state.read().unwrap();
1851 for chan in res.iter_mut() {
1852 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1853 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1859 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1860 /// more information.
1861 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1862 self.list_channels_with_filter(|_| true)
1865 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1866 /// to ensure non-announced channels are used.
1868 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1869 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1872 /// [`find_route`]: crate::routing::router::find_route
1873 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1874 // Note we use is_live here instead of usable which leads to somewhat confused
1875 // internal/external nomenclature, but that's ok cause that's probably what the user
1876 // really wanted anyway.
1877 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1880 /// Helper function that issues the channel close events
1881 fn issue_channel_close_events(&self, channel: &Channel<<K::Target as KeysInterface>::Signer>, closure_reason: ClosureReason) {
1882 let mut pending_events_lock = self.pending_events.lock().unwrap();
1883 match channel.unbroadcasted_funding() {
1884 Some(transaction) => {
1885 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1889 pending_events_lock.push(events::Event::ChannelClosed {
1890 channel_id: channel.channel_id(),
1891 user_channel_id: channel.get_user_id(),
1892 reason: closure_reason
1896 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1897 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1899 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1900 let result: Result<(), _> = loop {
1901 let mut channel_state_lock = self.channel_state.lock().unwrap();
1902 let channel_state = &mut *channel_state_lock;
1903 match channel_state.by_id.entry(channel_id.clone()) {
1904 hash_map::Entry::Occupied(mut chan_entry) => {
1905 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1906 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1908 let per_peer_state = self.per_peer_state.read().unwrap();
1909 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1910 Some(peer_state) => {
1911 let peer_state = peer_state.lock().unwrap();
1912 let their_features = &peer_state.latest_features;
1913 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1915 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1917 failed_htlcs = htlcs;
1919 // Update the monitor with the shutdown script if necessary.
1920 if let Some(monitor_update) = monitor_update {
1921 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
1922 let (result, is_permanent) =
1923 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1925 remove_channel!(self, chan_entry);
1930 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1931 node_id: *counterparty_node_id,
1935 if chan_entry.get().is_shutdown() {
1936 let channel = remove_channel!(self, chan_entry);
1937 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1938 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1942 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1946 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1950 for htlc_source in failed_htlcs.drain(..) {
1951 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1952 self.fail_htlc_backwards_internal(htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
1955 let _ = handle_error!(self, result, *counterparty_node_id);
1959 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1960 /// will be accepted on the given channel, and after additional timeout/the closing of all
1961 /// pending HTLCs, the channel will be closed on chain.
1963 /// * If we are the channel initiator, we will pay between our [`Background`] and
1964 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1966 /// * If our counterparty is the channel initiator, we will require a channel closing
1967 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1968 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1969 /// counterparty to pay as much fee as they'd like, however.
1971 /// May generate a SendShutdown message event on success, which should be relayed.
1973 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1974 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1975 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1976 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1977 self.close_channel_internal(channel_id, counterparty_node_id, None)
1980 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1981 /// will be accepted on the given channel, and after additional timeout/the closing of all
1982 /// pending HTLCs, the channel will be closed on chain.
1984 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1985 /// the channel being closed or not:
1986 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1987 /// transaction. The upper-bound is set by
1988 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1989 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1990 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1991 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1992 /// will appear on a force-closure transaction, whichever is lower).
1994 /// May generate a SendShutdown message event on success, which should be relayed.
1996 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1997 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1998 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1999 pub fn close_channel_with_target_feerate(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: u32) -> Result<(), APIError> {
2000 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
2004 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
2005 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
2006 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2007 for htlc_source in failed_htlcs.drain(..) {
2008 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2009 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2010 self.fail_htlc_backwards_internal(source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
2012 if let Some((funding_txo, monitor_update)) = monitor_update_option {
2013 // There isn't anything we can do if we get an update failure - we're already
2014 // force-closing. The monitor update on the required in-memory copy should broadcast
2015 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2016 // ignore the result here.
2017 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
2021 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2022 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2023 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2024 -> Result<PublicKey, APIError> {
2026 let mut channel_state_lock = self.channel_state.lock().unwrap();
2027 let channel_state = &mut *channel_state_lock;
2028 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
2029 if chan.get().get_counterparty_node_id() != *peer_node_id {
2030 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
2032 if let Some(peer_msg) = peer_msg {
2033 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
2035 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
2037 remove_channel!(self, chan)
2039 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
2042 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2043 self.finish_force_close_channel(chan.force_shutdown(broadcast));
2044 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2045 let mut channel_state = self.channel_state.lock().unwrap();
2046 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2051 Ok(chan.get_counterparty_node_id())
2054 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2055 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2056 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2057 Ok(counterparty_node_id) => {
2058 self.channel_state.lock().unwrap().pending_msg_events.push(
2059 events::MessageSendEvent::HandleError {
2060 node_id: counterparty_node_id,
2061 action: msgs::ErrorAction::SendErrorMessage {
2062 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2072 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2073 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2074 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2076 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2077 -> Result<(), APIError> {
2078 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2081 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2082 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2083 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2085 /// You can always get the latest local transaction(s) to broadcast from
2086 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2087 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2088 -> Result<(), APIError> {
2089 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2092 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2093 /// for each to the chain and rejecting new HTLCs on each.
2094 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2095 for chan in self.list_channels() {
2096 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2100 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2101 /// local transaction(s).
2102 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2103 for chan in self.list_channels() {
2104 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2108 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2109 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2111 // final_incorrect_cltv_expiry
2112 if hop_data.outgoing_cltv_value != cltv_expiry {
2113 return Err(ReceiveError {
2114 msg: "Upstream node set CLTV to the wrong value",
2116 err_data: byte_utils::be32_to_array(cltv_expiry).to_vec()
2119 // final_expiry_too_soon
2120 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2121 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2122 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2123 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2124 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2125 if (hop_data.outgoing_cltv_value as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2126 return Err(ReceiveError {
2128 err_data: Vec::new(),
2129 msg: "The final CLTV expiry is too soon to handle",
2132 if hop_data.amt_to_forward > amt_msat {
2133 return Err(ReceiveError {
2135 err_data: byte_utils::be64_to_array(amt_msat).to_vec(),
2136 msg: "Upstream node sent less than we were supposed to receive in payment",
2140 let routing = match hop_data.format {
2141 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2142 return Err(ReceiveError {
2143 err_code: 0x4000|22,
2144 err_data: Vec::new(),
2145 msg: "Got non final data with an HMAC of 0",
2148 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2149 if payment_data.is_some() && keysend_preimage.is_some() {
2150 return Err(ReceiveError {
2151 err_code: 0x4000|22,
2152 err_data: Vec::new(),
2153 msg: "We don't support MPP keysend payments",
2155 } else if let Some(data) = payment_data {
2156 PendingHTLCRouting::Receive {
2158 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2159 phantom_shared_secret,
2161 } else if let Some(payment_preimage) = keysend_preimage {
2162 // We need to check that the sender knows the keysend preimage before processing this
2163 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2164 // could discover the final destination of X, by probing the adjacent nodes on the route
2165 // with a keysend payment of identical payment hash to X and observing the processing
2166 // time discrepancies due to a hash collision with X.
2167 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2168 if hashed_preimage != payment_hash {
2169 return Err(ReceiveError {
2170 err_code: 0x4000|22,
2171 err_data: Vec::new(),
2172 msg: "Payment preimage didn't match payment hash",
2176 PendingHTLCRouting::ReceiveKeysend {
2178 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2181 return Err(ReceiveError {
2182 err_code: 0x4000|0x2000|3,
2183 err_data: Vec::new(),
2184 msg: "We require payment_secrets",
2189 Ok(PendingHTLCInfo {
2192 incoming_shared_secret: shared_secret,
2193 incoming_amt_msat: Some(amt_msat),
2194 outgoing_amt_msat: amt_msat,
2195 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2199 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
2200 macro_rules! return_malformed_err {
2201 ($msg: expr, $err_code: expr) => {
2203 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2204 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2205 channel_id: msg.channel_id,
2206 htlc_id: msg.htlc_id,
2207 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2208 failure_code: $err_code,
2214 if let Err(_) = msg.onion_routing_packet.public_key {
2215 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2218 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2220 if msg.onion_routing_packet.version != 0 {
2221 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2222 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2223 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2224 //receiving node would have to brute force to figure out which version was put in the
2225 //packet by the node that send us the message, in the case of hashing the hop_data, the
2226 //node knows the HMAC matched, so they already know what is there...
2227 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2229 macro_rules! return_err {
2230 ($msg: expr, $err_code: expr, $data: expr) => {
2232 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2233 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2234 channel_id: msg.channel_id,
2235 htlc_id: msg.htlc_id,
2236 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
2242 let next_hop = match onion_utils::decode_next_payment_hop(shared_secret, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac, msg.payment_hash) {
2244 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2245 return_malformed_err!(err_msg, err_code);
2247 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2248 return_err!(err_msg, err_code, &[0; 0]);
2252 let pending_forward_info = match next_hop {
2253 onion_utils::Hop::Receive(next_hop_data) => {
2255 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2257 // Note that we could obviously respond immediately with an update_fulfill_htlc
2258 // message, however that would leak that we are the recipient of this payment, so
2259 // instead we stay symmetric with the forwarding case, only responding (after a
2260 // delay) once they've send us a commitment_signed!
2261 PendingHTLCStatus::Forward(info)
2263 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2266 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2267 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2268 let outgoing_packet = msgs::OnionPacket {
2270 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2271 hop_data: new_packet_bytes,
2272 hmac: next_hop_hmac.clone(),
2275 let short_channel_id = match next_hop_data.format {
2276 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2277 msgs::OnionHopDataFormat::FinalNode { .. } => {
2278 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2282 PendingHTLCStatus::Forward(PendingHTLCInfo {
2283 routing: PendingHTLCRouting::Forward {
2284 onion_packet: outgoing_packet,
2287 payment_hash: msg.payment_hash.clone(),
2288 incoming_shared_secret: shared_secret,
2289 incoming_amt_msat: Some(msg.amount_msat),
2290 outgoing_amt_msat: next_hop_data.amt_to_forward,
2291 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2296 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2297 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2298 // with a short_channel_id of 0. This is important as various things later assume
2299 // short_channel_id is non-0 in any ::Forward.
2300 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2301 if let Some((err, code, chan_update)) = loop {
2302 let id_option = self.short_to_chan_info.read().unwrap().get(&short_channel_id).cloned();
2303 let mut channel_state = self.channel_state.lock().unwrap();
2304 let forwarding_id_opt = match id_option {
2305 None => { // unknown_next_peer
2306 // Note that this is likely a timing oracle for detecting whether an scid is a
2308 if fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash) {
2311 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2314 Some((_cp_id, chan_id)) => Some(chan_id.clone()),
2316 let chan_update_opt = if let Some(forwarding_id) = forwarding_id_opt {
2317 let chan = match channel_state.by_id.get_mut(&forwarding_id) {
2319 // Channel was removed. The short_to_chan_info and by_id maps have
2320 // no consistency guarantees.
2321 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2325 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2326 // Note that the behavior here should be identical to the above block - we
2327 // should NOT reveal the existence or non-existence of a private channel if
2328 // we don't allow forwards outbound over them.
2329 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2331 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2332 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2333 // "refuse to forward unless the SCID alias was used", so we pretend
2334 // we don't have the channel here.
2335 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2337 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2339 // Note that we could technically not return an error yet here and just hope
2340 // that the connection is reestablished or monitor updated by the time we get
2341 // around to doing the actual forward, but better to fail early if we can and
2342 // hopefully an attacker trying to path-trace payments cannot make this occur
2343 // on a small/per-node/per-channel scale.
2344 if !chan.is_live() { // channel_disabled
2345 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2347 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2348 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2350 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2351 break Some((err, code, chan_update_opt));
2355 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
2357 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2364 let cur_height = self.best_block.read().unwrap().height() + 1;
2365 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2366 // but we want to be robust wrt to counterparty packet sanitization (see
2367 // HTLC_FAIL_BACK_BUFFER rationale).
2368 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2369 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2371 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2372 break Some(("CLTV expiry is too far in the future", 21, None));
2374 // If the HTLC expires ~now, don't bother trying to forward it to our
2375 // counterparty. They should fail it anyway, but we don't want to bother with
2376 // the round-trips or risk them deciding they definitely want the HTLC and
2377 // force-closing to ensure they get it if we're offline.
2378 // We previously had a much more aggressive check here which tried to ensure
2379 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2380 // but there is no need to do that, and since we're a bit conservative with our
2381 // risk threshold it just results in failing to forward payments.
2382 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2383 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2389 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2390 if let Some(chan_update) = chan_update {
2391 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2392 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2394 else if code == 0x1000 | 13 {
2395 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2397 else if code == 0x1000 | 20 {
2398 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2399 0u16.write(&mut res).expect("Writes cannot fail");
2401 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2402 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2403 chan_update.write(&mut res).expect("Writes cannot fail");
2405 return_err!(err, code, &res.0[..]);
2410 pending_forward_info
2413 /// Gets the current channel_update for the given channel. This first checks if the channel is
2414 /// public, and thus should be called whenever the result is going to be passed out in a
2415 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2417 /// May be called with channel_state already locked!
2418 fn get_channel_update_for_broadcast(&self, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2419 if !chan.should_announce() {
2420 return Err(LightningError {
2421 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2422 action: msgs::ErrorAction::IgnoreError
2425 if chan.get_short_channel_id().is_none() {
2426 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2428 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2429 self.get_channel_update_for_unicast(chan)
2432 /// Gets the current channel_update for the given channel. This does not check if the channel
2433 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2434 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2435 /// provided evidence that they know about the existence of the channel.
2436 /// May be called with channel_state already locked!
2437 fn get_channel_update_for_unicast(&self, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2438 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2439 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2440 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2444 self.get_channel_update_for_onion(short_channel_id, chan)
2446 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2447 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2448 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2450 let unsigned = msgs::UnsignedChannelUpdate {
2451 chain_hash: self.genesis_hash,
2453 timestamp: chan.get_update_time_counter(),
2454 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2455 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2456 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2457 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2458 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2459 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2460 excess_data: Vec::new(),
2463 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2464 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2466 Ok(msgs::ChannelUpdate {
2472 // Only public for testing, this should otherwise never be called direcly
2473 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_params: &Option<PaymentParameters>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, payment_id: PaymentId, keysend_preimage: &Option<PaymentPreimage>, session_priv_bytes: [u8; 32]) -> Result<(), APIError> {
2474 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2475 let prng_seed = self.keys_manager.get_secure_random_bytes();
2476 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2478 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2479 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
2480 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2481 if onion_utils::route_size_insane(&onion_payloads) {
2482 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
2484 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2486 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2488 let err: Result<(), _> = loop {
2489 let id = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2490 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2491 Some((_cp_id, chan_id)) => chan_id.clone(),
2494 let mut channel_lock = self.channel_state.lock().unwrap();
2495 let channel_state = &mut *channel_lock;
2496 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
2498 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
2499 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
2501 if !chan.get().is_live() {
2502 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2504 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2505 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2507 session_priv: session_priv.clone(),
2508 first_hop_htlc_msat: htlc_msat,
2510 payment_secret: payment_secret.clone(),
2511 payment_params: payment_params.clone(),
2512 }, onion_packet, &self.logger),
2515 Some((update_add, commitment_signed, monitor_update)) => {
2516 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
2517 let chan_id = chan.get().channel_id();
2519 handle_monitor_update_res!(self, update_err, chan,
2520 RAACommitmentOrder::CommitmentFirst, false, true))
2522 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2523 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {},
2524 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2525 // Note that MonitorUpdateInProgress here indicates (per function
2526 // docs) that we will resend the commitment update once monitor
2527 // updating completes. Therefore, we must return an error
2528 // indicating that it is unsafe to retry the payment wholesale,
2529 // which we do in the send_payment check for
2530 // MonitorUpdateInProgress, below.
2531 return Err(APIError::MonitorUpdateInProgress);
2533 _ => unreachable!(),
2536 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2537 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2538 node_id: path.first().unwrap().pubkey,
2539 updates: msgs::CommitmentUpdate {
2540 update_add_htlcs: vec![update_add],
2541 update_fulfill_htlcs: Vec::new(),
2542 update_fail_htlcs: Vec::new(),
2543 update_fail_malformed_htlcs: Vec::new(),
2552 // The channel was likely removed after we fetched the id from the
2553 // `short_to_chan_info` map, but before we successfully locked the `by_id` map.
2554 // This can occur as no consistency guarantees exists between the two maps.
2555 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2560 match handle_error!(self, err, path.first().unwrap().pubkey) {
2561 Ok(_) => unreachable!(),
2563 Err(APIError::ChannelUnavailable { err: e.err })
2568 /// Sends a payment along a given route.
2570 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2571 /// fields for more info.
2573 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2574 /// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
2575 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2576 /// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
2579 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2580 /// tracking of payments, including state to indicate once a payment has completed. Because you
2581 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2582 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2583 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2585 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2586 /// [`PeerManager::process_events`]).
2588 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2589 /// each entry matching the corresponding-index entry in the route paths, see
2590 /// PaymentSendFailure for more info.
2592 /// In general, a path may raise:
2593 /// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
2594 /// node public key) is specified.
2595 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2596 /// (including due to previous monitor update failure or new permanent monitor update
2598 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2599 /// relevant updates.
2601 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2602 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2603 /// different route unless you intend to pay twice!
2605 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2606 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2607 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2608 /// must not contain multiple paths as multi-path payments require a recipient-provided
2611 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2612 /// bit set (either as required or as available). If multiple paths are present in the Route,
2613 /// we assume the invoice had the basic_mpp feature set.
2615 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2616 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2617 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2618 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, route)?;
2619 self.send_payment_internal(route, payment_hash, payment_secret, None, payment_id, None, onion_session_privs)
2623 pub(crate) fn test_add_new_pending_payment(&self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
2624 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, route)
2627 fn add_new_pending_payment(&self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
2628 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
2629 for _ in 0..route.paths.len() {
2630 onion_session_privs.push(self.keys_manager.get_secure_random_bytes());
2633 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2634 match pending_outbounds.entry(payment_id) {
2635 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::ParameterError(APIError::RouteError {
2636 err: "Payment already in progress"
2638 hash_map::Entry::Vacant(entry) => {
2639 let payment = entry.insert(PendingOutboundPayment::Retryable {
2640 session_privs: HashSet::new(),
2641 pending_amt_msat: 0,
2642 pending_fee_msat: Some(0),
2645 starting_block_height: self.best_block.read().unwrap().height(),
2646 total_msat: route.get_total_amount(),
2649 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
2650 assert!(payment.insert(*session_priv_bytes, path));
2653 Ok(onion_session_privs)
2658 fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
2659 if route.paths.len() < 1 {
2660 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2662 if payment_secret.is_none() && route.paths.len() > 1 {
2663 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2665 let mut total_value = 0;
2666 let our_node_id = self.get_our_node_id();
2667 let mut path_errs = Vec::with_capacity(route.paths.len());
2668 'path_check: for path in route.paths.iter() {
2669 if path.len() < 1 || path.len() > 20 {
2670 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2671 continue 'path_check;
2673 for (idx, hop) in path.iter().enumerate() {
2674 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2675 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2676 continue 'path_check;
2679 total_value += path.last().unwrap().fee_msat;
2680 path_errs.push(Ok(()));
2682 if path_errs.iter().any(|e| e.is_err()) {
2683 return Err(PaymentSendFailure::PathParameterError(path_errs));
2685 if let Some(amt_msat) = recv_value_msat {
2686 debug_assert!(amt_msat >= total_value);
2687 total_value = amt_msat;
2690 let cur_height = self.best_block.read().unwrap().height() + 1;
2691 let mut results = Vec::new();
2692 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
2693 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
2694 let mut path_res = self.send_payment_along_path(&path, &route.payment_params, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage, session_priv);
2697 Err(APIError::MonitorUpdateInProgress) => {
2698 // While a MonitorUpdateInProgress is an Err(_), the payment is still
2699 // considered "in flight" and we shouldn't remove it from the
2700 // PendingOutboundPayment set.
2703 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2704 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
2705 let removed = payment.remove(&session_priv, Some(path));
2706 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
2708 debug_assert!(false, "This can't happen as the payment was added by callers");
2709 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
2713 results.push(path_res);
2715 let mut has_ok = false;
2716 let mut has_err = false;
2717 let mut pending_amt_unsent = 0;
2718 let mut max_unsent_cltv_delta = 0;
2719 for (res, path) in results.iter().zip(route.paths.iter()) {
2720 if res.is_ok() { has_ok = true; }
2721 if res.is_err() { has_err = true; }
2722 if let &Err(APIError::MonitorUpdateInProgress) = res {
2723 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
2727 } else if res.is_err() {
2728 pending_amt_unsent += path.last().unwrap().fee_msat;
2729 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
2732 if has_err && has_ok {
2733 Err(PaymentSendFailure::PartialFailure {
2736 failed_paths_retry: if pending_amt_unsent != 0 {
2737 if let Some(payment_params) = &route.payment_params {
2738 Some(RouteParameters {
2739 payment_params: payment_params.clone(),
2740 final_value_msat: pending_amt_unsent,
2741 final_cltv_expiry_delta: max_unsent_cltv_delta,
2747 // If we failed to send any paths, we should remove the new PaymentId from the
2748 // `pending_outbound_payments` map, as the user isn't expected to `abandon_payment`.
2749 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
2750 debug_assert!(removed, "We should always have a pending payment to remove here");
2751 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2757 /// Retries a payment along the given [`Route`].
2759 /// Errors returned are a superset of those returned from [`send_payment`], so see
2760 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2761 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2762 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2763 /// further retries have been disabled with [`abandon_payment`].
2765 /// [`send_payment`]: [`ChannelManager::send_payment`]
2766 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2767 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2768 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2769 for path in route.paths.iter() {
2770 if path.len() == 0 {
2771 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2772 err: "length-0 path in route".to_string()
2777 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
2778 for _ in 0..route.paths.len() {
2779 onion_session_privs.push(self.keys_manager.get_secure_random_bytes());
2782 let (total_msat, payment_hash, payment_secret) = {
2783 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2784 match outbounds.get_mut(&payment_id) {
2786 let res = match payment {
2787 PendingOutboundPayment::Retryable {
2788 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2790 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2791 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2792 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2793 err: format!("retry_amt_msat of {} will put pending_amt_msat (currently: {}) more than 10% over total_payment_amt_msat of {}", retry_amt_msat, pending_amt_msat, total_msat).to_string()
2796 (*total_msat, *payment_hash, *payment_secret)
2798 PendingOutboundPayment::Legacy { .. } => {
2799 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2800 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2803 PendingOutboundPayment::Fulfilled { .. } => {
2804 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2805 err: "Payment already completed".to_owned()
2808 PendingOutboundPayment::Abandoned { .. } => {
2809 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2810 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
2814 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
2815 assert!(payment.insert(*session_priv_bytes, path));
2820 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2821 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2825 self.send_payment_internal(route, payment_hash, &payment_secret, None, payment_id, Some(total_msat), onion_session_privs)
2828 /// Signals that no further retries for the given payment will occur.
2830 /// After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
2831 /// will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
2832 /// an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
2833 /// pending HTLCs for this payment.
2835 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2836 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2837 /// determine the ultimate status of a payment.
2839 /// [`retry_payment`]: Self::retry_payment
2840 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2841 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2842 pub fn abandon_payment(&self, payment_id: PaymentId) {
2843 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2845 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2846 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
2847 if let Ok(()) = payment.get_mut().mark_abandoned() {
2848 if payment.get().remaining_parts() == 0 {
2849 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
2851 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
2859 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2860 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2861 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2862 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2863 /// never reach the recipient.
2865 /// See [`send_payment`] documentation for more details on the return value of this function
2866 /// and idempotency guarantees provided by the [`PaymentId`] key.
2868 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2869 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2871 /// Note that `route` must have exactly one path.
2873 /// [`send_payment`]: Self::send_payment
2874 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2875 let preimage = match payment_preimage {
2877 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2879 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2880 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route)?;
2882 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), payment_id, None, onion_session_privs) {
2883 Ok(()) => Ok(payment_hash),
2888 /// Send a payment that is probing the given route for liquidity. We calculate the
2889 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2890 /// us to easily discern them from real payments.
2891 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2892 let payment_id = PaymentId(self.keys_manager.get_secure_random_bytes());
2894 let payment_hash = self.probing_cookie_from_id(&payment_id);
2897 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2898 err: "No need probing a path with less than two hops".to_string()
2902 let route = Route { paths: vec![hops], payment_params: None };
2903 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route)?;
2905 match self.send_payment_internal(&route, payment_hash, &None, None, payment_id, None, onion_session_privs) {
2906 Ok(()) => Ok((payment_hash, payment_id)),
2911 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2913 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2914 let target_payment_hash = self.probing_cookie_from_id(payment_id);
2915 target_payment_hash == *payment_hash
2918 /// Returns the 'probing cookie' for the given [`PaymentId`].
2919 fn probing_cookie_from_id(&self, payment_id: &PaymentId) -> PaymentHash {
2920 let mut preimage = [0u8; 64];
2921 preimage[..32].copy_from_slice(&self.probing_cookie_secret);
2922 preimage[32..].copy_from_slice(&payment_id.0);
2923 PaymentHash(Sha256::hash(&preimage).into_inner())
2926 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2927 /// which checks the correctness of the funding transaction given the associated channel.
2928 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<K::Target as KeysInterface>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2929 &self, temporary_channel_id: &[u8; 32], _counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2930 ) -> Result<(), APIError> {
2932 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2934 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2936 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2937 .map_err(|e| if let ChannelError::Close(msg) = e {
2938 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2939 } else { unreachable!(); })
2942 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2944 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2945 Ok(funding_msg) => {
2948 Err(_) => { return Err(APIError::ChannelUnavailable {
2949 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()
2954 let mut channel_state = self.channel_state.lock().unwrap();
2955 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2956 node_id: chan.get_counterparty_node_id(),
2959 match channel_state.by_id.entry(chan.channel_id()) {
2960 hash_map::Entry::Occupied(_) => {
2961 panic!("Generated duplicate funding txid?");
2963 hash_map::Entry::Vacant(e) => {
2964 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2965 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2966 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2975 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
2976 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2977 Ok(OutPoint { txid: tx.txid(), index: output_index })
2981 /// Call this upon creation of a funding transaction for the given channel.
2983 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2984 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2986 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2987 /// across the p2p network.
2989 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2990 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2992 /// May panic if the output found in the funding transaction is duplicative with some other
2993 /// channel (note that this should be trivially prevented by using unique funding transaction
2994 /// keys per-channel).
2996 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2997 /// counterparty's signature the funding transaction will automatically be broadcast via the
2998 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3000 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3001 /// not currently support replacing a funding transaction on an existing channel. Instead,
3002 /// create a new channel with a conflicting funding transaction.
3004 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3005 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3006 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3007 /// for more details.
3009 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
3010 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
3011 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3012 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3014 for inp in funding_transaction.input.iter() {
3015 if inp.witness.is_empty() {
3016 return Err(APIError::APIMisuseError {
3017 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3022 let height = self.best_block.read().unwrap().height();
3023 // Transactions are evaluated as final by network mempools at the next block. However, the modules
3024 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
3025 // the wallet module is in advance on the LDK view, allow one more block of headroom.
3026 if !funding_transaction.input.iter().all(|input| input.sequence == Sequence::MAX) && LockTime::from(funding_transaction.lock_time).is_block_height() && funding_transaction.lock_time.0 > height + 2 {
3027 return Err(APIError::APIMisuseError {
3028 err: "Funding transaction absolute timelock is non-final".to_owned()
3032 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3033 let mut output_index = None;
3034 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
3035 for (idx, outp) in tx.output.iter().enumerate() {
3036 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
3037 if output_index.is_some() {
3038 return Err(APIError::APIMisuseError {
3039 err: "Multiple outputs matched the expected script and value".to_owned()
3042 if idx > u16::max_value() as usize {
3043 return Err(APIError::APIMisuseError {
3044 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3047 output_index = Some(idx as u16);
3050 if output_index.is_none() {
3051 return Err(APIError::APIMisuseError {
3052 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3055 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3059 /// Atomically updates the [`ChannelConfig`] for the given channels.
3061 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3062 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3063 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3064 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3066 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3067 /// `counterparty_node_id` is provided.
3069 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3070 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3072 /// If an error is returned, none of the updates should be considered applied.
3074 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3075 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3076 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3077 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3078 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3079 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3080 /// [`APIMisuseError`]: APIError::APIMisuseError
3081 pub fn update_channel_config(
3082 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
3083 ) -> Result<(), APIError> {
3084 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
3085 return Err(APIError::APIMisuseError {
3086 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3090 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
3091 &self.total_consistency_lock, &self.persistence_notifier,
3094 let mut channel_state_lock = self.channel_state.lock().unwrap();
3095 let channel_state = &mut *channel_state_lock;
3096 for channel_id in channel_ids {
3097 let channel_counterparty_node_id = channel_state.by_id.get(channel_id)
3098 .ok_or(APIError::ChannelUnavailable {
3099 err: format!("Channel with ID {} was not found", log_bytes!(*channel_id)),
3101 .get_counterparty_node_id();
3102 if channel_counterparty_node_id != *counterparty_node_id {
3103 return Err(APIError::APIMisuseError {
3104 err: "counterparty node id mismatch".to_owned(),
3108 for channel_id in channel_ids {
3109 let channel = channel_state.by_id.get_mut(channel_id).unwrap();
3110 if !channel.update_config(config) {
3113 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3114 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3115 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3116 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3117 node_id: channel.get_counterparty_node_id(),
3126 /// Processes HTLCs which are pending waiting on random forward delay.
3128 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3129 /// Will likely generate further events.
3130 pub fn process_pending_htlc_forwards(&self) {
3131 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3133 let mut new_events = Vec::new();
3134 let mut failed_forwards = Vec::new();
3135 let mut phantom_receives: Vec<(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3136 let mut handle_errors = Vec::new();
3138 let mut forward_htlcs = HashMap::new();
3139 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3141 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3142 let mut channel_state_lock = self.channel_state.lock().unwrap();
3143 let channel_state = &mut *channel_state_lock;
3144 if short_chan_id != 0 {
3145 macro_rules! forwarding_channel_not_found {
3147 for forward_info in pending_forwards.drain(..) {
3148 match forward_info {
3149 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3150 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint,
3151 forward_info: PendingHTLCInfo {
3152 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3153 outgoing_cltv_value, incoming_amt_msat: _
3156 macro_rules! failure_handler {
3157 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3158 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3160 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3161 short_channel_id: prev_short_channel_id,
3162 outpoint: prev_funding_outpoint,
3163 htlc_id: prev_htlc_id,
3164 incoming_packet_shared_secret: incoming_shared_secret,
3165 phantom_shared_secret: $phantom_ss,
3168 let reason = if $next_hop_unknown {
3169 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3171 HTLCDestination::FailedPayment{ payment_hash }
3174 failed_forwards.push((htlc_source, payment_hash,
3175 HTLCFailReason::Reason { failure_code: $err_code, data: $err_data },
3181 macro_rules! fail_forward {
3182 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3184 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3188 macro_rules! failed_payment {
3189 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3191 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3195 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3196 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
3197 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3198 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
3199 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3201 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3202 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3203 // In this scenario, the phantom would have sent us an
3204 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3205 // if it came from us (the second-to-last hop) but contains the sha256
3207 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3209 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3210 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3214 onion_utils::Hop::Receive(hop_data) => {
3215 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
3216 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, vec![(info, prev_htlc_id)])),
3217 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3223 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3226 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3229 HTLCForwardInfo::FailHTLC { .. } => {
3230 // Channel went away before we could fail it. This implies
3231 // the channel is now on chain and our counterparty is
3232 // trying to broadcast the HTLC-Timeout, but that's their
3233 // problem, not ours.
3239 let forward_chan_id = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3240 Some((_cp_id, chan_id)) => chan_id.clone(),
3242 forwarding_channel_not_found!();
3246 match channel_state.by_id.entry(forward_chan_id) {
3247 hash_map::Entry::Vacant(_) => {
3248 forwarding_channel_not_found!();
3251 hash_map::Entry::Occupied(mut chan) => {
3252 let mut add_htlc_msgs = Vec::new();
3253 let mut fail_htlc_msgs = Vec::new();
3254 for forward_info in pending_forwards.drain(..) {
3255 match forward_info {
3256 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3257 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint ,
3258 forward_info: PendingHTLCInfo {
3259 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3260 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
3263 log_trace!(self.logger, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", prev_short_channel_id, log_bytes!(payment_hash.0), short_chan_id);
3264 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3265 short_channel_id: prev_short_channel_id,
3266 outpoint: prev_funding_outpoint,
3267 htlc_id: prev_htlc_id,
3268 incoming_packet_shared_secret: incoming_shared_secret,
3269 // Phantom payments are only PendingHTLCRouting::Receive.
3270 phantom_shared_secret: None,
3272 match chan.get_mut().send_htlc(outgoing_amt_msat, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet, &self.logger) {
3274 if let ChannelError::Ignore(msg) = e {
3275 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3277 panic!("Stated return value requirements in send_htlc() were not met");
3279 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3280 failed_forwards.push((htlc_source, payment_hash,
3281 HTLCFailReason::Reason { failure_code, data },
3282 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3288 Some(msg) => { add_htlc_msgs.push(msg); },
3290 // Nothing to do here...we're waiting on a remote
3291 // revoke_and_ack before we can add anymore HTLCs. The Channel
3292 // will automatically handle building the update_add_htlc and
3293 // commitment_signed messages when we can.
3294 // TODO: Do some kind of timer to set the channel as !is_live()
3295 // as we don't really want others relying on us relaying through
3296 // this channel currently :/.
3302 HTLCForwardInfo::AddHTLC { .. } => {
3303 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3305 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3306 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3307 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
3309 if let ChannelError::Ignore(msg) = e {
3310 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3312 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
3314 // fail-backs are best-effort, we probably already have one
3315 // pending, and if not that's OK, if not, the channel is on
3316 // the chain and sending the HTLC-Timeout is their problem.
3319 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
3321 // Nothing to do here...we're waiting on a remote
3322 // revoke_and_ack before we can update the commitment
3323 // transaction. The Channel will automatically handle
3324 // building the update_fail_htlc and commitment_signed
3325 // messages when we can.
3326 // We don't need any kind of timer here as they should fail
3327 // the channel onto the chain if they can't get our
3328 // update_fail_htlc in time, it's not our problem.
3335 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
3336 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
3339 // We surely failed send_commitment due to bad keys, in that case
3340 // close channel and then send error message to peer.
3341 let counterparty_node_id = chan.get().get_counterparty_node_id();
3342 let err: Result<(), _> = match e {
3343 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
3344 panic!("Stated return value requirements in send_commitment() were not met");
3346 ChannelError::Close(msg) => {
3347 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
3348 let mut channel = remove_channel!(self, chan);
3349 // ChannelClosed event is generated by handle_error for us.
3350 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
3353 handle_errors.push((counterparty_node_id, err));
3357 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3358 ChannelMonitorUpdateStatus::Completed => {},
3360 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
3364 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
3365 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
3366 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3367 node_id: chan.get().get_counterparty_node_id(),
3368 updates: msgs::CommitmentUpdate {
3369 update_add_htlcs: add_htlc_msgs,
3370 update_fulfill_htlcs: Vec::new(),
3371 update_fail_htlcs: fail_htlc_msgs,
3372 update_fail_malformed_htlcs: Vec::new(),
3374 commitment_signed: commitment_msg,
3381 for forward_info in pending_forwards.drain(..) {
3382 match forward_info {
3383 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3384 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint,
3385 forward_info: PendingHTLCInfo {
3386 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3389 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3390 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3391 let _legacy_hop_data = Some(payment_data.clone());
3392 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3394 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3395 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3397 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3400 let claimable_htlc = ClaimableHTLC {
3401 prev_hop: HTLCPreviousHopData {
3402 short_channel_id: prev_short_channel_id,
3403 outpoint: prev_funding_outpoint,
3404 htlc_id: prev_htlc_id,
3405 incoming_packet_shared_secret: incoming_shared_secret,
3406 phantom_shared_secret,
3408 value: outgoing_amt_msat,
3410 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3415 macro_rules! fail_htlc {
3416 ($htlc: expr, $payment_hash: expr) => {
3417 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
3418 htlc_msat_height_data.extend_from_slice(
3419 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
3421 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3422 short_channel_id: $htlc.prev_hop.short_channel_id,
3423 outpoint: prev_funding_outpoint,
3424 htlc_id: $htlc.prev_hop.htlc_id,
3425 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3426 phantom_shared_secret,
3428 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data },
3429 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3434 macro_rules! check_total_value {
3435 ($payment_data: expr, $payment_preimage: expr) => {{
3436 let mut payment_received_generated = false;
3438 events::PaymentPurpose::InvoicePayment {
3439 payment_preimage: $payment_preimage,
3440 payment_secret: $payment_data.payment_secret,
3443 let (_, htlcs) = channel_state.claimable_htlcs.entry(payment_hash)
3444 .or_insert_with(|| (purpose(), Vec::new()));
3445 if htlcs.len() == 1 {
3446 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3447 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we already had an existing keysend HTLC with the same payment hash", log_bytes!(payment_hash.0));
3448 fail_htlc!(claimable_htlc, payment_hash);
3452 let mut total_value = claimable_htlc.value;
3453 for htlc in htlcs.iter() {
3454 total_value += htlc.value;
3455 match &htlc.onion_payload {
3456 OnionPayload::Invoice { .. } => {
3457 if htlc.total_msat != $payment_data.total_msat {
3458 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3459 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3460 total_value = msgs::MAX_VALUE_MSAT;
3462 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3464 _ => unreachable!(),
3467 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3468 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3469 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3470 fail_htlc!(claimable_htlc, payment_hash);
3471 } else if total_value == $payment_data.total_msat {
3472 htlcs.push(claimable_htlc);
3473 new_events.push(events::Event::PaymentReceived {
3476 amount_msat: total_value,
3478 payment_received_generated = true;
3480 // Nothing to do - we haven't reached the total
3481 // payment value yet, wait until we receive more
3483 htlcs.push(claimable_htlc);
3485 payment_received_generated
3489 // Check that the payment hash and secret are known. Note that we
3490 // MUST take care to handle the "unknown payment hash" and
3491 // "incorrect payment secret" cases here identically or we'd expose
3492 // that we are the ultimate recipient of the given payment hash.
3493 // Further, we must not expose whether we have any other HTLCs
3494 // associated with the same payment_hash pending or not.
3495 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3496 match payment_secrets.entry(payment_hash) {
3497 hash_map::Entry::Vacant(_) => {
3498 match claimable_htlc.onion_payload {
3499 OnionPayload::Invoice { .. } => {
3500 let payment_data = payment_data.unwrap();
3501 let payment_preimage = match inbound_payment::verify(payment_hash, &payment_data, self.highest_seen_timestamp.load(Ordering::Acquire) as u64, &self.inbound_payment_key, &self.logger) {
3502 Ok(payment_preimage) => payment_preimage,
3504 fail_htlc!(claimable_htlc, payment_hash);
3508 check_total_value!(payment_data, payment_preimage);
3510 OnionPayload::Spontaneous(preimage) => {
3511 match channel_state.claimable_htlcs.entry(payment_hash) {
3512 hash_map::Entry::Vacant(e) => {
3513 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3514 e.insert((purpose.clone(), vec![claimable_htlc]));
3515 new_events.push(events::Event::PaymentReceived {
3517 amount_msat: outgoing_amt_msat,
3521 hash_map::Entry::Occupied(_) => {
3522 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3523 fail_htlc!(claimable_htlc, payment_hash);
3529 hash_map::Entry::Occupied(inbound_payment) => {
3530 if payment_data.is_none() {
3531 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} because we already have an inbound payment with the same payment hash", log_bytes!(payment_hash.0));
3532 fail_htlc!(claimable_htlc, payment_hash);
3535 let payment_data = payment_data.unwrap();
3536 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3537 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3538 fail_htlc!(claimable_htlc, payment_hash);
3539 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3540 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3541 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3542 fail_htlc!(claimable_htlc, payment_hash);
3544 let payment_received_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3545 if payment_received_generated {
3546 inbound_payment.remove_entry();
3552 HTLCForwardInfo::FailHTLC { .. } => {
3553 panic!("Got pending fail of our own HTLC");
3561 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3562 self.fail_htlc_backwards_internal(htlc_source, &payment_hash, failure_reason, destination);
3564 self.forward_htlcs(&mut phantom_receives);
3566 for (counterparty_node_id, err) in handle_errors.drain(..) {
3567 let _ = handle_error!(self, err, counterparty_node_id);
3570 if new_events.is_empty() { return }
3571 let mut events = self.pending_events.lock().unwrap();
3572 events.append(&mut new_events);
3575 /// Free the background events, generally called from timer_tick_occurred.
3577 /// Exposed for testing to allow us to process events quickly without generating accidental
3578 /// BroadcastChannelUpdate events in timer_tick_occurred.
3580 /// Expects the caller to have a total_consistency_lock read lock.
3581 fn process_background_events(&self) -> bool {
3582 let mut background_events = Vec::new();
3583 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3584 if background_events.is_empty() {
3588 for event in background_events.drain(..) {
3590 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3591 // The channel has already been closed, so no use bothering to care about the
3592 // monitor updating completing.
3593 let _ = self.chain_monitor.update_channel(funding_txo, update);
3600 #[cfg(any(test, feature = "_test_utils"))]
3601 /// Process background events, for functional testing
3602 pub fn test_process_background_events(&self) {
3603 self.process_background_events();
3606 fn update_channel_fee(&self, pending_msg_events: &mut Vec<events::MessageSendEvent>, chan_id: &[u8; 32], chan: &mut Channel<<K::Target as KeysInterface>::Signer>, new_feerate: u32) -> (bool, NotifyOption, Result<(), MsgHandleErrInternal>) {
3607 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
3608 // If the feerate has decreased by less than half, don't bother
3609 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3610 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3611 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3612 return (true, NotifyOption::SkipPersist, Ok(()));
3614 if !chan.is_live() {
3615 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {} as it cannot currently be updated (probably the peer is disconnected).",
3616 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3617 return (true, NotifyOption::SkipPersist, Ok(()));
3619 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3620 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3622 let mut retain_channel = true;
3623 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
3626 let (drop, res) = convert_chan_err!(self, e, chan, chan_id);
3627 if drop { retain_channel = false; }
3631 let ret_err = match res {
3632 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
3633 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3634 ChannelMonitorUpdateStatus::Completed => {
3635 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3636 node_id: chan.get_counterparty_node_id(),
3637 updates: msgs::CommitmentUpdate {
3638 update_add_htlcs: Vec::new(),
3639 update_fulfill_htlcs: Vec::new(),
3640 update_fail_htlcs: Vec::new(),
3641 update_fail_malformed_htlcs: Vec::new(),
3642 update_fee: Some(update_fee),
3649 let (res, drop) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, chan_id, COMMITMENT_UPDATE_ONLY);
3650 if drop { retain_channel = false; }
3658 (retain_channel, NotifyOption::DoPersist, ret_err)
3662 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3663 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3664 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3665 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3666 pub fn maybe_update_chan_fees(&self) {
3667 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3668 let mut should_persist = NotifyOption::SkipPersist;
3670 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3672 let mut handle_errors = Vec::new();
3674 let mut channel_state_lock = self.channel_state.lock().unwrap();
3675 let channel_state = &mut *channel_state_lock;
3676 let pending_msg_events = &mut channel_state.pending_msg_events;
3677 channel_state.by_id.retain(|chan_id, chan| {
3678 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(pending_msg_events, chan_id, chan, new_feerate);
3679 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3681 handle_errors.push(err);
3691 fn remove_stale_resolved_payments(&self) {
3692 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
3693 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
3694 // this could race the user making a duplicate send_payment call and our idempotency
3695 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
3696 // removal. This should be more than sufficient to ensure the idempotency of any
3697 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
3699 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
3700 let pending_events = self.pending_events.lock().unwrap();
3701 pending_outbound_payments.retain(|payment_id, payment| {
3702 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
3703 let mut no_remaining_entries = session_privs.is_empty();
3704 if no_remaining_entries {
3705 for ev in pending_events.iter() {
3707 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
3708 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
3709 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
3710 if payment_id == ev_payment_id {
3711 no_remaining_entries = false;
3719 if no_remaining_entries {
3720 *timer_ticks_without_htlcs += 1;
3721 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
3723 *timer_ticks_without_htlcs = 0;
3730 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3732 /// This currently includes:
3733 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3734 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3735 /// than a minute, informing the network that they should no longer attempt to route over
3737 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3738 /// with the current `ChannelConfig`.
3740 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3741 /// estimate fetches.
3742 pub fn timer_tick_occurred(&self) {
3743 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3744 let mut should_persist = NotifyOption::SkipPersist;
3745 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3747 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3749 let mut handle_errors = Vec::new();
3750 let mut timed_out_mpp_htlcs = Vec::new();
3752 let mut channel_state_lock = self.channel_state.lock().unwrap();
3753 let channel_state = &mut *channel_state_lock;
3754 let pending_msg_events = &mut channel_state.pending_msg_events;
3755 channel_state.by_id.retain(|chan_id, chan| {
3756 let counterparty_node_id = chan.get_counterparty_node_id();
3757 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(pending_msg_events, chan_id, chan, new_feerate);
3758 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3760 handle_errors.push((err, counterparty_node_id));
3762 if !retain_channel { return false; }
3764 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3765 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3766 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
3767 if needs_close { return false; }
3770 match chan.channel_update_status() {
3771 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3772 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3773 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3774 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3775 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3776 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3777 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3781 should_persist = NotifyOption::DoPersist;
3782 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3784 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3785 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3786 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3790 should_persist = NotifyOption::DoPersist;
3791 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3796 chan.maybe_expire_prev_config();
3801 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3802 if htlcs.is_empty() {
3803 // This should be unreachable
3804 debug_assert!(false);
3807 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3808 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3809 // In this case we're not going to handle any timeouts of the parts here.
3810 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3812 } else if htlcs.into_iter().any(|htlc| {
3813 htlc.timer_ticks += 1;
3814 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3816 timed_out_mpp_htlcs.extend(htlcs.into_iter().map(|htlc| (htlc.prev_hop.clone(), payment_hash.clone())));
3824 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3825 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3826 self.fail_htlc_backwards_internal(HTLCSource::PreviousHopData(htlc_source.0.clone()), &htlc_source.1, HTLCFailReason::Reason { failure_code: 23, data: Vec::new() }, receiver );
3829 for (err, counterparty_node_id) in handle_errors.drain(..) {
3830 let _ = handle_error!(self, err, counterparty_node_id);
3833 self.remove_stale_resolved_payments();
3839 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3840 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
3841 /// along the path (including in our own channel on which we received it).
3843 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3844 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3845 /// second copy of) the [`events::Event::PaymentReceived`] event. Alternatively, the payment
3846 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3848 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3849 /// [`ChannelManager::claim_funds`]), you should still monitor for
3850 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3851 /// startup during which time claims that were in-progress at shutdown may be replayed.
3852 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3853 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3855 let removed_source = {
3856 let mut channel_state = self.channel_state.lock().unwrap();
3857 channel_state.claimable_htlcs.remove(payment_hash)
3859 if let Some((_, mut sources)) = removed_source {
3860 for htlc in sources.drain(..) {
3861 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3862 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3863 self.best_block.read().unwrap().height()));
3864 self.fail_htlc_backwards_internal(
3865 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
3866 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data },
3867 HTLCDestination::FailedPayment { payment_hash: *payment_hash });
3872 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3873 /// that we want to return and a channel.
3875 /// This is for failures on the channel on which the HTLC was *received*, not failures
3877 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> (u16, Vec<u8>) {
3878 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3879 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3880 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3881 // an inbound SCID alias before the real SCID.
3882 let scid_pref = if chan.should_announce() {
3883 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3885 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3887 if let Some(scid) = scid_pref {
3888 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3890 (0x4000|10, Vec::new())
3895 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3896 /// that we want to return and a channel.
3897 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> (u16, Vec<u8>) {
3898 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3899 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3900 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3901 if desired_err_code == 0x1000 | 20 {
3902 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3903 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3904 0u16.write(&mut enc).expect("Writes cannot fail");
3906 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3907 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3908 upd.write(&mut enc).expect("Writes cannot fail");
3909 (desired_err_code, enc.0)
3911 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3912 // which means we really shouldn't have gotten a payment to be forwarded over this
3913 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3914 // PERM|no_such_channel should be fine.
3915 (0x4000|10, Vec::new())
3919 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3920 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3921 // be surfaced to the user.
3922 fn fail_holding_cell_htlcs(
3923 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3924 counterparty_node_id: &PublicKey
3926 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3927 let (failure_code, onion_failure_data) =
3928 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
3929 hash_map::Entry::Occupied(chan_entry) => {
3930 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3932 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3935 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3936 self.fail_htlc_backwards_internal(htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data }, receiver);
3940 /// Fails an HTLC backwards to the sender of it to us.
3941 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3942 fn fail_htlc_backwards_internal(&self, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason,destination: HTLCDestination) {
3943 #[cfg(debug_assertions)]
3945 // Ensure that the `channel_state` lock is not held when calling this function.
3946 // This ensures that future code doesn't introduce a lock_order requirement for
3947 // `forward_htlcs` to be locked after the `channel_state` lock, which calling this
3948 // function with the `channel_state` locked would.
3949 assert!(self.channel_state.try_lock().is_ok());
3952 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3953 //identify whether we sent it or not based on the (I presume) very different runtime
3954 //between the branches here. We should make this async and move it into the forward HTLCs
3957 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3958 // from block_connected which may run during initialization prior to the chain_monitor
3959 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3961 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, ref payment_params, .. } => {
3962 let mut session_priv_bytes = [0; 32];
3963 session_priv_bytes.copy_from_slice(&session_priv[..]);
3964 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3965 let mut all_paths_failed = false;
3966 let mut full_failure_ev = None;
3967 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3968 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
3969 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3972 if payment.get().is_fulfilled() {
3973 log_trace!(self.logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
3976 if payment.get().remaining_parts() == 0 {
3977 all_paths_failed = true;
3978 if payment.get().abandoned() {
3979 full_failure_ev = Some(events::Event::PaymentFailed {
3981 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3987 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3990 let mut retry = if let Some(payment_params_data) = payment_params {
3991 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3992 Some(RouteParameters {
3993 payment_params: payment_params_data.clone(),
3994 final_value_msat: path_last_hop.fee_msat,
3995 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3998 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
4000 let path_failure = match &onion_error {
4001 &HTLCFailReason::LightningError { ref err } => {
4003 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
4005 let (network_update, short_channel_id, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
4007 if self.payment_is_probe(payment_hash, &payment_id) {
4008 if !payment_retryable {
4009 events::Event::ProbeSuccessful {
4011 payment_hash: payment_hash.clone(),
4015 events::Event::ProbeFailed {
4017 payment_hash: payment_hash.clone(),
4023 // TODO: If we decided to blame ourselves (or one of our channels) in
4024 // process_onion_failure we should close that channel as it implies our
4025 // next-hop is needlessly blaming us!
4026 if let Some(scid) = short_channel_id {
4027 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
4029 events::Event::PaymentPathFailed {
4030 payment_id: Some(payment_id),
4031 payment_hash: payment_hash.clone(),
4032 payment_failed_permanently: !payment_retryable,
4039 error_code: onion_error_code,
4041 error_data: onion_error_data
4045 &HTLCFailReason::Reason {
4051 // we get a fail_malformed_htlc from the first hop
4052 // TODO: We'd like to generate a NetworkUpdate for temporary
4053 // failures here, but that would be insufficient as find_route
4054 // generally ignores its view of our own channels as we provide them via
4056 // TODO: For non-temporary failures, we really should be closing the
4057 // channel here as we apparently can't relay through them anyway.
4058 let scid = path.first().unwrap().short_channel_id;
4059 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
4061 if self.payment_is_probe(payment_hash, &payment_id) {
4062 events::Event::ProbeFailed {
4064 payment_hash: payment_hash.clone(),
4066 short_channel_id: Some(scid),
4069 events::Event::PaymentPathFailed {
4070 payment_id: Some(payment_id),
4071 payment_hash: payment_hash.clone(),
4072 payment_failed_permanently: false,
4073 network_update: None,
4076 short_channel_id: Some(scid),
4079 error_code: Some(*failure_code),
4081 error_data: Some(data.clone()),
4086 let mut pending_events = self.pending_events.lock().unwrap();
4087 pending_events.push(path_failure);
4088 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
4090 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, phantom_shared_secret, outpoint }) => {
4091 let err_packet = match onion_error {
4092 HTLCFailReason::Reason { failure_code, data } => {
4093 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
4094 if let Some(phantom_ss) = phantom_shared_secret {
4095 let phantom_packet = onion_utils::build_failure_packet(&phantom_ss, failure_code, &data[..]).encode();
4096 let encrypted_phantom_packet = onion_utils::encrypt_failure_packet(&phantom_ss, &phantom_packet);
4097 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &encrypted_phantom_packet.data[..])
4099 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
4100 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
4103 HTLCFailReason::LightningError { err } => {
4104 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
4105 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
4109 let mut forward_event = None;
4110 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4111 if forward_htlcs.is_empty() {
4112 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4114 match forward_htlcs.entry(short_channel_id) {
4115 hash_map::Entry::Occupied(mut entry) => {
4116 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
4118 hash_map::Entry::Vacant(entry) => {
4119 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
4122 mem::drop(forward_htlcs);
4123 let mut pending_events = self.pending_events.lock().unwrap();
4124 if let Some(time) = forward_event {
4125 pending_events.push(events::Event::PendingHTLCsForwardable {
4126 time_forwardable: time
4129 pending_events.push(events::Event::HTLCHandlingFailed {
4130 prev_channel_id: outpoint.to_channel_id(),
4131 failed_next_destination: destination
4137 /// Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
4138 /// [`MessageSendEvent`]s needed to claim the payment.
4140 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
4141 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
4142 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
4144 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4145 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
4146 /// event matches your expectation. If you fail to do so and call this method, you may provide
4147 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4149 /// [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
4150 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
4151 /// [`process_pending_events`]: EventsProvider::process_pending_events
4152 /// [`create_inbound_payment`]: Self::create_inbound_payment
4153 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4154 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
4155 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4156 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4158 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4160 let removed_source = self.channel_state.lock().unwrap().claimable_htlcs.remove(&payment_hash);
4161 if let Some((payment_purpose, mut sources)) = removed_source {
4162 assert!(!sources.is_empty());
4164 // If we are claiming an MPP payment, we have to take special care to ensure that each
4165 // channel exists before claiming all of the payments (inside one lock).
4166 // Note that channel existance is sufficient as we should always get a monitor update
4167 // which will take care of the real HTLC claim enforcement.
4169 // If we find an HTLC which we would need to claim but for which we do not have a
4170 // channel, we will fail all parts of the MPP payment. While we could wait and see if
4171 // the sender retries the already-failed path(s), it should be a pretty rare case where
4172 // we got all the HTLCs and then a channel closed while we were waiting for the user to
4173 // provide the preimage, so worrying too much about the optimal handling isn't worth
4175 let mut claimable_amt_msat = 0;
4176 let mut expected_amt_msat = None;
4177 let mut valid_mpp = true;
4178 let mut errs = Vec::new();
4179 let mut claimed_any_htlcs = false;
4180 let mut channel_state_lock = self.channel_state.lock().unwrap();
4181 let channel_state = &mut *channel_state_lock;
4182 for htlc in sources.iter() {
4183 let chan_id = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
4184 Some((_cp_id, chan_id)) => chan_id.clone(),
4191 if let None = channel_state.by_id.get(&chan_id) {
4196 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
4197 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
4198 debug_assert!(false);
4202 expected_amt_msat = Some(htlc.total_msat);
4203 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
4204 // We don't currently support MPP for spontaneous payments, so just check
4205 // that there's one payment here and move on.
4206 if sources.len() != 1 {
4207 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
4208 debug_assert!(false);
4214 claimable_amt_msat += htlc.value;
4216 if sources.is_empty() || expected_amt_msat.is_none() {
4217 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4220 if claimable_amt_msat != expected_amt_msat.unwrap() {
4221 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4222 expected_amt_msat.unwrap(), claimable_amt_msat);
4226 for htlc in sources.drain(..) {
4227 match self.claim_funds_from_hop(&mut channel_state_lock, htlc.prev_hop, payment_preimage) {
4228 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
4229 if let msgs::ErrorAction::IgnoreError = err.err.action {
4230 // We got a temporary failure updating monitor, but will claim the
4231 // HTLC when the monitor updating is restored (or on chain).
4232 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4233 claimed_any_htlcs = true;
4234 } else { errs.push((pk, err)); }
4236 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
4237 ClaimFundsFromHop::DuplicateClaim => {
4238 // While we should never get here in most cases, if we do, it likely
4239 // indicates that the HTLC was timed out some time ago and is no longer
4240 // available to be claimed. Thus, it does not make sense to set
4241 // `claimed_any_htlcs`.
4243 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
4247 mem::drop(channel_state_lock);
4249 for htlc in sources.drain(..) {
4250 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4251 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
4252 self.best_block.read().unwrap().height()));
4253 self.fail_htlc_backwards_internal(
4254 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
4255 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data },
4256 HTLCDestination::FailedPayment { payment_hash } );
4260 if claimed_any_htlcs {
4261 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4263 purpose: payment_purpose,
4264 amount_msat: claimable_amt_msat,
4268 // Now we can handle any errors which were generated.
4269 for (counterparty_node_id, err) in errs.drain(..) {
4270 let res: Result<(), _> = Err(err);
4271 let _ = handle_error!(self, res, counterparty_node_id);
4276 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<<K::Target as KeysInterface>::Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
4277 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4278 let channel_state = &mut **channel_state_lock;
4279 let chan_id = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
4280 Some((_cp_id, chan_id)) => chan_id.clone(),
4282 return ClaimFundsFromHop::PrevHopForceClosed
4286 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
4287 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
4288 Ok(msgs_monitor_option) => {
4289 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
4290 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4291 ChannelMonitorUpdateStatus::Completed => {},
4293 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
4294 "Failed to update channel monitor with preimage {:?}: {:?}",
4295 payment_preimage, e);
4296 return ClaimFundsFromHop::MonitorUpdateFail(
4297 chan.get().get_counterparty_node_id(),
4298 handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
4299 Some(htlc_value_msat)
4303 if let Some((msg, commitment_signed)) = msgs {
4304 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
4305 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
4306 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4307 node_id: chan.get().get_counterparty_node_id(),
4308 updates: msgs::CommitmentUpdate {
4309 update_add_htlcs: Vec::new(),
4310 update_fulfill_htlcs: vec![msg],
4311 update_fail_htlcs: Vec::new(),
4312 update_fail_malformed_htlcs: Vec::new(),
4318 return ClaimFundsFromHop::Success(htlc_value_msat);
4320 return ClaimFundsFromHop::DuplicateClaim;
4323 Err((e, monitor_update)) => {
4324 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4325 ChannelMonitorUpdateStatus::Completed => {},
4327 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
4328 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4329 payment_preimage, e);
4332 let counterparty_node_id = chan.get().get_counterparty_node_id();
4333 let (drop, res) = convert_chan_err!(self, e, chan.get_mut(), &chan_id);
4335 chan.remove_entry();
4337 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
4340 } else { return ClaimFundsFromHop::PrevHopForceClosed }
4343 fn finalize_claims(&self, mut sources: Vec<HTLCSource>) {
4344 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4345 let mut pending_events = self.pending_events.lock().unwrap();
4346 for source in sources.drain(..) {
4347 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
4348 let mut session_priv_bytes = [0; 32];
4349 session_priv_bytes.copy_from_slice(&session_priv[..]);
4350 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4351 assert!(payment.get().is_fulfilled());
4352 if payment.get_mut().remove(&session_priv_bytes, None) {
4353 pending_events.push(
4354 events::Event::PaymentPathSuccessful {
4356 payment_hash: payment.get().payment_hash(),
4366 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<<K::Target as KeysInterface>::Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4368 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4369 mem::drop(channel_state_lock);
4370 let mut session_priv_bytes = [0; 32];
4371 session_priv_bytes.copy_from_slice(&session_priv[..]);
4372 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4373 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4374 let mut pending_events = self.pending_events.lock().unwrap();
4375 if !payment.get().is_fulfilled() {
4376 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4377 let fee_paid_msat = payment.get().get_pending_fee_msat();
4378 pending_events.push(
4379 events::Event::PaymentSent {
4380 payment_id: Some(payment_id),
4386 payment.get_mut().mark_fulfilled();
4390 // We currently immediately remove HTLCs which were fulfilled on-chain.
4391 // This could potentially lead to removing a pending payment too early,
4392 // with a reorg of one block causing us to re-add the fulfilled payment on
4394 // TODO: We should have a second monitor event that informs us of payments
4395 // irrevocably fulfilled.
4396 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4397 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
4398 pending_events.push(
4399 events::Event::PaymentPathSuccessful {
4408 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
4411 HTLCSource::PreviousHopData(hop_data) => {
4412 let prev_outpoint = hop_data.outpoint;
4413 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
4414 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
4415 let htlc_claim_value_msat = match res {
4416 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
4417 ClaimFundsFromHop::Success(amt) => Some(amt),
4420 if let ClaimFundsFromHop::PrevHopForceClosed = res {
4421 let preimage_update = ChannelMonitorUpdate {
4422 update_id: CLOSED_CHANNEL_UPDATE_ID,
4423 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4424 payment_preimage: payment_preimage.clone(),
4427 // We update the ChannelMonitor on the backward link, after
4428 // receiving an offchain preimage event from the forward link (the
4429 // event being update_fulfill_htlc).
4430 let update_res = self.chain_monitor.update_channel(prev_outpoint, preimage_update);
4431 if update_res != ChannelMonitorUpdateStatus::Completed {
4432 // TODO: This needs to be handled somehow - if we receive a monitor update
4433 // with a preimage we *must* somehow manage to propagate it to the upstream
4434 // channel, or we must have an ability to receive the same event and try
4435 // again on restart.
4436 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4437 payment_preimage, update_res);
4439 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
4440 // totally could be a duplicate claim, but we have no way of knowing
4441 // without interrogating the `ChannelMonitor` we've provided the above
4442 // update to. Instead, we simply document in `PaymentForwarded` that this
4445 mem::drop(channel_state_lock);
4446 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
4447 let result: Result<(), _> = Err(err);
4448 let _ = handle_error!(self, result, pk);
4452 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4453 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4454 Some(claimed_htlc_value - forwarded_htlc_value)
4457 let mut pending_events = self.pending_events.lock().unwrap();
4458 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4459 let next_channel_id = Some(next_channel_id);
4461 pending_events.push(events::Event::PaymentForwarded {
4463 claim_from_onchain_tx: from_onchain,
4473 /// Gets the node_id held by this ChannelManager
4474 pub fn get_our_node_id(&self) -> PublicKey {
4475 self.our_network_pubkey.clone()
4478 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
4479 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4481 let chan_restoration_res;
4482 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4483 let mut channel_lock = self.channel_state.lock().unwrap();
4484 let channel_state = &mut *channel_lock;
4485 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
4486 hash_map::Entry::Occupied(chan) => chan,
4487 hash_map::Entry::Vacant(_) => return,
4489 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4493 let counterparty_node_id = channel.get().get_counterparty_node_id();
4494 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4495 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4496 // We only send a channel_update in the case where we are just now sending a
4497 // channel_ready and the channel is in a usable state. We may re-send a
4498 // channel_update later through the announcement_signatures process for public
4499 // channels, but there's no reason not to just inform our counterparty of our fees
4501 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4502 Some(events::MessageSendEvent::SendChannelUpdate {
4503 node_id: channel.get().get_counterparty_node_id(),
4508 chan_restoration_res = handle_chan_restoration_locked!(self, channel_lock, channel_state, channel, updates.raa, updates.commitment_update, updates.order, None, updates.accepted_htlcs, updates.funding_broadcastable, updates.channel_ready, updates.announcement_sigs);
4509 if let Some(upd) = channel_update {
4510 channel_state.pending_msg_events.push(upd);
4513 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4515 post_handle_chan_restoration!(self, chan_restoration_res);
4516 self.finalize_claims(finalized_claims);
4517 for failure in pending_failures.drain(..) {
4518 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4519 self.fail_htlc_backwards_internal(failure.0, &failure.1, failure.2, receiver);
4523 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4525 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4526 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4529 /// The `user_channel_id` parameter will be provided back in
4530 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4531 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4533 /// Note that this method will return an error and reject the channel, if it requires support
4534 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4535 /// used to accept such channels.
4537 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4538 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4539 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4540 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4543 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4544 /// it as confirmed immediately.
4546 /// The `user_channel_id` parameter will be provided back in
4547 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4548 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4550 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4551 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4553 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4554 /// transaction and blindly assumes that it will eventually confirm.
4556 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4557 /// does not pay to the correct script the correct amount, *you will lose funds*.
4559 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4560 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4561 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4562 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4565 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4566 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4568 let mut channel_state_lock = self.channel_state.lock().unwrap();
4569 let channel_state = &mut *channel_state_lock;
4570 match channel_state.by_id.entry(temporary_channel_id.clone()) {
4571 hash_map::Entry::Occupied(mut channel) => {
4572 if !channel.get().inbound_is_awaiting_accept() {
4573 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4575 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4576 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4579 channel.get_mut().set_0conf();
4580 } else if channel.get().get_channel_type().requires_zero_conf() {
4581 let send_msg_err_event = events::MessageSendEvent::HandleError {
4582 node_id: channel.get().get_counterparty_node_id(),
4583 action: msgs::ErrorAction::SendErrorMessage{
4584 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4587 channel_state.pending_msg_events.push(send_msg_err_event);
4588 let _ = remove_channel!(self, channel);
4589 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4592 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4593 node_id: channel.get().get_counterparty_node_id(),
4594 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4597 hash_map::Entry::Vacant(_) => {
4598 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4604 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4605 if msg.chain_hash != self.genesis_hash {
4606 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4609 if !self.default_configuration.accept_inbound_channels {
4610 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4613 let mut random_bytes = [0u8; 16];
4614 random_bytes.copy_from_slice(&self.keys_manager.get_secure_random_bytes()[..16]);
4615 let user_channel_id = u128::from_be_bytes(random_bytes);
4617 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4618 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4619 counterparty_node_id.clone(), &their_features, msg, user_channel_id, &self.default_configuration,
4620 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4623 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4624 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4628 let mut channel_state_lock = self.channel_state.lock().unwrap();
4629 let channel_state = &mut *channel_state_lock;
4630 match channel_state.by_id.entry(channel.channel_id()) {
4631 hash_map::Entry::Occupied(_) => {
4632 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4633 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone()))
4635 hash_map::Entry::Vacant(entry) => {
4636 if !self.default_configuration.manually_accept_inbound_channels {
4637 if channel.get_channel_type().requires_zero_conf() {
4638 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4640 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4641 node_id: counterparty_node_id.clone(),
4642 msg: channel.accept_inbound_channel(0),
4645 let mut pending_events = self.pending_events.lock().unwrap();
4646 pending_events.push(
4647 events::Event::OpenChannelRequest {
4648 temporary_channel_id: msg.temporary_channel_id.clone(),
4649 counterparty_node_id: counterparty_node_id.clone(),
4650 funding_satoshis: msg.funding_satoshis,
4651 push_msat: msg.push_msat,
4652 channel_type: channel.get_channel_type().clone(),
4657 entry.insert(channel);
4663 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4664 let (value, output_script, user_id) = {
4665 let mut channel_lock = self.channel_state.lock().unwrap();
4666 let channel_state = &mut *channel_lock;
4667 match channel_state.by_id.entry(msg.temporary_channel_id) {
4668 hash_map::Entry::Occupied(mut chan) => {
4669 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4670 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4672 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), chan);
4673 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4675 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4678 let mut pending_events = self.pending_events.lock().unwrap();
4679 pending_events.push(events::Event::FundingGenerationReady {
4680 temporary_channel_id: msg.temporary_channel_id,
4681 counterparty_node_id: *counterparty_node_id,
4682 channel_value_satoshis: value,
4684 user_channel_id: user_id,
4689 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4690 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4691 let best_block = *self.best_block.read().unwrap();
4692 let mut channel_lock = self.channel_state.lock().unwrap();
4693 let channel_state = &mut *channel_lock;
4694 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
4695 hash_map::Entry::Occupied(mut chan) => {
4696 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4697 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4699 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), chan), chan.remove())
4701 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4704 // Because we have exclusive ownership of the channel here we can release the channel_state
4705 // lock before watch_channel
4706 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4707 ChannelMonitorUpdateStatus::Completed => {},
4708 ChannelMonitorUpdateStatus::PermanentFailure => {
4709 // Note that we reply with the new channel_id in error messages if we gave up on the
4710 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4711 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4712 // any messages referencing a previously-closed channel anyway.
4713 // We do not propagate the monitor update to the user as it would be for a monitor
4714 // that we didn't manage to store (and that we don't care about - we don't respond
4715 // with the funding_signed so the channel can never go on chain).
4716 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4717 assert!(failed_htlcs.is_empty());
4718 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4720 ChannelMonitorUpdateStatus::InProgress => {
4721 // There's no problem signing a counterparty's funding transaction if our monitor
4722 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4723 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4724 // until we have persisted our monitor.
4725 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4726 channel_ready = None; // Don't send the channel_ready now
4729 let mut channel_state_lock = self.channel_state.lock().unwrap();
4730 let channel_state = &mut *channel_state_lock;
4731 match channel_state.by_id.entry(funding_msg.channel_id) {
4732 hash_map::Entry::Occupied(_) => {
4733 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4735 hash_map::Entry::Vacant(e) => {
4736 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4737 match id_to_peer.entry(chan.channel_id()) {
4738 hash_map::Entry::Occupied(_) => {
4739 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4740 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4741 funding_msg.channel_id))
4743 hash_map::Entry::Vacant(i_e) => {
4744 i_e.insert(chan.get_counterparty_node_id());
4747 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4748 node_id: counterparty_node_id.clone(),
4751 if let Some(msg) = channel_ready {
4752 send_channel_ready!(self, channel_state.pending_msg_events, chan, msg);
4760 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4762 let best_block = *self.best_block.read().unwrap();
4763 let mut channel_lock = self.channel_state.lock().unwrap();
4764 let channel_state = &mut *channel_lock;
4765 match channel_state.by_id.entry(msg.channel_id) {
4766 hash_map::Entry::Occupied(mut chan) => {
4767 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4768 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4770 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
4771 Ok(update) => update,
4772 Err(e) => try_chan_entry!(self, Err(e), chan),
4774 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4775 ChannelMonitorUpdateStatus::Completed => {},
4777 let mut res = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4778 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4779 // We weren't able to watch the channel to begin with, so no updates should be made on
4780 // it. Previously, full_stack_target found an (unreachable) panic when the
4781 // monitor update contained within `shutdown_finish` was applied.
4782 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4783 shutdown_finish.0.take();
4789 if let Some(msg) = channel_ready {
4790 send_channel_ready!(self, channel_state.pending_msg_events, chan.get(), msg);
4794 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4797 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4798 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4802 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4803 let mut channel_state_lock = self.channel_state.lock().unwrap();
4804 let channel_state = &mut *channel_state_lock;
4805 match channel_state.by_id.entry(msg.channel_id) {
4806 hash_map::Entry::Occupied(mut chan) => {
4807 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4808 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4810 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4811 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), chan);
4812 if let Some(announcement_sigs) = announcement_sigs_opt {
4813 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4814 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4815 node_id: counterparty_node_id.clone(),
4816 msg: announcement_sigs,
4818 } else if chan.get().is_usable() {
4819 // If we're sending an announcement_signatures, we'll send the (public)
4820 // channel_update after sending a channel_announcement when we receive our
4821 // counterparty's announcement_signatures. Thus, we only bother to send a
4822 // channel_update here if the channel is not public, i.e. we're not sending an
4823 // announcement_signatures.
4824 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4825 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4826 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4827 node_id: counterparty_node_id.clone(),
4833 emit_channel_ready_event!(self, chan.get_mut());
4837 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4841 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4842 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4843 let result: Result<(), _> = loop {
4844 let mut channel_state_lock = self.channel_state.lock().unwrap();
4845 let channel_state = &mut *channel_state_lock;
4847 match channel_state.by_id.entry(msg.channel_id.clone()) {
4848 hash_map::Entry::Occupied(mut chan_entry) => {
4849 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4850 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4853 if !chan_entry.get().received_shutdown() {
4854 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4855 log_bytes!(msg.channel_id),
4856 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4859 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), chan_entry);
4860 dropped_htlcs = htlcs;
4862 // Update the monitor with the shutdown script if necessary.
4863 if let Some(monitor_update) = monitor_update {
4864 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
4865 let (result, is_permanent) =
4866 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4868 remove_channel!(self, chan_entry);
4873 if let Some(msg) = shutdown {
4874 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4875 node_id: *counterparty_node_id,
4882 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4885 for htlc_source in dropped_htlcs.drain(..) {
4886 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4887 self.fail_htlc_backwards_internal(htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
4890 let _ = handle_error!(self, result, *counterparty_node_id);
4894 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4895 let (tx, chan_option) = {
4896 let mut channel_state_lock = self.channel_state.lock().unwrap();
4897 let channel_state = &mut *channel_state_lock;
4898 match channel_state.by_id.entry(msg.channel_id.clone()) {
4899 hash_map::Entry::Occupied(mut chan_entry) => {
4900 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4901 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4903 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
4904 if let Some(msg) = closing_signed {
4905 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4906 node_id: counterparty_node_id.clone(),
4911 // We're done with this channel, we've got a signed closing transaction and
4912 // will send the closing_signed back to the remote peer upon return. This
4913 // also implies there are no pending HTLCs left on the channel, so we can
4914 // fully delete it from tracking (the channel monitor is still around to
4915 // watch for old state broadcasts)!
4916 (tx, Some(remove_channel!(self, chan_entry)))
4917 } else { (tx, None) }
4919 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4922 if let Some(broadcast_tx) = tx {
4923 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4924 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4926 if let Some(chan) = chan_option {
4927 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4928 let mut channel_state = self.channel_state.lock().unwrap();
4929 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4933 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4938 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4939 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4940 //determine the state of the payment based on our response/if we forward anything/the time
4941 //we take to respond. We should take care to avoid allowing such an attack.
4943 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4944 //us repeatedly garbled in different ways, and compare our error messages, which are
4945 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4946 //but we should prevent it anyway.
4948 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4949 let mut channel_state_lock = self.channel_state.lock().unwrap();
4950 let channel_state = &mut *channel_state_lock;
4952 match channel_state.by_id.entry(msg.channel_id) {
4953 hash_map::Entry::Occupied(mut chan) => {
4954 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4955 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4958 let create_pending_htlc_status = |chan: &Channel<<K::Target as KeysInterface>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4959 // If the update_add is completely bogus, the call will Err and we will close,
4960 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4961 // want to reject the new HTLC and fail it backwards instead of forwarding.
4962 match pending_forward_info {
4963 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4964 let reason = if (error_code & 0x1000) != 0 {
4965 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4966 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, real_code, &error_data)
4968 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
4970 let msg = msgs::UpdateFailHTLC {
4971 channel_id: msg.channel_id,
4972 htlc_id: msg.htlc_id,
4975 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4977 _ => pending_forward_info
4980 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
4982 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4987 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4988 let mut channel_lock = self.channel_state.lock().unwrap();
4989 let (htlc_source, forwarded_htlc_value) = {
4990 let channel_state = &mut *channel_lock;
4991 match channel_state.by_id.entry(msg.channel_id) {
4992 hash_map::Entry::Occupied(mut chan) => {
4993 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4994 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4996 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
4998 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5001 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
5005 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
5006 let mut channel_lock = self.channel_state.lock().unwrap();
5007 let channel_state = &mut *channel_lock;
5008 match channel_state.by_id.entry(msg.channel_id) {
5009 hash_map::Entry::Occupied(mut chan) => {
5010 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5011 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5013 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), chan);
5015 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5020 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
5021 let mut channel_lock = self.channel_state.lock().unwrap();
5022 let channel_state = &mut *channel_lock;
5023 match channel_state.by_id.entry(msg.channel_id) {
5024 hash_map::Entry::Occupied(mut chan) => {
5025 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5026 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5028 if (msg.failure_code & 0x8000) == 0 {
5029 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
5030 try_chan_entry!(self, Err(chan_err), chan);
5032 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() }), chan);
5035 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5039 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
5040 let mut channel_state_lock = self.channel_state.lock().unwrap();
5041 let channel_state = &mut *channel_state_lock;
5042 match channel_state.by_id.entry(msg.channel_id) {
5043 hash_map::Entry::Occupied(mut chan) => {
5044 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5045 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5047 let (revoke_and_ack, commitment_signed, monitor_update) =
5048 match chan.get_mut().commitment_signed(&msg, &self.logger) {
5049 Err((None, e)) => try_chan_entry!(self, Err(e), chan),
5050 Err((Some(update), e)) => {
5051 assert!(chan.get().is_awaiting_monitor_update());
5052 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
5053 try_chan_entry!(self, Err(e), chan);
5058 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
5059 if let Err(e) = handle_monitor_update_res!(self, update_res, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
5063 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5064 node_id: counterparty_node_id.clone(),
5065 msg: revoke_and_ack,
5067 if let Some(msg) = commitment_signed {
5068 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5069 node_id: counterparty_node_id.clone(),
5070 updates: msgs::CommitmentUpdate {
5071 update_add_htlcs: Vec::new(),
5072 update_fulfill_htlcs: Vec::new(),
5073 update_fail_htlcs: Vec::new(),
5074 update_fail_malformed_htlcs: Vec::new(),
5076 commitment_signed: msg,
5082 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5087 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
5088 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
5089 let mut forward_event = None;
5090 if !pending_forwards.is_empty() {
5091 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5092 if forward_htlcs.is_empty() {
5093 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
5095 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
5096 match forward_htlcs.entry(match forward_info.routing {
5097 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5098 PendingHTLCRouting::Receive { .. } => 0,
5099 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
5101 hash_map::Entry::Occupied(mut entry) => {
5102 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5103 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, forward_info }));
5105 hash_map::Entry::Vacant(entry) => {
5106 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5107 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, forward_info })));
5112 match forward_event {
5114 let mut pending_events = self.pending_events.lock().unwrap();
5115 pending_events.push(events::Event::PendingHTLCsForwardable {
5116 time_forwardable: time
5124 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
5125 let mut htlcs_to_fail = Vec::new();
5127 let mut channel_state_lock = self.channel_state.lock().unwrap();
5128 let channel_state = &mut *channel_state_lock;
5129 match channel_state.by_id.entry(msg.channel_id) {
5130 hash_map::Entry::Occupied(mut chan) => {
5131 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5132 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5134 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
5135 let raa_updates = break_chan_entry!(self,
5136 chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
5137 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
5138 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update);
5139 if was_paused_for_mon_update {
5140 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
5141 assert!(raa_updates.commitment_update.is_none());
5142 assert!(raa_updates.accepted_htlcs.is_empty());
5143 assert!(raa_updates.failed_htlcs.is_empty());
5144 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
5145 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
5147 if update_res != ChannelMonitorUpdateStatus::Completed {
5148 if let Err(e) = handle_monitor_update_res!(self, update_res, chan,
5149 RAACommitmentOrder::CommitmentFirst, false,
5150 raa_updates.commitment_update.is_some(), false,
5151 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5152 raa_updates.finalized_claimed_htlcs) {
5154 } else { unreachable!(); }
5156 if let Some(updates) = raa_updates.commitment_update {
5157 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5158 node_id: counterparty_node_id.clone(),
5162 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5163 raa_updates.finalized_claimed_htlcs,
5164 chan.get().get_short_channel_id()
5165 .unwrap_or(chan.get().outbound_scid_alias()),
5166 chan.get().get_funding_txo().unwrap()))
5168 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5171 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
5173 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
5174 short_channel_id, channel_outpoint)) =>
5176 for failure in pending_failures.drain(..) {
5177 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
5178 self.fail_htlc_backwards_internal(failure.0, &failure.1, failure.2, receiver);
5180 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
5181 self.finalize_claims(finalized_claim_htlcs);
5188 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
5189 let mut channel_lock = self.channel_state.lock().unwrap();
5190 let channel_state = &mut *channel_lock;
5191 match channel_state.by_id.entry(msg.channel_id) {
5192 hash_map::Entry::Occupied(mut chan) => {
5193 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5194 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5196 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), chan);
5198 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5203 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
5204 let mut channel_state_lock = self.channel_state.lock().unwrap();
5205 let channel_state = &mut *channel_state_lock;
5207 match channel_state.by_id.entry(msg.channel_id) {
5208 hash_map::Entry::Occupied(mut chan) => {
5209 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5210 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5212 if !chan.get().is_usable() {
5213 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5216 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5217 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5218 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), chan),
5219 // Note that announcement_signatures fails if the channel cannot be announced,
5220 // so get_channel_update_for_broadcast will never fail by the time we get here.
5221 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
5224 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5229 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5230 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5231 let chan_id = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
5232 Some((_cp_id, chan_id)) => chan_id.clone(),
5234 // It's not a local channel
5235 return Ok(NotifyOption::SkipPersist)
5238 let mut channel_state_lock = self.channel_state.lock().unwrap();
5239 let channel_state = &mut *channel_state_lock;
5240 match channel_state.by_id.entry(chan_id) {
5241 hash_map::Entry::Occupied(mut chan) => {
5242 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5243 if chan.get().should_announce() {
5244 // If the announcement is about a channel of ours which is public, some
5245 // other peer may simply be forwarding all its gossip to us. Don't provide
5246 // a scary-looking error message and return Ok instead.
5247 return Ok(NotifyOption::SkipPersist);
5249 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a channel_update for a channel from the wrong node - it shouldn't know about our private channels!".to_owned(), chan_id));
5251 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5252 let msg_from_node_one = msg.contents.flags & 1 == 0;
5253 if were_node_one == msg_from_node_one {
5254 return Ok(NotifyOption::SkipPersist);
5256 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5257 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
5260 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5262 Ok(NotifyOption::DoPersist)
5265 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5266 let chan_restoration_res;
5267 let (htlcs_failed_forward, need_lnd_workaround) = {
5268 let mut channel_state_lock = self.channel_state.lock().unwrap();
5269 let channel_state = &mut *channel_state_lock;
5271 match channel_state.by_id.entry(msg.channel_id) {
5272 hash_map::Entry::Occupied(mut chan) => {
5273 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5274 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5276 // Currently, we expect all holding cell update_adds to be dropped on peer
5277 // disconnect, so Channel's reestablish will never hand us any holding cell
5278 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5279 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5280 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5281 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
5282 &*self.best_block.read().unwrap()), chan);
5283 let mut channel_update = None;
5284 if let Some(msg) = responses.shutdown_msg {
5285 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5286 node_id: counterparty_node_id.clone(),
5289 } else if chan.get().is_usable() {
5290 // If the channel is in a usable state (ie the channel is not being shut
5291 // down), send a unicast channel_update to our counterparty to make sure
5292 // they have the latest channel parameters.
5293 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5294 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5295 node_id: chan.get().get_counterparty_node_id(),
5300 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5301 chan_restoration_res = handle_chan_restoration_locked!(
5302 self, channel_state_lock, channel_state, chan, responses.raa, responses.commitment_update, responses.order,
5303 responses.mon_update, Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5304 if let Some(upd) = channel_update {
5305 channel_state.pending_msg_events.push(upd);
5307 (responses.holding_cell_failed_htlcs, need_lnd_workaround)
5309 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5312 post_handle_chan_restoration!(self, chan_restoration_res);
5313 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id, counterparty_node_id);
5315 if let Some(channel_ready_msg) = need_lnd_workaround {
5316 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5321 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5322 fn process_pending_monitor_events(&self) -> bool {
5323 let mut failed_channels = Vec::new();
5324 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5325 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5326 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5327 for monitor_event in monitor_events.drain(..) {
5328 match monitor_event {
5329 MonitorEvent::HTLCEvent(htlc_update) => {
5330 if let Some(preimage) = htlc_update.payment_preimage {
5331 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5332 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5334 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5335 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5336 self.fail_htlc_backwards_internal(htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
5339 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5340 MonitorEvent::UpdateFailed(funding_outpoint) => {
5341 let mut channel_lock = self.channel_state.lock().unwrap();
5342 let channel_state = &mut *channel_lock;
5343 let by_id = &mut channel_state.by_id;
5344 let pending_msg_events = &mut channel_state.pending_msg_events;
5345 if let hash_map::Entry::Occupied(chan_entry) = by_id.entry(funding_outpoint.to_channel_id()) {
5346 let mut chan = remove_channel!(self, chan_entry);
5347 failed_channels.push(chan.force_shutdown(false));
5348 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5349 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5353 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5354 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5356 ClosureReason::CommitmentTxConfirmed
5358 self.issue_channel_close_events(&chan, reason);
5359 pending_msg_events.push(events::MessageSendEvent::HandleError {
5360 node_id: chan.get_counterparty_node_id(),
5361 action: msgs::ErrorAction::SendErrorMessage {
5362 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5367 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5368 self.channel_monitor_updated(&funding_txo, monitor_update_id);
5374 for failure in failed_channels.drain(..) {
5375 self.finish_force_close_channel(failure);
5378 has_pending_monitor_events
5381 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5382 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5383 /// update events as a separate process method here.
5385 pub fn process_monitor_events(&self) {
5386 self.process_pending_monitor_events();
5389 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5390 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5391 /// update was applied.
5393 /// This should only apply to HTLCs which were added to the holding cell because we were
5394 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
5395 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
5396 /// code to inform them of a channel monitor update.
5397 fn check_free_holding_cells(&self) -> bool {
5398 let mut has_monitor_update = false;
5399 let mut failed_htlcs = Vec::new();
5400 let mut handle_errors = Vec::new();
5402 let mut channel_state_lock = self.channel_state.lock().unwrap();
5403 let channel_state = &mut *channel_state_lock;
5404 let by_id = &mut channel_state.by_id;
5405 let pending_msg_events = &mut channel_state.pending_msg_events;
5407 by_id.retain(|channel_id, chan| {
5408 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5409 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5410 if !holding_cell_failed_htlcs.is_empty() {
5412 holding_cell_failed_htlcs,
5414 chan.get_counterparty_node_id()
5417 if let Some((commitment_update, monitor_update)) = commitment_opt {
5418 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5419 ChannelMonitorUpdateStatus::Completed => {
5420 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5421 node_id: chan.get_counterparty_node_id(),
5422 updates: commitment_update,
5426 has_monitor_update = true;
5427 let (res, close_channel) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5428 handle_errors.push((chan.get_counterparty_node_id(), res));
5429 if close_channel { return false; }
5436 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5437 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5438 // ChannelClosed event is generated by handle_error for us
5445 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5446 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5447 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5450 for (counterparty_node_id, err) in handle_errors.drain(..) {
5451 let _ = handle_error!(self, err, counterparty_node_id);
5457 /// Check whether any channels have finished removing all pending updates after a shutdown
5458 /// exchange and can now send a closing_signed.
5459 /// Returns whether any closing_signed messages were generated.
5460 fn maybe_generate_initial_closing_signed(&self) -> bool {
5461 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5462 let mut has_update = false;
5464 let mut channel_state_lock = self.channel_state.lock().unwrap();
5465 let channel_state = &mut *channel_state_lock;
5466 let by_id = &mut channel_state.by_id;
5467 let pending_msg_events = &mut channel_state.pending_msg_events;
5469 by_id.retain(|channel_id, chan| {
5470 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5471 Ok((msg_opt, tx_opt)) => {
5472 if let Some(msg) = msg_opt {
5474 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5475 node_id: chan.get_counterparty_node_id(), msg,
5478 if let Some(tx) = tx_opt {
5479 // We're done with this channel. We got a closing_signed and sent back
5480 // a closing_signed with a closing transaction to broadcast.
5481 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5482 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5487 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5489 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5490 self.tx_broadcaster.broadcast_transaction(&tx);
5491 update_maps_on_chan_removal!(self, chan);
5497 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5498 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5505 for (counterparty_node_id, err) in handle_errors.drain(..) {
5506 let _ = handle_error!(self, err, counterparty_node_id);
5512 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5513 /// pushing the channel monitor update (if any) to the background events queue and removing the
5515 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5516 for mut failure in failed_channels.drain(..) {
5517 // Either a commitment transactions has been confirmed on-chain or
5518 // Channel::block_disconnected detected that the funding transaction has been
5519 // reorganized out of the main chain.
5520 // We cannot broadcast our latest local state via monitor update (as
5521 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5522 // so we track the update internally and handle it when the user next calls
5523 // timer_tick_occurred, guaranteeing we're running normally.
5524 if let Some((funding_txo, update)) = failure.0.take() {
5525 assert_eq!(update.updates.len(), 1);
5526 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5527 assert!(should_broadcast);
5528 } else { unreachable!(); }
5529 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5531 self.finish_force_close_channel(failure);
5535 fn set_payment_hash_secret_map(&self, payment_hash: PaymentHash, payment_preimage: Option<PaymentPreimage>, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, APIError> {
5536 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5538 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5539 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5542 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5544 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5545 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5546 match payment_secrets.entry(payment_hash) {
5547 hash_map::Entry::Vacant(e) => {
5548 e.insert(PendingInboundPayment {
5549 payment_secret, min_value_msat, payment_preimage,
5550 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5551 // We assume that highest_seen_timestamp is pretty close to the current time -
5552 // it's updated when we receive a new block with the maximum time we've seen in
5553 // a header. It should never be more than two hours in the future.
5554 // Thus, we add two hours here as a buffer to ensure we absolutely
5555 // never fail a payment too early.
5556 // Note that we assume that received blocks have reasonably up-to-date
5558 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5561 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5566 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5569 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5570 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5572 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
5573 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
5574 /// passed directly to [`claim_funds`].
5576 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5578 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5579 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5583 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5584 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5586 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5588 /// [`claim_funds`]: Self::claim_funds
5589 /// [`PaymentReceived`]: events::Event::PaymentReceived
5590 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
5591 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5592 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5593 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs, &self.keys_manager, self.highest_seen_timestamp.load(Ordering::Acquire) as u64)
5596 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5597 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5599 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5602 /// This method is deprecated and will be removed soon.
5604 /// [`create_inbound_payment`]: Self::create_inbound_payment
5606 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5607 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5608 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5609 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5610 Ok((payment_hash, payment_secret))
5613 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5614 /// stored external to LDK.
5616 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
5617 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5618 /// the `min_value_msat` provided here, if one is provided.
5620 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5621 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5624 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5625 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5626 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
5627 /// sender "proof-of-payment" unless they have paid the required amount.
5629 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5630 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5631 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5632 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5633 /// invoices when no timeout is set.
5635 /// Note that we use block header time to time-out pending inbound payments (with some margin
5636 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5637 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
5638 /// If you need exact expiry semantics, you should enforce them upon receipt of
5639 /// [`PaymentReceived`].
5641 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5642 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5644 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5645 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5649 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5650 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5652 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5654 /// [`create_inbound_payment`]: Self::create_inbound_payment
5655 /// [`PaymentReceived`]: events::Event::PaymentReceived
5656 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5657 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash, invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64)
5660 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5661 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5663 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5666 /// This method is deprecated and will be removed soon.
5668 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5670 pub fn create_inbound_payment_for_hash_legacy(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, APIError> {
5671 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5674 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5675 /// previously returned from [`create_inbound_payment`].
5677 /// [`create_inbound_payment`]: Self::create_inbound_payment
5678 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5679 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5682 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5683 /// are used when constructing the phantom invoice's route hints.
5685 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5686 pub fn get_phantom_scid(&self) -> u64 {
5687 let best_block_height = self.best_block.read().unwrap().height();
5688 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5690 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5691 // Ensure the generated scid doesn't conflict with a real channel.
5692 match short_to_chan_info.get(&scid_candidate) {
5693 Some(_) => continue,
5694 None => return scid_candidate
5699 /// Gets route hints for use in receiving [phantom node payments].
5701 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5702 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5704 channels: self.list_usable_channels(),
5705 phantom_scid: self.get_phantom_scid(),
5706 real_node_pubkey: self.get_our_node_id(),
5710 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5711 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5712 let events = core::cell::RefCell::new(Vec::new());
5713 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5714 self.process_pending_events(&event_handler);
5719 pub fn has_pending_payments(&self) -> bool {
5720 !self.pending_outbound_payments.lock().unwrap().is_empty()
5724 pub fn clear_pending_payments(&self) {
5725 self.pending_outbound_payments.lock().unwrap().clear()
5728 /// Processes any events asynchronously in the order they were generated since the last call
5729 /// using the given event handler.
5731 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5732 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5735 // We'll acquire our total consistency lock until the returned future completes so that
5736 // we can be sure no other persists happen while processing events.
5737 let _read_guard = self.total_consistency_lock.read().unwrap();
5739 let mut result = NotifyOption::SkipPersist;
5741 // TODO: This behavior should be documented. It's unintuitive that we query
5742 // ChannelMonitors when clearing other events.
5743 if self.process_pending_monitor_events() {
5744 result = NotifyOption::DoPersist;
5747 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5748 if !pending_events.is_empty() {
5749 result = NotifyOption::DoPersist;
5752 for event in pending_events {
5753 handler(event).await;
5756 if result == NotifyOption::DoPersist {
5757 self.persistence_notifier.notify();
5762 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, K, F, L>
5763 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5764 T::Target: BroadcasterInterface,
5765 K::Target: KeysInterface,
5766 F::Target: FeeEstimator,
5769 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5770 let events = RefCell::new(Vec::new());
5771 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5772 let mut result = NotifyOption::SkipPersist;
5774 // TODO: This behavior should be documented. It's unintuitive that we query
5775 // ChannelMonitors when clearing other events.
5776 if self.process_pending_monitor_events() {
5777 result = NotifyOption::DoPersist;
5780 if self.check_free_holding_cells() {
5781 result = NotifyOption::DoPersist;
5783 if self.maybe_generate_initial_closing_signed() {
5784 result = NotifyOption::DoPersist;
5787 let mut pending_events = Vec::new();
5788 let mut channel_state = self.channel_state.lock().unwrap();
5789 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5791 if !pending_events.is_empty() {
5792 events.replace(pending_events);
5801 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<M, T, K, F, L>
5803 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5804 T::Target: BroadcasterInterface,
5805 K::Target: KeysInterface,
5806 F::Target: FeeEstimator,
5809 /// Processes events that must be periodically handled.
5811 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5812 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5813 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5814 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5815 let mut result = NotifyOption::SkipPersist;
5817 // TODO: This behavior should be documented. It's unintuitive that we query
5818 // ChannelMonitors when clearing other events.
5819 if self.process_pending_monitor_events() {
5820 result = NotifyOption::DoPersist;
5823 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5824 if !pending_events.is_empty() {
5825 result = NotifyOption::DoPersist;
5828 for event in pending_events {
5829 handler.handle_event(event);
5837 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<M, T, K, F, L>
5839 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5840 T::Target: BroadcasterInterface,
5841 K::Target: KeysInterface,
5842 F::Target: FeeEstimator,
5845 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5847 let best_block = self.best_block.read().unwrap();
5848 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5849 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5850 assert_eq!(best_block.height(), height - 1,
5851 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5854 self.transactions_confirmed(header, txdata, height);
5855 self.best_block_updated(header, height);
5858 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5859 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5860 let new_height = height - 1;
5862 let mut best_block = self.best_block.write().unwrap();
5863 assert_eq!(best_block.block_hash(), header.block_hash(),
5864 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5865 assert_eq!(best_block.height(), height,
5866 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5867 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5870 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5874 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, K, F, L>
5876 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5877 T::Target: BroadcasterInterface,
5878 K::Target: KeysInterface,
5879 F::Target: FeeEstimator,
5882 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5883 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5884 // during initialization prior to the chain_monitor being fully configured in some cases.
5885 // See the docs for `ChannelManagerReadArgs` for more.
5887 let block_hash = header.block_hash();
5888 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5890 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5891 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger)
5892 .map(|(a, b)| (a, Vec::new(), b)));
5894 let last_best_block_height = self.best_block.read().unwrap().height();
5895 if height < last_best_block_height {
5896 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5897 self.do_chain_event(Some(last_best_block_height), |channel| channel.best_block_updated(last_best_block_height, timestamp as u32, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5901 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5902 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5903 // during initialization prior to the chain_monitor being fully configured in some cases.
5904 // See the docs for `ChannelManagerReadArgs` for more.
5906 let block_hash = header.block_hash();
5907 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5909 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5911 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5913 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5915 macro_rules! max_time {
5916 ($timestamp: expr) => {
5918 // Update $timestamp to be the max of its current value and the block
5919 // timestamp. This should keep us close to the current time without relying on
5920 // having an explicit local time source.
5921 // Just in case we end up in a race, we loop until we either successfully
5922 // update $timestamp or decide we don't need to.
5923 let old_serial = $timestamp.load(Ordering::Acquire);
5924 if old_serial >= header.time as usize { break; }
5925 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5931 max_time!(self.highest_seen_timestamp);
5932 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5933 payment_secrets.retain(|_, inbound_payment| {
5934 inbound_payment.expiry_time > header.time as u64
5938 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
5939 let channel_state = self.channel_state.lock().unwrap();
5940 let mut res = Vec::with_capacity(channel_state.by_id.len());
5941 for chan in channel_state.by_id.values() {
5942 if let (Some(funding_txo), block_hash) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
5943 res.push((funding_txo.txid, block_hash));
5949 fn transaction_unconfirmed(&self, txid: &Txid) {
5950 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5951 self.do_chain_event(None, |channel| {
5952 if let Some(funding_txo) = channel.get_funding_txo() {
5953 if funding_txo.txid == *txid {
5954 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5955 } else { Ok((None, Vec::new(), None)) }
5956 } else { Ok((None, Vec::new(), None)) }
5961 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F, L>
5963 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5964 T::Target: BroadcasterInterface,
5965 K::Target: KeysInterface,
5966 F::Target: FeeEstimator,
5969 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5970 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5972 fn do_chain_event<FN: Fn(&mut Channel<<K::Target as KeysInterface>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5973 (&self, height_opt: Option<u32>, f: FN) {
5974 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5975 // during initialization prior to the chain_monitor being fully configured in some cases.
5976 // See the docs for `ChannelManagerReadArgs` for more.
5978 let mut failed_channels = Vec::new();
5979 let mut timed_out_htlcs = Vec::new();
5981 let mut channel_lock = self.channel_state.lock().unwrap();
5982 let channel_state = &mut *channel_lock;
5983 let pending_msg_events = &mut channel_state.pending_msg_events;
5984 channel_state.by_id.retain(|_, channel| {
5985 let res = f(channel);
5986 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5987 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5988 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5989 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
5991 }, HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5993 if let Some(channel_ready) = channel_ready_opt {
5994 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
5995 if channel.is_usable() {
5996 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5997 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5998 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5999 node_id: channel.get_counterparty_node_id(),
6004 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
6008 emit_channel_ready_event!(self, channel);
6010 if let Some(announcement_sigs) = announcement_sigs {
6011 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
6012 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6013 node_id: channel.get_counterparty_node_id(),
6014 msg: announcement_sigs,
6016 if let Some(height) = height_opt {
6017 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
6018 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6020 // Note that announcement_signatures fails if the channel cannot be announced,
6021 // so get_channel_update_for_broadcast will never fail by the time we get here.
6022 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
6027 if channel.is_our_channel_ready() {
6028 if let Some(real_scid) = channel.get_short_channel_id() {
6029 // If we sent a 0conf channel_ready, and now have an SCID, we add it
6030 // to the short_to_chan_info map here. Note that we check whether we
6031 // can relay using the real SCID at relay-time (i.e.
6032 // enforce option_scid_alias then), and if the funding tx is ever
6033 // un-confirmed we force-close the channel, ensuring short_to_chan_info
6034 // is always consistent.
6035 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
6036 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
6037 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
6038 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
6039 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
6042 } else if let Err(reason) = res {
6043 update_maps_on_chan_removal!(self, channel);
6044 // It looks like our counterparty went on-chain or funding transaction was
6045 // reorged out of the main chain. Close the channel.
6046 failed_channels.push(channel.force_shutdown(true));
6047 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
6048 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6052 let reason_message = format!("{}", reason);
6053 self.issue_channel_close_events(channel, reason);
6054 pending_msg_events.push(events::MessageSendEvent::HandleError {
6055 node_id: channel.get_counterparty_node_id(),
6056 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
6057 channel_id: channel.channel_id(),
6058 data: reason_message,
6066 if let Some(height) = height_opt {
6067 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
6068 htlcs.retain(|htlc| {
6069 // If height is approaching the number of blocks we think it takes us to get
6070 // our commitment transaction confirmed before the HTLC expires, plus the
6071 // number of blocks we generally consider it to take to do a commitment update,
6072 // just give up on it and fail the HTLC.
6073 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
6074 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
6075 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
6077 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
6078 failure_code: 0x4000 | 15,
6079 data: htlc_msat_height_data
6080 }, HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
6084 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
6089 self.handle_init_event_channel_failures(failed_channels);
6091 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6092 self.fail_htlc_backwards_internal(source, &payment_hash, reason, destination);
6096 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
6097 /// indicating whether persistence is necessary. Only one listener on
6098 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
6099 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6101 /// Note that this method is not available with the `no-std` feature.
6103 /// [`await_persistable_update`]: Self::await_persistable_update
6104 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
6105 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6106 #[cfg(any(test, feature = "std"))]
6107 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
6108 self.persistence_notifier.wait_timeout(max_wait)
6111 /// Blocks until ChannelManager needs to be persisted. Only one listener on
6112 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
6113 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6115 /// [`await_persistable_update`]: Self::await_persistable_update
6116 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6117 pub fn await_persistable_update(&self) {
6118 self.persistence_notifier.wait()
6121 /// Gets a [`Future`] that completes when a persistable update is available. Note that
6122 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
6123 /// should instead register actions to be taken later.
6124 pub fn get_persistable_update_future(&self) -> Future {
6125 self.persistence_notifier.get_future()
6128 #[cfg(any(test, feature = "_test_utils"))]
6129 pub fn get_persistence_condvar_value(&self) -> bool {
6130 self.persistence_notifier.notify_pending()
6133 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6134 /// [`chain::Confirm`] interfaces.
6135 pub fn current_best_block(&self) -> BestBlock {
6136 self.best_block.read().unwrap().clone()
6140 impl<M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
6141 ChannelMessageHandler for ChannelManager<M, T, K, F, L>
6142 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6143 T::Target: BroadcasterInterface,
6144 K::Target: KeysInterface,
6145 F::Target: FeeEstimator,
6148 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
6149 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6150 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6153 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
6154 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6155 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6158 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6159 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6160 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6163 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6164 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6165 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6168 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6169 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6170 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6173 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
6174 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6175 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
6178 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6179 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6180 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6183 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6184 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6185 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6188 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6189 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6190 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6193 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6194 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6195 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6198 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6199 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6200 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6203 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6204 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6205 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6208 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6209 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6210 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6213 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6214 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6215 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6218 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6219 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6220 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6223 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6224 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6225 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6228 NotifyOption::SkipPersist
6233 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6234 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6235 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6238 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6239 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6240 let mut failed_channels = Vec::new();
6241 let mut no_channels_remain = true;
6243 let mut channel_state_lock = self.channel_state.lock().unwrap();
6244 let channel_state = &mut *channel_state_lock;
6245 let pending_msg_events = &mut channel_state.pending_msg_events;
6246 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6247 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6248 channel_state.by_id.retain(|_, chan| {
6249 if chan.get_counterparty_node_id() == *counterparty_node_id {
6250 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6251 if chan.is_shutdown() {
6252 update_maps_on_chan_removal!(self, chan);
6253 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6256 no_channels_remain = false;
6261 pending_msg_events.retain(|msg| {
6263 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
6264 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
6265 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
6266 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6267 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
6268 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
6269 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
6270 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
6271 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6272 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6273 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6274 &events::MessageSendEvent::SendChannelAnnouncement { ref node_id, .. } => node_id != counterparty_node_id,
6275 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6276 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6277 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6278 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6279 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6280 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6281 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6282 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6286 if no_channels_remain {
6287 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
6290 for failure in failed_channels.drain(..) {
6291 self.finish_force_close_channel(failure);
6295 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6296 if !init_msg.features.supports_static_remote_key() {
6297 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6301 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6303 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6306 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6307 match peer_state_lock.entry(counterparty_node_id.clone()) {
6308 hash_map::Entry::Vacant(e) => {
6309 e.insert(Mutex::new(PeerState {
6310 latest_features: init_msg.features.clone(),
6313 hash_map::Entry::Occupied(e) => {
6314 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6319 let mut channel_state_lock = self.channel_state.lock().unwrap();
6320 let channel_state = &mut *channel_state_lock;
6321 let pending_msg_events = &mut channel_state.pending_msg_events;
6322 channel_state.by_id.retain(|_, chan| {
6323 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6324 if !chan.have_received_message() {
6325 // If we created this (outbound) channel while we were disconnected from the
6326 // peer we probably failed to send the open_channel message, which is now
6327 // lost. We can't have had anything pending related to this channel, so we just
6331 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6332 node_id: chan.get_counterparty_node_id(),
6333 msg: chan.get_channel_reestablish(&self.logger),
6338 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6339 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
6340 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6341 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6342 node_id: *counterparty_node_id,
6350 //TODO: Also re-broadcast announcement_signatures
6354 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6355 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6357 if msg.channel_id == [0; 32] {
6358 for chan in self.list_channels() {
6359 if chan.counterparty.node_id == *counterparty_node_id {
6360 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6361 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6366 // First check if we can advance the channel type and try again.
6367 let mut channel_state = self.channel_state.lock().unwrap();
6368 if let Some(chan) = channel_state.by_id.get_mut(&msg.channel_id) {
6369 if chan.get_counterparty_node_id() != *counterparty_node_id {
6372 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6373 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6374 node_id: *counterparty_node_id,
6382 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6383 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6387 fn provided_node_features(&self) -> NodeFeatures {
6388 provided_node_features()
6391 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6392 provided_init_features()
6396 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6397 /// [`ChannelManager`].
6398 pub fn provided_node_features() -> NodeFeatures {
6399 provided_init_features().to_context()
6402 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6403 /// [`ChannelManager`].
6405 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6406 /// or not. Thus, this method is not public.
6407 #[cfg(any(feature = "_test_utils", test))]
6408 pub fn provided_invoice_features() -> InvoiceFeatures {
6409 provided_init_features().to_context()
6412 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6413 /// [`ChannelManager`].
6414 pub fn provided_channel_features() -> ChannelFeatures {
6415 provided_init_features().to_context()
6418 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6419 /// [`ChannelManager`].
6420 pub fn provided_init_features() -> InitFeatures {
6421 // Note that if new features are added here which other peers may (eventually) require, we
6422 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6423 // ErroringMessageHandler.
6424 let mut features = InitFeatures::empty();
6425 features.set_data_loss_protect_optional();
6426 features.set_upfront_shutdown_script_optional();
6427 features.set_variable_length_onion_required();
6428 features.set_static_remote_key_required();
6429 features.set_payment_secret_required();
6430 features.set_basic_mpp_optional();
6431 features.set_wumbo_optional();
6432 features.set_shutdown_any_segwit_optional();
6433 features.set_channel_type_optional();
6434 features.set_scid_privacy_optional();
6435 features.set_zero_conf_optional();
6439 const SERIALIZATION_VERSION: u8 = 1;
6440 const MIN_SERIALIZATION_VERSION: u8 = 1;
6442 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6443 (2, fee_base_msat, required),
6444 (4, fee_proportional_millionths, required),
6445 (6, cltv_expiry_delta, required),
6448 impl_writeable_tlv_based!(ChannelCounterparty, {
6449 (2, node_id, required),
6450 (4, features, required),
6451 (6, unspendable_punishment_reserve, required),
6452 (8, forwarding_info, option),
6453 (9, outbound_htlc_minimum_msat, option),
6454 (11, outbound_htlc_maximum_msat, option),
6457 impl Writeable for ChannelDetails {
6458 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6459 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6460 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6461 let user_channel_id_low = self.user_channel_id as u64;
6462 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6463 write_tlv_fields!(writer, {
6464 (1, self.inbound_scid_alias, option),
6465 (2, self.channel_id, required),
6466 (3, self.channel_type, option),
6467 (4, self.counterparty, required),
6468 (5, self.outbound_scid_alias, option),
6469 (6, self.funding_txo, option),
6470 (7, self.config, option),
6471 (8, self.short_channel_id, option),
6472 (10, self.channel_value_satoshis, required),
6473 (12, self.unspendable_punishment_reserve, option),
6474 (14, user_channel_id_low, required),
6475 (16, self.balance_msat, required),
6476 (18, self.outbound_capacity_msat, required),
6477 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6478 // filled in, so we can safely unwrap it here.
6479 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6480 (20, self.inbound_capacity_msat, required),
6481 (22, self.confirmations_required, option),
6482 (24, self.force_close_spend_delay, option),
6483 (26, self.is_outbound, required),
6484 (28, self.is_channel_ready, required),
6485 (30, self.is_usable, required),
6486 (32, self.is_public, required),
6487 (33, self.inbound_htlc_minimum_msat, option),
6488 (35, self.inbound_htlc_maximum_msat, option),
6489 (37, user_channel_id_high_opt, option),
6495 impl Readable for ChannelDetails {
6496 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6497 init_and_read_tlv_fields!(reader, {
6498 (1, inbound_scid_alias, option),
6499 (2, channel_id, required),
6500 (3, channel_type, option),
6501 (4, counterparty, required),
6502 (5, outbound_scid_alias, option),
6503 (6, funding_txo, option),
6504 (7, config, option),
6505 (8, short_channel_id, option),
6506 (10, channel_value_satoshis, required),
6507 (12, unspendable_punishment_reserve, option),
6508 (14, user_channel_id_low, required),
6509 (16, balance_msat, required),
6510 (18, outbound_capacity_msat, required),
6511 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6512 // filled in, so we can safely unwrap it here.
6513 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6514 (20, inbound_capacity_msat, required),
6515 (22, confirmations_required, option),
6516 (24, force_close_spend_delay, option),
6517 (26, is_outbound, required),
6518 (28, is_channel_ready, required),
6519 (30, is_usable, required),
6520 (32, is_public, required),
6521 (33, inbound_htlc_minimum_msat, option),
6522 (35, inbound_htlc_maximum_msat, option),
6523 (37, user_channel_id_high_opt, option),
6526 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6527 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6528 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6529 let user_channel_id = user_channel_id_low as u128 +
6530 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6534 channel_id: channel_id.0.unwrap(),
6536 counterparty: counterparty.0.unwrap(),
6537 outbound_scid_alias,
6541 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6542 unspendable_punishment_reserve,
6544 balance_msat: balance_msat.0.unwrap(),
6545 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6546 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6547 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6548 confirmations_required,
6549 force_close_spend_delay,
6550 is_outbound: is_outbound.0.unwrap(),
6551 is_channel_ready: is_channel_ready.0.unwrap(),
6552 is_usable: is_usable.0.unwrap(),
6553 is_public: is_public.0.unwrap(),
6554 inbound_htlc_minimum_msat,
6555 inbound_htlc_maximum_msat,
6560 impl_writeable_tlv_based!(PhantomRouteHints, {
6561 (2, channels, vec_type),
6562 (4, phantom_scid, required),
6563 (6, real_node_pubkey, required),
6566 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6568 (0, onion_packet, required),
6569 (2, short_channel_id, required),
6572 (0, payment_data, required),
6573 (1, phantom_shared_secret, option),
6574 (2, incoming_cltv_expiry, required),
6576 (2, ReceiveKeysend) => {
6577 (0, payment_preimage, required),
6578 (2, incoming_cltv_expiry, required),
6582 impl_writeable_tlv_based!(PendingHTLCInfo, {
6583 (0, routing, required),
6584 (2, incoming_shared_secret, required),
6585 (4, payment_hash, required),
6586 (6, outgoing_amt_msat, required),
6587 (8, outgoing_cltv_value, required),
6588 (9, incoming_amt_msat, option),
6592 impl Writeable for HTLCFailureMsg {
6593 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6595 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6597 channel_id.write(writer)?;
6598 htlc_id.write(writer)?;
6599 reason.write(writer)?;
6601 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6602 channel_id, htlc_id, sha256_of_onion, failure_code
6605 channel_id.write(writer)?;
6606 htlc_id.write(writer)?;
6607 sha256_of_onion.write(writer)?;
6608 failure_code.write(writer)?;
6615 impl Readable for HTLCFailureMsg {
6616 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6617 let id: u8 = Readable::read(reader)?;
6620 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6621 channel_id: Readable::read(reader)?,
6622 htlc_id: Readable::read(reader)?,
6623 reason: Readable::read(reader)?,
6627 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6628 channel_id: Readable::read(reader)?,
6629 htlc_id: Readable::read(reader)?,
6630 sha256_of_onion: Readable::read(reader)?,
6631 failure_code: Readable::read(reader)?,
6634 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6635 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6636 // messages contained in the variants.
6637 // In version 0.0.101, support for reading the variants with these types was added, and
6638 // we should migrate to writing these variants when UpdateFailHTLC or
6639 // UpdateFailMalformedHTLC get TLV fields.
6641 let length: BigSize = Readable::read(reader)?;
6642 let mut s = FixedLengthReader::new(reader, length.0);
6643 let res = Readable::read(&mut s)?;
6644 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6645 Ok(HTLCFailureMsg::Relay(res))
6648 let length: BigSize = Readable::read(reader)?;
6649 let mut s = FixedLengthReader::new(reader, length.0);
6650 let res = Readable::read(&mut s)?;
6651 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6652 Ok(HTLCFailureMsg::Malformed(res))
6654 _ => Err(DecodeError::UnknownRequiredFeature),
6659 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6664 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6665 (0, short_channel_id, required),
6666 (1, phantom_shared_secret, option),
6667 (2, outpoint, required),
6668 (4, htlc_id, required),
6669 (6, incoming_packet_shared_secret, required)
6672 impl Writeable for ClaimableHTLC {
6673 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6674 let (payment_data, keysend_preimage) = match &self.onion_payload {
6675 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6676 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6678 write_tlv_fields!(writer, {
6679 (0, self.prev_hop, required),
6680 (1, self.total_msat, required),
6681 (2, self.value, required),
6682 (4, payment_data, option),
6683 (6, self.cltv_expiry, required),
6684 (8, keysend_preimage, option),
6690 impl Readable for ClaimableHTLC {
6691 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6692 let mut prev_hop = crate::util::ser::OptionDeserWrapper(None);
6694 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6695 let mut cltv_expiry = 0;
6696 let mut total_msat = None;
6697 let mut keysend_preimage: Option<PaymentPreimage> = None;
6698 read_tlv_fields!(reader, {
6699 (0, prev_hop, required),
6700 (1, total_msat, option),
6701 (2, value, required),
6702 (4, payment_data, option),
6703 (6, cltv_expiry, required),
6704 (8, keysend_preimage, option)
6706 let onion_payload = match keysend_preimage {
6708 if payment_data.is_some() {
6709 return Err(DecodeError::InvalidValue)
6711 if total_msat.is_none() {
6712 total_msat = Some(value);
6714 OnionPayload::Spontaneous(p)
6717 if total_msat.is_none() {
6718 if payment_data.is_none() {
6719 return Err(DecodeError::InvalidValue)
6721 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6723 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6727 prev_hop: prev_hop.0.unwrap(),
6730 total_msat: total_msat.unwrap(),
6737 impl Readable for HTLCSource {
6738 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6739 let id: u8 = Readable::read(reader)?;
6742 let mut session_priv: crate::util::ser::OptionDeserWrapper<SecretKey> = crate::util::ser::OptionDeserWrapper(None);
6743 let mut first_hop_htlc_msat: u64 = 0;
6744 let mut path = Some(Vec::new());
6745 let mut payment_id = None;
6746 let mut payment_secret = None;
6747 let mut payment_params = None;
6748 read_tlv_fields!(reader, {
6749 (0, session_priv, required),
6750 (1, payment_id, option),
6751 (2, first_hop_htlc_msat, required),
6752 (3, payment_secret, option),
6753 (4, path, vec_type),
6754 (5, payment_params, option),
6756 if payment_id.is_none() {
6757 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6759 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6761 Ok(HTLCSource::OutboundRoute {
6762 session_priv: session_priv.0.unwrap(),
6763 first_hop_htlc_msat,
6764 path: path.unwrap(),
6765 payment_id: payment_id.unwrap(),
6770 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6771 _ => Err(DecodeError::UnknownRequiredFeature),
6776 impl Writeable for HTLCSource {
6777 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6779 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6781 let payment_id_opt = Some(payment_id);
6782 write_tlv_fields!(writer, {
6783 (0, session_priv, required),
6784 (1, payment_id_opt, option),
6785 (2, first_hop_htlc_msat, required),
6786 (3, payment_secret, option),
6787 (4, *path, vec_type),
6788 (5, payment_params, option),
6791 HTLCSource::PreviousHopData(ref field) => {
6793 field.write(writer)?;
6800 impl_writeable_tlv_based_enum!(HTLCFailReason,
6801 (0, LightningError) => {
6805 (0, failure_code, required),
6806 (2, data, vec_type),
6810 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
6811 (0, forward_info, required),
6812 (2, prev_short_channel_id, required),
6813 (4, prev_htlc_id, required),
6814 (6, prev_funding_outpoint, required),
6817 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6819 (0, htlc_id, required),
6820 (2, err_packet, required),
6825 impl_writeable_tlv_based!(PendingInboundPayment, {
6826 (0, payment_secret, required),
6827 (2, expiry_time, required),
6828 (4, user_payment_id, required),
6829 (6, payment_preimage, required),
6830 (8, min_value_msat, required),
6833 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
6835 (0, session_privs, required),
6838 (0, session_privs, required),
6839 (1, payment_hash, option),
6840 (3, timer_ticks_without_htlcs, (default_value, 0)),
6843 (0, session_privs, required),
6844 (1, pending_fee_msat, option),
6845 (2, payment_hash, required),
6846 (4, payment_secret, option),
6847 (6, total_msat, required),
6848 (8, pending_amt_msat, required),
6849 (10, starting_block_height, required),
6852 (0, session_privs, required),
6853 (2, payment_hash, required),
6857 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<M, T, K, F, L>
6858 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6859 T::Target: BroadcasterInterface,
6860 K::Target: KeysInterface,
6861 F::Target: FeeEstimator,
6864 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6865 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6867 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6869 self.genesis_hash.write(writer)?;
6871 let best_block = self.best_block.read().unwrap();
6872 best_block.height().write(writer)?;
6873 best_block.block_hash().write(writer)?;
6877 // Take `channel_state` lock temporarily to avoid creating a lock order that requires
6878 // that the `forward_htlcs` lock is taken after `channel_state`
6879 let channel_state = self.channel_state.lock().unwrap();
6880 let mut unfunded_channels = 0;
6881 for (_, channel) in channel_state.by_id.iter() {
6882 if !channel.is_funding_initiated() {
6883 unfunded_channels += 1;
6886 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
6887 for (_, channel) in channel_state.by_id.iter() {
6888 if channel.is_funding_initiated() {
6889 channel.write(writer)?;
6895 let forward_htlcs = self.forward_htlcs.lock().unwrap();
6896 (forward_htlcs.len() as u64).write(writer)?;
6897 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
6898 short_channel_id.write(writer)?;
6899 (pending_forwards.len() as u64).write(writer)?;
6900 for forward in pending_forwards {
6901 forward.write(writer)?;
6906 let channel_state = self.channel_state.lock().unwrap();
6907 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6908 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
6909 for (payment_hash, (purpose, previous_hops)) in channel_state.claimable_htlcs.iter() {
6910 payment_hash.write(writer)?;
6911 (previous_hops.len() as u64).write(writer)?;
6912 for htlc in previous_hops.iter() {
6913 htlc.write(writer)?;
6915 htlc_purposes.push(purpose);
6918 let per_peer_state = self.per_peer_state.write().unwrap();
6919 (per_peer_state.len() as u64).write(writer)?;
6920 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6921 peer_pubkey.write(writer)?;
6922 let peer_state = peer_state_mutex.lock().unwrap();
6923 peer_state.latest_features.write(writer)?;
6926 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6927 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
6928 let events = self.pending_events.lock().unwrap();
6929 (events.len() as u64).write(writer)?;
6930 for event in events.iter() {
6931 event.write(writer)?;
6934 let background_events = self.pending_background_events.lock().unwrap();
6935 (background_events.len() as u64).write(writer)?;
6936 for event in background_events.iter() {
6938 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6940 funding_txo.write(writer)?;
6941 monitor_update.write(writer)?;
6946 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
6947 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
6948 // likely to be identical.
6949 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6950 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6952 (pending_inbound_payments.len() as u64).write(writer)?;
6953 for (hash, pending_payment) in pending_inbound_payments.iter() {
6954 hash.write(writer)?;
6955 pending_payment.write(writer)?;
6958 // For backwards compat, write the session privs and their total length.
6959 let mut num_pending_outbounds_compat: u64 = 0;
6960 for (_, outbound) in pending_outbound_payments.iter() {
6961 if !outbound.is_fulfilled() && !outbound.abandoned() {
6962 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6965 num_pending_outbounds_compat.write(writer)?;
6966 for (_, outbound) in pending_outbound_payments.iter() {
6968 PendingOutboundPayment::Legacy { session_privs } |
6969 PendingOutboundPayment::Retryable { session_privs, .. } => {
6970 for session_priv in session_privs.iter() {
6971 session_priv.write(writer)?;
6974 PendingOutboundPayment::Fulfilled { .. } => {},
6975 PendingOutboundPayment::Abandoned { .. } => {},
6979 // Encode without retry info for 0.0.101 compatibility.
6980 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6981 for (id, outbound) in pending_outbound_payments.iter() {
6983 PendingOutboundPayment::Legacy { session_privs } |
6984 PendingOutboundPayment::Retryable { session_privs, .. } => {
6985 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6990 write_tlv_fields!(writer, {
6991 (1, pending_outbound_payments_no_retry, required),
6992 (3, pending_outbound_payments, required),
6993 (5, self.our_network_pubkey, required),
6994 (7, self.fake_scid_rand_bytes, required),
6995 (9, htlc_purposes, vec_type),
6996 (11, self.probing_cookie_secret, required),
7003 /// Arguments for the creation of a ChannelManager that are not deserialized.
7005 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
7007 /// 1) Deserialize all stored [`ChannelMonitor`]s.
7008 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
7009 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
7010 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
7011 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
7012 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
7013 /// same way you would handle a [`chain::Filter`] call using
7014 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
7015 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
7016 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
7017 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
7018 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
7019 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
7021 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
7022 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
7024 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
7025 /// call any other methods on the newly-deserialized [`ChannelManager`].
7027 /// Note that because some channels may be closed during deserialization, it is critical that you
7028 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
7029 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
7030 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
7031 /// not force-close the same channels but consider them live), you may end up revoking a state for
7032 /// which you've already broadcasted the transaction.
7034 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
7035 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7036 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7037 T::Target: BroadcasterInterface,
7038 K::Target: KeysInterface,
7039 F::Target: FeeEstimator,
7042 /// The keys provider which will give us relevant keys. Some keys will be loaded during
7043 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
7045 pub keys_manager: K,
7047 /// The fee_estimator for use in the ChannelManager in the future.
7049 /// No calls to the FeeEstimator will be made during deserialization.
7050 pub fee_estimator: F,
7051 /// The chain::Watch for use in the ChannelManager in the future.
7053 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
7054 /// you have deserialized ChannelMonitors separately and will add them to your
7055 /// chain::Watch after deserializing this ChannelManager.
7056 pub chain_monitor: M,
7058 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
7059 /// used to broadcast the latest local commitment transactions of channels which must be
7060 /// force-closed during deserialization.
7061 pub tx_broadcaster: T,
7062 /// The Logger for use in the ChannelManager and which may be used to log information during
7063 /// deserialization.
7065 /// Default settings used for new channels. Any existing channels will continue to use the
7066 /// runtime settings which were stored when the ChannelManager was serialized.
7067 pub default_config: UserConfig,
7069 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
7070 /// value.get_funding_txo() should be the key).
7072 /// If a monitor is inconsistent with the channel state during deserialization the channel will
7073 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
7074 /// is true for missing channels as well. If there is a monitor missing for which we find
7075 /// channel data Err(DecodeError::InvalidValue) will be returned.
7077 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
7080 /// (C-not exported) because we have no HashMap bindings
7081 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<K::Target as KeysInterface>::Signer>>,
7084 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7085 ChannelManagerReadArgs<'a, M, T, K, F, L>
7086 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7087 T::Target: BroadcasterInterface,
7088 K::Target: KeysInterface,
7089 F::Target: FeeEstimator,
7092 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
7093 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
7094 /// populate a HashMap directly from C.
7095 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
7096 mut channel_monitors: Vec<&'a mut ChannelMonitor<<K::Target as KeysInterface>::Signer>>) -> Self {
7098 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
7099 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
7104 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
7105 // SipmleArcChannelManager type:
7106 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7107 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<M, T, K, F, L>>)
7108 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7109 T::Target: BroadcasterInterface,
7110 K::Target: KeysInterface,
7111 F::Target: FeeEstimator,
7114 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, M, T, K, F, L>) -> Result<Self, DecodeError> {
7115 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, K, F, L>)>::read(reader, args)?;
7116 Ok((blockhash, Arc::new(chan_manager)))
7120 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7121 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, L>> for (BlockHash, ChannelManager<M, T, K, F, L>)
7122 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7123 T::Target: BroadcasterInterface,
7124 K::Target: KeysInterface,
7125 F::Target: FeeEstimator,
7128 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, M, T, K, F, L>) -> Result<Self, DecodeError> {
7129 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
7131 let genesis_hash: BlockHash = Readable::read(reader)?;
7132 let best_block_height: u32 = Readable::read(reader)?;
7133 let best_block_hash: BlockHash = Readable::read(reader)?;
7135 let mut failed_htlcs = Vec::new();
7137 let channel_count: u64 = Readable::read(reader)?;
7138 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
7139 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7140 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7141 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7142 let mut channel_closures = Vec::new();
7143 for _ in 0..channel_count {
7144 let mut channel: Channel<<K::Target as KeysInterface>::Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
7145 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
7146 funding_txo_set.insert(funding_txo.clone());
7147 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
7148 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
7149 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
7150 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
7151 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7152 // If the channel is ahead of the monitor, return InvalidValue:
7153 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7154 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7155 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7156 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7157 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7158 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7159 log_error!(args.logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
7160 return Err(DecodeError::InvalidValue);
7161 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7162 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7163 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7164 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7165 // But if the channel is behind of the monitor, close the channel:
7166 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7167 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7168 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7169 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7170 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
7171 failed_htlcs.append(&mut new_failed_htlcs);
7172 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7173 channel_closures.push(events::Event::ChannelClosed {
7174 channel_id: channel.channel_id(),
7175 user_channel_id: channel.get_user_id(),
7176 reason: ClosureReason::OutdatedChannelManager
7179 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7180 if let Some(short_channel_id) = channel.get_short_channel_id() {
7181 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7183 if channel.is_funding_initiated() {
7184 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7186 by_id.insert(channel.channel_id(), channel);
7188 } else if channel.is_awaiting_initial_mon_persist() {
7189 // If we were persisted and shut down while the initial ChannelMonitor persistence
7190 // was in-progress, we never broadcasted the funding transaction and can still
7191 // safely discard the channel.
7192 let _ = channel.force_shutdown(false);
7193 channel_closures.push(events::Event::ChannelClosed {
7194 channel_id: channel.channel_id(),
7195 user_channel_id: channel.get_user_id(),
7196 reason: ClosureReason::DisconnectedPeer,
7199 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7200 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7201 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7202 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7203 log_error!(args.logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
7204 return Err(DecodeError::InvalidValue);
7208 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
7209 if !funding_txo_set.contains(funding_txo) {
7210 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7211 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7215 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7216 let forward_htlcs_count: u64 = Readable::read(reader)?;
7217 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7218 for _ in 0..forward_htlcs_count {
7219 let short_channel_id = Readable::read(reader)?;
7220 let pending_forwards_count: u64 = Readable::read(reader)?;
7221 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7222 for _ in 0..pending_forwards_count {
7223 pending_forwards.push(Readable::read(reader)?);
7225 forward_htlcs.insert(short_channel_id, pending_forwards);
7228 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7229 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7230 for _ in 0..claimable_htlcs_count {
7231 let payment_hash = Readable::read(reader)?;
7232 let previous_hops_len: u64 = Readable::read(reader)?;
7233 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7234 for _ in 0..previous_hops_len {
7235 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7237 claimable_htlcs_list.push((payment_hash, previous_hops));
7240 let peer_count: u64 = Readable::read(reader)?;
7241 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
7242 for _ in 0..peer_count {
7243 let peer_pubkey = Readable::read(reader)?;
7244 let peer_state = PeerState {
7245 latest_features: Readable::read(reader)?,
7247 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7250 let event_count: u64 = Readable::read(reader)?;
7251 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>()));
7252 for _ in 0..event_count {
7253 match MaybeReadable::read(reader)? {
7254 Some(event) => pending_events_read.push(event),
7258 if forward_htlcs_count > 0 {
7259 // If we have pending HTLCs to forward, assume we either dropped a
7260 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7261 // shut down before the timer hit. Either way, set the time_forwardable to a small
7262 // constant as enough time has likely passed that we should simply handle the forwards
7263 // now, or at least after the user gets a chance to reconnect to our peers.
7264 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7265 time_forwardable: Duration::from_secs(2),
7269 let background_event_count: u64 = Readable::read(reader)?;
7270 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>()));
7271 for _ in 0..background_event_count {
7272 match <u8 as Readable>::read(reader)? {
7273 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7274 _ => return Err(DecodeError::InvalidValue),
7278 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7279 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7281 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7282 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7283 for _ in 0..pending_inbound_payment_count {
7284 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7285 return Err(DecodeError::InvalidValue);
7289 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7290 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7291 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7292 for _ in 0..pending_outbound_payments_count_compat {
7293 let session_priv = Readable::read(reader)?;
7294 let payment = PendingOutboundPayment::Legacy {
7295 session_privs: [session_priv].iter().cloned().collect()
7297 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7298 return Err(DecodeError::InvalidValue)
7302 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7303 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7304 let mut pending_outbound_payments = None;
7305 let mut received_network_pubkey: Option<PublicKey> = None;
7306 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7307 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7308 let mut claimable_htlc_purposes = None;
7309 read_tlv_fields!(reader, {
7310 (1, pending_outbound_payments_no_retry, option),
7311 (3, pending_outbound_payments, option),
7312 (5, received_network_pubkey, option),
7313 (7, fake_scid_rand_bytes, option),
7314 (9, claimable_htlc_purposes, vec_type),
7315 (11, probing_cookie_secret, option),
7317 if fake_scid_rand_bytes.is_none() {
7318 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
7321 if probing_cookie_secret.is_none() {
7322 probing_cookie_secret = Some(args.keys_manager.get_secure_random_bytes());
7325 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7326 pending_outbound_payments = Some(pending_outbound_payments_compat);
7327 } else if pending_outbound_payments.is_none() {
7328 let mut outbounds = HashMap::new();
7329 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7330 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7332 pending_outbound_payments = Some(outbounds);
7334 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7335 // ChannelMonitor data for any channels for which we do not have authorative state
7336 // (i.e. those for which we just force-closed above or we otherwise don't have a
7337 // corresponding `Channel` at all).
7338 // This avoids several edge-cases where we would otherwise "forget" about pending
7339 // payments which are still in-flight via their on-chain state.
7340 // We only rebuild the pending payments map if we were most recently serialized by
7342 for (_, monitor) in args.channel_monitors.iter() {
7343 if by_id.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7344 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7345 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7346 if path.is_empty() {
7347 log_error!(args.logger, "Got an empty path for a pending payment");
7348 return Err(DecodeError::InvalidValue);
7350 let path_amt = path.last().unwrap().fee_msat;
7351 let mut session_priv_bytes = [0; 32];
7352 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7353 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7354 hash_map::Entry::Occupied(mut entry) => {
7355 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7356 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7357 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7359 hash_map::Entry::Vacant(entry) => {
7360 let path_fee = path.get_path_fees();
7361 entry.insert(PendingOutboundPayment::Retryable {
7362 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7363 payment_hash: htlc.payment_hash,
7365 pending_amt_msat: path_amt,
7366 pending_fee_msat: Some(path_fee),
7367 total_msat: path_amt,
7368 starting_block_height: best_block_height,
7370 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7371 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7380 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7381 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7383 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7384 if let Some(mut purposes) = claimable_htlc_purposes {
7385 if purposes.len() != claimable_htlcs_list.len() {
7386 return Err(DecodeError::InvalidValue);
7388 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7389 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7392 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7393 // include a `_legacy_hop_data` in the `OnionPayload`.
7394 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7395 if previous_hops.is_empty() {
7396 return Err(DecodeError::InvalidValue);
7398 let purpose = match &previous_hops[0].onion_payload {
7399 OnionPayload::Invoice { _legacy_hop_data } => {
7400 if let Some(hop_data) = _legacy_hop_data {
7401 events::PaymentPurpose::InvoicePayment {
7402 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7403 Some(inbound_payment) => inbound_payment.payment_preimage,
7404 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7405 Ok(payment_preimage) => payment_preimage,
7407 log_error!(args.logger, "Failed to read claimable payment data for HTLC with payment hash {} - was not a pending inbound payment and didn't match our payment key", log_bytes!(payment_hash.0));
7408 return Err(DecodeError::InvalidValue);
7412 payment_secret: hop_data.payment_secret,
7414 } else { return Err(DecodeError::InvalidValue); }
7416 OnionPayload::Spontaneous(payment_preimage) =>
7417 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7419 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7423 let mut secp_ctx = Secp256k1::new();
7424 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7426 if !channel_closures.is_empty() {
7427 pending_events_read.append(&mut channel_closures);
7430 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7432 Err(()) => return Err(DecodeError::InvalidValue)
7434 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7435 if let Some(network_pubkey) = received_network_pubkey {
7436 if network_pubkey != our_network_pubkey {
7437 log_error!(args.logger, "Key that was generated does not match the existing key.");
7438 return Err(DecodeError::InvalidValue);
7442 let mut outbound_scid_aliases = HashSet::new();
7443 for (chan_id, chan) in by_id.iter_mut() {
7444 if chan.outbound_scid_alias() == 0 {
7445 let mut outbound_scid_alias;
7447 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7448 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7449 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7451 chan.set_outbound_scid_alias(outbound_scid_alias);
7452 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7453 // Note that in rare cases its possible to hit this while reading an older
7454 // channel if we just happened to pick a colliding outbound alias above.
7455 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7456 return Err(DecodeError::InvalidValue);
7458 if chan.is_usable() {
7459 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7460 // Note that in rare cases its possible to hit this while reading an older
7461 // channel if we just happened to pick a colliding outbound alias above.
7462 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7463 return Err(DecodeError::InvalidValue);
7468 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7470 for (_, monitor) in args.channel_monitors.iter() {
7471 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7472 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7473 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7474 let mut claimable_amt_msat = 0;
7475 for claimable_htlc in claimable_htlcs {
7476 claimable_amt_msat += claimable_htlc.value;
7478 // Add a holding-cell claim of the payment to the Channel, which should be
7479 // applied ~immediately on peer reconnection. Because it won't generate a
7480 // new commitment transaction we can just provide the payment preimage to
7481 // the corresponding ChannelMonitor and nothing else.
7483 // We do so directly instead of via the normal ChannelMonitor update
7484 // procedure as the ChainMonitor hasn't yet been initialized, implying
7485 // we're not allowed to call it directly yet. Further, we do the update
7486 // without incrementing the ChannelMonitor update ID as there isn't any
7488 // If we were to generate a new ChannelMonitor update ID here and then
7489 // crash before the user finishes block connect we'd end up force-closing
7490 // this channel as well. On the flip side, there's no harm in restarting
7491 // without the new monitor persisted - we'll end up right back here on
7493 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7494 if let Some(channel) = by_id.get_mut(&previous_channel_id) {
7495 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7497 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7498 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7501 pending_events_read.push(events::Event::PaymentClaimed {
7503 purpose: payment_purpose,
7504 amount_msat: claimable_amt_msat,
7510 let channel_manager = ChannelManager {
7512 fee_estimator: bounded_fee_estimator,
7513 chain_monitor: args.chain_monitor,
7514 tx_broadcaster: args.tx_broadcaster,
7516 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7518 channel_state: Mutex::new(ChannelHolder {
7521 pending_msg_events: Vec::new(),
7523 inbound_payment_key: expanded_inbound_key,
7524 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7525 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7527 forward_htlcs: Mutex::new(forward_htlcs),
7528 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7529 id_to_peer: Mutex::new(id_to_peer),
7530 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7531 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7533 probing_cookie_secret: probing_cookie_secret.unwrap(),
7539 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7541 per_peer_state: RwLock::new(per_peer_state),
7543 pending_events: Mutex::new(pending_events_read),
7544 pending_background_events: Mutex::new(pending_background_events_read),
7545 total_consistency_lock: RwLock::new(()),
7546 persistence_notifier: Notifier::new(),
7548 keys_manager: args.keys_manager,
7549 logger: args.logger,
7550 default_configuration: args.default_config,
7553 for htlc_source in failed_htlcs.drain(..) {
7554 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7555 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7556 channel_manager.fail_htlc_backwards_internal(source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
7559 //TODO: Broadcast channel update for closed channels, but only after we've made a
7560 //connection or two.
7562 Ok((best_block_hash.clone(), channel_manager))
7568 use bitcoin::hashes::Hash;
7569 use bitcoin::hashes::sha256::Hash as Sha256;
7570 use core::time::Duration;
7571 use core::sync::atomic::Ordering;
7572 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7573 use crate::ln::channelmanager::{self, inbound_payment, PaymentId, PaymentSendFailure};
7574 use crate::ln::functional_test_utils::*;
7575 use crate::ln::msgs;
7576 use crate::ln::msgs::ChannelMessageHandler;
7577 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7578 use crate::util::errors::APIError;
7579 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7580 use crate::util::test_utils;
7581 use crate::chain::keysinterface::KeysInterface;
7584 fn test_notify_limits() {
7585 // Check that a few cases which don't require the persistence of a new ChannelManager,
7586 // indeed, do not cause the persistence of a new ChannelManager.
7587 let chanmon_cfgs = create_chanmon_cfgs(3);
7588 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7589 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7590 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7592 // All nodes start with a persistable update pending as `create_network` connects each node
7593 // with all other nodes to make most tests simpler.
7594 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7595 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7596 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7598 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7600 // We check that the channel info nodes have doesn't change too early, even though we try
7601 // to connect messages with new values
7602 chan.0.contents.fee_base_msat *= 2;
7603 chan.1.contents.fee_base_msat *= 2;
7604 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7605 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7607 // The first two nodes (which opened a channel) should now require fresh persistence
7608 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7609 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7610 // ... but the last node should not.
7611 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7612 // After persisting the first two nodes they should no longer need fresh persistence.
7613 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7614 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7616 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7617 // about the channel.
7618 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7619 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7620 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7622 // The nodes which are a party to the channel should also ignore messages from unrelated
7624 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7625 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7626 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7627 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7628 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7629 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7631 // At this point the channel info given by peers should still be the same.
7632 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7633 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7635 // An earlier version of handle_channel_update didn't check the directionality of the
7636 // update message and would always update the local fee info, even if our peer was
7637 // (spuriously) forwarding us our own channel_update.
7638 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7639 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7640 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7642 // First deliver each peers' own message, checking that the node doesn't need to be
7643 // persisted and that its channel info remains the same.
7644 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7645 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7646 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7647 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7648 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7649 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7651 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7652 // the channel info has updated.
7653 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7654 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7655 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7656 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7657 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7658 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7662 fn test_keysend_dup_hash_partial_mpp() {
7663 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7665 let chanmon_cfgs = create_chanmon_cfgs(2);
7666 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7667 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7668 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7669 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7671 // First, send a partial MPP payment.
7672 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7673 let mut mpp_route = route.clone();
7674 mpp_route.paths.push(mpp_route.paths[0].clone());
7676 let payment_id = PaymentId([42; 32]);
7677 // Use the utility function send_payment_along_path to send the payment with MPP data which
7678 // indicates there are more HTLCs coming.
7679 let cur_height = CHAN_CONFIRM_DEPTH + 1; // route_payment calls send_payment, which adds 1 to the current height. So we do the same here to match.
7680 let session_privs = nodes[0].node.add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7681 nodes[0].node.send_payment_along_path(&mpp_route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
7682 check_added_monitors!(nodes[0], 1);
7683 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7684 assert_eq!(events.len(), 1);
7685 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7687 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7688 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7689 check_added_monitors!(nodes[0], 1);
7690 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7691 assert_eq!(events.len(), 1);
7692 let ev = events.drain(..).next().unwrap();
7693 let payment_event = SendEvent::from_event(ev);
7694 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7695 check_added_monitors!(nodes[1], 0);
7696 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7697 expect_pending_htlcs_forwardable!(nodes[1]);
7698 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7699 check_added_monitors!(nodes[1], 1);
7700 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7701 assert!(updates.update_add_htlcs.is_empty());
7702 assert!(updates.update_fulfill_htlcs.is_empty());
7703 assert_eq!(updates.update_fail_htlcs.len(), 1);
7704 assert!(updates.update_fail_malformed_htlcs.is_empty());
7705 assert!(updates.update_fee.is_none());
7706 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7707 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7708 expect_payment_failed!(nodes[0], our_payment_hash, true);
7710 // Send the second half of the original MPP payment.
7711 nodes[0].node.send_payment_along_path(&mpp_route.paths[1], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
7712 check_added_monitors!(nodes[0], 1);
7713 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7714 assert_eq!(events.len(), 1);
7715 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7717 // Claim the full MPP payment. Note that we can't use a test utility like
7718 // claim_funds_along_route because the ordering of the messages causes the second half of the
7719 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7720 // lightning messages manually.
7721 nodes[1].node.claim_funds(payment_preimage);
7722 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7723 check_added_monitors!(nodes[1], 2);
7725 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7726 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7727 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7728 check_added_monitors!(nodes[0], 1);
7729 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7730 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7731 check_added_monitors!(nodes[1], 1);
7732 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7733 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7734 check_added_monitors!(nodes[1], 1);
7735 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7736 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7737 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7738 check_added_monitors!(nodes[0], 1);
7739 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7740 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7741 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7742 check_added_monitors!(nodes[0], 1);
7743 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7744 check_added_monitors!(nodes[1], 1);
7745 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7746 check_added_monitors!(nodes[1], 1);
7747 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7748 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7749 check_added_monitors!(nodes[0], 1);
7751 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7752 // path's success and a PaymentPathSuccessful event for each path's success.
7753 let events = nodes[0].node.get_and_clear_pending_events();
7754 assert_eq!(events.len(), 3);
7756 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7757 assert_eq!(Some(payment_id), *id);
7758 assert_eq!(payment_preimage, *preimage);
7759 assert_eq!(our_payment_hash, *hash);
7761 _ => panic!("Unexpected event"),
7764 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7765 assert_eq!(payment_id, *actual_payment_id);
7766 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7767 assert_eq!(route.paths[0], *path);
7769 _ => panic!("Unexpected event"),
7772 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7773 assert_eq!(payment_id, *actual_payment_id);
7774 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7775 assert_eq!(route.paths[0], *path);
7777 _ => panic!("Unexpected event"),
7782 fn test_keysend_dup_payment_hash() {
7783 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7784 // outbound regular payment fails as expected.
7785 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7786 // fails as expected.
7787 let chanmon_cfgs = create_chanmon_cfgs(2);
7788 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7789 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7790 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7791 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7792 let scorer = test_utils::TestScorer::with_penalty(0);
7793 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7795 // To start (1), send a regular payment but don't claim it.
7796 let expected_route = [&nodes[1]];
7797 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7799 // Next, attempt a keysend payment and make sure it fails.
7800 let route_params = RouteParameters {
7801 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7802 final_value_msat: 100_000,
7803 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7805 let route = find_route(
7806 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7807 None, nodes[0].logger, &scorer, &random_seed_bytes
7809 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7810 check_added_monitors!(nodes[0], 1);
7811 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7812 assert_eq!(events.len(), 1);
7813 let ev = events.drain(..).next().unwrap();
7814 let payment_event = SendEvent::from_event(ev);
7815 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7816 check_added_monitors!(nodes[1], 0);
7817 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7818 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
7819 // fails), the second will process the resulting failure and fail the HTLC backward
7820 expect_pending_htlcs_forwardable!(nodes[1]);
7821 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7822 check_added_monitors!(nodes[1], 1);
7823 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7824 assert!(updates.update_add_htlcs.is_empty());
7825 assert!(updates.update_fulfill_htlcs.is_empty());
7826 assert_eq!(updates.update_fail_htlcs.len(), 1);
7827 assert!(updates.update_fail_malformed_htlcs.is_empty());
7828 assert!(updates.update_fee.is_none());
7829 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7830 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7831 expect_payment_failed!(nodes[0], payment_hash, true);
7833 // Finally, claim the original payment.
7834 claim_payment(&nodes[0], &expected_route, payment_preimage);
7836 // To start (2), send a keysend payment but don't claim it.
7837 let payment_preimage = PaymentPreimage([42; 32]);
7838 let route = find_route(
7839 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7840 None, nodes[0].logger, &scorer, &random_seed_bytes
7842 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7843 check_added_monitors!(nodes[0], 1);
7844 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7845 assert_eq!(events.len(), 1);
7846 let event = events.pop().unwrap();
7847 let path = vec![&nodes[1]];
7848 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7850 // Next, attempt a regular payment and make sure it fails.
7851 let payment_secret = PaymentSecret([43; 32]);
7852 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7853 check_added_monitors!(nodes[0], 1);
7854 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7855 assert_eq!(events.len(), 1);
7856 let ev = events.drain(..).next().unwrap();
7857 let payment_event = SendEvent::from_event(ev);
7858 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7859 check_added_monitors!(nodes[1], 0);
7860 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7861 expect_pending_htlcs_forwardable!(nodes[1]);
7862 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7863 check_added_monitors!(nodes[1], 1);
7864 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7865 assert!(updates.update_add_htlcs.is_empty());
7866 assert!(updates.update_fulfill_htlcs.is_empty());
7867 assert_eq!(updates.update_fail_htlcs.len(), 1);
7868 assert!(updates.update_fail_malformed_htlcs.is_empty());
7869 assert!(updates.update_fee.is_none());
7870 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7871 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7872 expect_payment_failed!(nodes[0], payment_hash, true);
7874 // Finally, succeed the keysend payment.
7875 claim_payment(&nodes[0], &expected_route, payment_preimage);
7879 fn test_keysend_hash_mismatch() {
7880 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7881 // preimage doesn't match the msg's payment hash.
7882 let chanmon_cfgs = create_chanmon_cfgs(2);
7883 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7884 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7885 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7887 let payer_pubkey = nodes[0].node.get_our_node_id();
7888 let payee_pubkey = nodes[1].node.get_our_node_id();
7889 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7890 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7892 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7893 let route_params = RouteParameters {
7894 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7895 final_value_msat: 10_000,
7896 final_cltv_expiry_delta: 40,
7898 let network_graph = nodes[0].network_graph;
7899 let first_hops = nodes[0].node.list_usable_channels();
7900 let scorer = test_utils::TestScorer::with_penalty(0);
7901 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7902 let route = find_route(
7903 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7904 nodes[0].logger, &scorer, &random_seed_bytes
7907 let test_preimage = PaymentPreimage([42; 32]);
7908 let mismatch_payment_hash = PaymentHash([43; 32]);
7909 let session_privs = nodes[0].node.add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
7910 nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
7911 check_added_monitors!(nodes[0], 1);
7913 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7914 assert_eq!(updates.update_add_htlcs.len(), 1);
7915 assert!(updates.update_fulfill_htlcs.is_empty());
7916 assert!(updates.update_fail_htlcs.is_empty());
7917 assert!(updates.update_fail_malformed_htlcs.is_empty());
7918 assert!(updates.update_fee.is_none());
7919 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7921 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7925 fn test_keysend_msg_with_secret_err() {
7926 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7927 let chanmon_cfgs = create_chanmon_cfgs(2);
7928 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7929 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7930 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7932 let payer_pubkey = nodes[0].node.get_our_node_id();
7933 let payee_pubkey = nodes[1].node.get_our_node_id();
7934 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7935 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7937 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7938 let route_params = RouteParameters {
7939 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7940 final_value_msat: 10_000,
7941 final_cltv_expiry_delta: 40,
7943 let network_graph = nodes[0].network_graph;
7944 let first_hops = nodes[0].node.list_usable_channels();
7945 let scorer = test_utils::TestScorer::with_penalty(0);
7946 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7947 let route = find_route(
7948 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7949 nodes[0].logger, &scorer, &random_seed_bytes
7952 let test_preimage = PaymentPreimage([42; 32]);
7953 let test_secret = PaymentSecret([43; 32]);
7954 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7955 let session_privs = nodes[0].node.add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
7956 nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
7957 check_added_monitors!(nodes[0], 1);
7959 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7960 assert_eq!(updates.update_add_htlcs.len(), 1);
7961 assert!(updates.update_fulfill_htlcs.is_empty());
7962 assert!(updates.update_fail_htlcs.is_empty());
7963 assert!(updates.update_fail_malformed_htlcs.is_empty());
7964 assert!(updates.update_fee.is_none());
7965 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7967 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7971 fn test_multi_hop_missing_secret() {
7972 let chanmon_cfgs = create_chanmon_cfgs(4);
7973 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7974 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7975 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7977 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7978 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7979 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7980 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7982 // Marshall an MPP route.
7983 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7984 let path = route.paths[0].clone();
7985 route.paths.push(path);
7986 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7987 route.paths[0][0].short_channel_id = chan_1_id;
7988 route.paths[0][1].short_channel_id = chan_3_id;
7989 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7990 route.paths[1][0].short_channel_id = chan_2_id;
7991 route.paths[1][1].short_channel_id = chan_4_id;
7993 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
7994 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
7995 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
7996 _ => panic!("unexpected error")
8001 fn bad_inbound_payment_hash() {
8002 // Add coverage for checking that a user-provided payment hash matches the payment secret.
8003 let chanmon_cfgs = create_chanmon_cfgs(2);
8004 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8005 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8006 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8008 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
8009 let payment_data = msgs::FinalOnionHopData {
8011 total_msat: 100_000,
8014 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
8015 // payment verification fails as expected.
8016 let mut bad_payment_hash = payment_hash.clone();
8017 bad_payment_hash.0[0] += 1;
8018 match inbound_payment::verify(bad_payment_hash, &payment_data, nodes[0].node.highest_seen_timestamp.load(Ordering::Acquire) as u64, &nodes[0].node.inbound_payment_key, &nodes[0].logger) {
8019 Ok(_) => panic!("Unexpected ok"),
8021 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
8025 // Check that using the original payment hash succeeds.
8026 assert!(inbound_payment::verify(payment_hash, &payment_data, nodes[0].node.highest_seen_timestamp.load(Ordering::Acquire) as u64, &nodes[0].node.inbound_payment_key, &nodes[0].logger).is_ok());
8030 fn test_id_to_peer_coverage() {
8031 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
8032 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
8033 // the channel is successfully closed.
8034 let chanmon_cfgs = create_chanmon_cfgs(2);
8035 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8036 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8037 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8039 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8040 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8041 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
8042 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8043 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
8045 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
8046 let channel_id = &tx.txid().into_inner();
8048 // Ensure that the `id_to_peer` map is empty until either party has received the
8049 // funding transaction, and have the real `channel_id`.
8050 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8051 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8054 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8056 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
8057 // as it has the funding transaction.
8058 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8059 assert_eq!(nodes_0_lock.len(), 1);
8060 assert!(nodes_0_lock.contains_key(channel_id));
8062 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8065 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8067 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8069 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8070 assert_eq!(nodes_0_lock.len(), 1);
8071 assert!(nodes_0_lock.contains_key(channel_id));
8073 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
8074 // as it has the funding transaction.
8075 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8076 assert_eq!(nodes_1_lock.len(), 1);
8077 assert!(nodes_1_lock.contains_key(channel_id));
8079 check_added_monitors!(nodes[1], 1);
8080 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8081 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8082 check_added_monitors!(nodes[0], 1);
8083 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8084 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8085 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8087 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8088 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
8089 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8090 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &nodes_1_shutdown);
8092 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8093 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8095 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8096 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8097 // fee for the closing transaction has been negotiated and the parties has the other
8098 // party's signature for the fee negotiated closing transaction.)
8099 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8100 assert_eq!(nodes_0_lock.len(), 1);
8101 assert!(nodes_0_lock.contains_key(channel_id));
8103 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8104 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8105 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8106 // kept in the `nodes[1]`'s `id_to_peer` map.
8107 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8108 assert_eq!(nodes_1_lock.len(), 1);
8109 assert!(nodes_1_lock.contains_key(channel_id));
8112 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id()));
8114 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8115 // therefore has all it needs to fully close the channel (both signatures for the
8116 // closing transaction).
8117 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8118 // fully closed by `nodes[0]`.
8119 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8121 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8122 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8123 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8124 assert_eq!(nodes_1_lock.len(), 1);
8125 assert!(nodes_1_lock.contains_key(channel_id));
8128 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8130 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8132 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8133 // they both have everything required to fully close the channel.
8134 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8136 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8138 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8139 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8143 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8145 use crate::chain::Listen;
8146 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8147 use crate::chain::keysinterface::{KeysManager, KeysInterface, InMemorySigner};
8148 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8149 use crate::ln::functional_test_utils::*;
8150 use crate::ln::msgs::{ChannelMessageHandler, Init};
8151 use crate::routing::gossip::NetworkGraph;
8152 use crate::routing::router::{PaymentParameters, get_route};
8153 use crate::util::test_utils;
8154 use crate::util::config::UserConfig;
8155 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8157 use bitcoin::hashes::Hash;
8158 use bitcoin::hashes::sha256::Hash as Sha256;
8159 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8161 use crate::sync::{Arc, Mutex};
8165 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8166 node: &'a ChannelManager<
8167 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8168 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8169 &'a test_utils::TestLogger, &'a P>,
8170 &'a test_utils::TestBroadcaster, &'a KeysManager,
8171 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>,
8176 fn bench_sends(bench: &mut Bencher) {
8177 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8180 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8181 // Do a simple benchmark of sending a payment back and forth between two nodes.
8182 // Note that this is unrealistic as each payment send will require at least two fsync
8184 let network = bitcoin::Network::Testnet;
8185 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
8187 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8188 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8190 let mut config: UserConfig = Default::default();
8191 config.channel_handshake_config.minimum_depth = 1;
8193 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8194 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8195 let seed_a = [1u8; 32];
8196 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8197 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
8199 best_block: BestBlock::from_genesis(network),
8201 let node_a_holder = NodeHolder { node: &node_a };
8203 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8204 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8205 let seed_b = [2u8; 32];
8206 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8207 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
8209 best_block: BestBlock::from_genesis(network),
8211 let node_b_holder = NodeHolder { node: &node_b };
8213 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8214 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8215 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8216 node_b.handle_open_channel(&node_a.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
8217 node_a.handle_accept_channel(&node_b.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
8220 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8221 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8222 value: 8_000_000, script_pubkey: output_script,
8224 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8225 } else { panic!(); }
8227 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()));
8228 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()));
8230 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8233 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8236 Listen::block_connected(&node_a, &block, 1);
8237 Listen::block_connected(&node_b, &block, 1);
8239 node_a.handle_channel_ready(&node_b.get_our_node_id(), &get_event_msg!(node_b_holder, MessageSendEvent::SendChannelReady, node_a.get_our_node_id()));
8240 let msg_events = node_a.get_and_clear_pending_msg_events();
8241 assert_eq!(msg_events.len(), 2);
8242 match msg_events[0] {
8243 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8244 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8245 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8249 match msg_events[1] {
8250 MessageSendEvent::SendChannelUpdate { .. } => {},
8254 let events_a = node_a.get_and_clear_pending_events();
8255 assert_eq!(events_a.len(), 1);
8257 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8258 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8260 _ => panic!("Unexpected event"),
8263 let events_b = node_b.get_and_clear_pending_events();
8264 assert_eq!(events_b.len(), 1);
8266 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8267 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8269 _ => panic!("Unexpected event"),
8272 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8274 let mut payment_count: u64 = 0;
8275 macro_rules! send_payment {
8276 ($node_a: expr, $node_b: expr) => {
8277 let usable_channels = $node_a.list_usable_channels();
8278 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
8279 .with_features(channelmanager::provided_invoice_features());
8280 let scorer = test_utils::TestScorer::with_penalty(0);
8281 let seed = [3u8; 32];
8282 let keys_manager = KeysManager::new(&seed, 42, 42);
8283 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8284 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8285 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8287 let mut payment_preimage = PaymentPreimage([0; 32]);
8288 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8290 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8291 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
8293 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8294 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8295 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8296 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8297 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8298 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8299 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8300 $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()));
8302 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8303 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8304 $node_b.claim_funds(payment_preimage);
8305 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8307 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8308 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8309 assert_eq!(node_id, $node_a.get_our_node_id());
8310 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8311 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8313 _ => panic!("Failed to generate claim event"),
8316 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8317 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8318 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8319 $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()));
8321 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8326 send_payment!(node_a, node_b);
8327 send_payment!(node_b, node_a);