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 [`Router`] 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 use bitcoin::blockdata::block::BlockHeader;
21 use bitcoin::blockdata::transaction::Transaction;
22 use bitcoin::blockdata::constants::genesis_block;
23 use bitcoin::network::constants::Network;
25 use bitcoin::hashes::Hash;
26 use bitcoin::hashes::sha256::Hash as Sha256;
27 use bitcoin::hash_types::{BlockHash, Txid};
29 use bitcoin::secp256k1::{SecretKey,PublicKey};
30 use bitcoin::secp256k1::Secp256k1;
31 use bitcoin::{LockTime, secp256k1, Sequence};
34 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
35 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
36 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};
37 use crate::chain::transaction::{OutPoint, TransactionData};
38 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
39 // construct one themselves.
40 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
41 use crate::ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
42 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
43 #[cfg(any(feature = "_test_utils", test))]
44 use crate::ln::features::InvoiceFeatures;
45 use crate::routing::gossip::NetworkGraph;
46 use crate::routing::router::{DefaultRouter, InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
47 use crate::routing::scoring::ProbabilisticScorer;
49 use crate::ln::onion_utils;
50 use crate::ln::onion_utils::HTLCFailReason;
51 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
53 use crate::ln::outbound_payment;
54 use crate::ln::outbound_payment::{OutboundPayments, PaymentAttempts, PendingOutboundPayment};
55 use crate::ln::wire::Encode;
56 use crate::chain::keysinterface::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, ChannelSigner, WriteableEcdsaChannelSigner};
57 use crate::util::config::{UserConfig, ChannelConfig};
58 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
59 use crate::util::events;
60 use crate::util::wakers::{Future, Notifier};
61 use crate::util::scid_utils::fake_scid;
62 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
63 use crate::util::logger::{Level, Logger};
64 use crate::util::errors::APIError;
66 use alloc::collections::BTreeMap;
69 use crate::prelude::*;
71 use core::cell::RefCell;
73 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
74 use core::sync::atomic::{AtomicUsize, Ordering};
75 use core::time::Duration;
78 // Re-export this for use in the public API.
79 pub use crate::ln::outbound_payment::{PaymentSendFailure, Retry, RetryableSendFailure};
81 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
83 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
84 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
85 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
87 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
88 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
89 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
90 // before we forward it.
92 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
93 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
94 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
95 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
96 // our payment, which we can use to decode errors or inform the user that the payment was sent.
98 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
99 pub(super) enum PendingHTLCRouting {
101 onion_packet: msgs::OnionPacket,
102 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
103 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
104 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
107 payment_data: msgs::FinalOnionHopData,
108 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
109 phantom_shared_secret: Option<[u8; 32]>,
112 payment_preimage: PaymentPreimage,
113 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
117 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
118 pub(super) struct PendingHTLCInfo {
119 pub(super) routing: PendingHTLCRouting,
120 pub(super) incoming_shared_secret: [u8; 32],
121 payment_hash: PaymentHash,
122 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
123 pub(super) outgoing_amt_msat: u64,
124 pub(super) outgoing_cltv_value: u32,
127 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
128 pub(super) enum HTLCFailureMsg {
129 Relay(msgs::UpdateFailHTLC),
130 Malformed(msgs::UpdateFailMalformedHTLC),
133 /// Stores whether we can't forward an HTLC or relevant forwarding info
134 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
135 pub(super) enum PendingHTLCStatus {
136 Forward(PendingHTLCInfo),
137 Fail(HTLCFailureMsg),
140 pub(super) struct PendingAddHTLCInfo {
141 pub(super) forward_info: PendingHTLCInfo,
143 // These fields are produced in `forward_htlcs()` and consumed in
144 // `process_pending_htlc_forwards()` for constructing the
145 // `HTLCSource::PreviousHopData` for failed and forwarded
148 // Note that this may be an outbound SCID alias for the associated channel.
149 prev_short_channel_id: u64,
151 prev_funding_outpoint: OutPoint,
152 prev_user_channel_id: u128,
155 pub(super) enum HTLCForwardInfo {
156 AddHTLC(PendingAddHTLCInfo),
159 err_packet: msgs::OnionErrorPacket,
163 /// Tracks the inbound corresponding to an outbound HTLC
164 #[derive(Clone, Hash, PartialEq, Eq)]
165 pub(crate) struct HTLCPreviousHopData {
166 // Note that this may be an outbound SCID alias for the associated channel.
167 short_channel_id: u64,
169 incoming_packet_shared_secret: [u8; 32],
170 phantom_shared_secret: Option<[u8; 32]>,
172 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
173 // channel with a preimage provided by the forward channel.
178 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
180 /// This is only here for backwards-compatibility in serialization, in the future it can be
181 /// removed, breaking clients running 0.0.106 and earlier.
182 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
184 /// Contains the payer-provided preimage.
185 Spontaneous(PaymentPreimage),
188 /// HTLCs that are to us and can be failed/claimed by the user
189 struct ClaimableHTLC {
190 prev_hop: HTLCPreviousHopData,
192 /// The amount (in msats) of this MPP part
194 onion_payload: OnionPayload,
196 /// The sum total of all MPP parts
200 /// A payment identifier used to uniquely identify a payment to LDK.
201 /// (C-not exported) as we just use [u8; 32] directly
202 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
203 pub struct PaymentId(pub [u8; 32]);
205 impl Writeable for PaymentId {
206 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
211 impl Readable for PaymentId {
212 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
213 let buf: [u8; 32] = Readable::read(r)?;
218 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
219 /// (C-not exported) as we just use [u8; 32] directly
220 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
221 pub struct InterceptId(pub [u8; 32]);
223 impl Writeable for InterceptId {
224 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
229 impl Readable for InterceptId {
230 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
231 let buf: [u8; 32] = Readable::read(r)?;
236 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
237 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
238 pub(crate) enum SentHTLCId {
239 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
240 OutboundRoute { session_priv: SecretKey },
243 pub(crate) fn from_source(source: &HTLCSource) -> Self {
245 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
246 short_channel_id: hop_data.short_channel_id,
247 htlc_id: hop_data.htlc_id,
249 HTLCSource::OutboundRoute { session_priv, .. } =>
250 Self::OutboundRoute { session_priv: *session_priv },
254 impl_writeable_tlv_based_enum!(SentHTLCId,
255 (0, PreviousHopData) => {
256 (0, short_channel_id, required),
257 (2, htlc_id, required),
259 (2, OutboundRoute) => {
260 (0, session_priv, required),
265 /// Tracks the inbound corresponding to an outbound HTLC
266 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
267 #[derive(Clone, PartialEq, Eq)]
268 pub(crate) enum HTLCSource {
269 PreviousHopData(HTLCPreviousHopData),
272 session_priv: SecretKey,
273 /// Technically we can recalculate this from the route, but we cache it here to avoid
274 /// doing a double-pass on route when we get a failure back
275 first_hop_htlc_msat: u64,
276 payment_id: PaymentId,
277 payment_secret: Option<PaymentSecret>,
280 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
281 impl core::hash::Hash for HTLCSource {
282 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
284 HTLCSource::PreviousHopData(prev_hop_data) => {
286 prev_hop_data.hash(hasher);
288 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat } => {
291 session_priv[..].hash(hasher);
292 payment_id.hash(hasher);
293 payment_secret.hash(hasher);
294 first_hop_htlc_msat.hash(hasher);
299 #[cfg(not(feature = "grind_signatures"))]
302 pub fn dummy() -> Self {
303 HTLCSource::OutboundRoute {
305 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
306 first_hop_htlc_msat: 0,
307 payment_id: PaymentId([2; 32]),
308 payment_secret: None,
313 struct ReceiveError {
319 /// This enum is used to specify which error data to send to peers when failing back an HTLC
320 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
322 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
323 #[derive(Clone, Copy)]
324 pub enum FailureCode {
325 /// We had a temporary error processing the payment. Useful if no other error codes fit
326 /// and you want to indicate that the payer may want to retry.
327 TemporaryNodeFailure = 0x2000 | 2,
328 /// We have a required feature which was not in this onion. For example, you may require
329 /// some additional metadata that was not provided with this payment.
330 RequiredNodeFeatureMissing = 0x4000 | 0x2000 | 3,
331 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
332 /// the HTLC is too close to the current block height for safe handling.
333 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
334 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
335 IncorrectOrUnknownPaymentDetails = 0x4000 | 15,
338 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
340 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
341 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
342 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
343 /// peer_state lock. We then return the set of things that need to be done outside the lock in
344 /// this struct and call handle_error!() on it.
346 struct MsgHandleErrInternal {
347 err: msgs::LightningError,
348 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
349 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
351 impl MsgHandleErrInternal {
353 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
355 err: LightningError {
357 action: msgs::ErrorAction::SendErrorMessage {
358 msg: msgs::ErrorMessage {
365 shutdown_finish: None,
369 fn from_no_close(err: msgs::LightningError) -> Self {
370 Self { err, chan_id: None, shutdown_finish: None }
373 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
375 err: LightningError {
377 action: msgs::ErrorAction::SendErrorMessage {
378 msg: msgs::ErrorMessage {
384 chan_id: Some((channel_id, user_channel_id)),
385 shutdown_finish: Some((shutdown_res, channel_update)),
389 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
392 ChannelError::Warn(msg) => LightningError {
394 action: msgs::ErrorAction::SendWarningMessage {
395 msg: msgs::WarningMessage {
399 log_level: Level::Warn,
402 ChannelError::Ignore(msg) => LightningError {
404 action: msgs::ErrorAction::IgnoreError,
406 ChannelError::Close(msg) => LightningError {
408 action: msgs::ErrorAction::SendErrorMessage {
409 msg: msgs::ErrorMessage {
417 shutdown_finish: None,
422 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
423 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
424 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
425 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
426 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
428 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
429 /// be sent in the order they appear in the return value, however sometimes the order needs to be
430 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
431 /// they were originally sent). In those cases, this enum is also returned.
432 #[derive(Clone, PartialEq)]
433 pub(super) enum RAACommitmentOrder {
434 /// Send the CommitmentUpdate messages first
436 /// Send the RevokeAndACK message first
440 /// Information about a payment which is currently being claimed.
441 struct ClaimingPayment {
443 payment_purpose: events::PaymentPurpose,
444 receiver_node_id: PublicKey,
446 impl_writeable_tlv_based!(ClaimingPayment, {
447 (0, amount_msat, required),
448 (2, payment_purpose, required),
449 (4, receiver_node_id, required),
452 /// Information about claimable or being-claimed payments
453 struct ClaimablePayments {
454 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
455 /// failed/claimed by the user.
457 /// Note that, no consistency guarantees are made about the channels given here actually
458 /// existing anymore by the time you go to read them!
460 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
461 /// we don't get a duplicate payment.
462 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
464 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
465 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
466 /// as an [`events::Event::PaymentClaimed`].
467 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
470 /// Events which we process internally but cannot be procsesed immediately at the generation site
471 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
472 /// quite some time lag.
473 enum BackgroundEvent {
474 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
475 /// commitment transaction.
476 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
480 pub(crate) enum MonitorUpdateCompletionAction {
481 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
482 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
483 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
484 /// event can be generated.
485 PaymentClaimed { payment_hash: PaymentHash },
486 /// Indicates an [`events::Event`] should be surfaced to the user.
487 EmitEvent { event: events::Event },
490 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
491 (0, PaymentClaimed) => { (0, payment_hash, required) },
492 (2, EmitEvent) => { (0, event, upgradable_required) },
495 /// State we hold per-peer.
496 pub(super) struct PeerState<Signer: ChannelSigner> {
497 /// `temporary_channel_id` or `channel_id` -> `channel`.
499 /// Holds all channels where the peer is the counterparty. Once a channel has been assigned a
500 /// `channel_id`, the `temporary_channel_id` key in the map is updated and is replaced by the
502 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
503 /// The latest `InitFeatures` we heard from the peer.
504 latest_features: InitFeatures,
505 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
506 /// for broadcast messages, where ordering isn't as strict).
507 pub(super) pending_msg_events: Vec<MessageSendEvent>,
508 /// Map from a specific channel to some action(s) that should be taken when all pending
509 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
511 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
512 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
513 /// channels with a peer this will just be one allocation and will amount to a linear list of
514 /// channels to walk, avoiding the whole hashing rigmarole.
516 /// Note that the channel may no longer exist. For example, if a channel was closed but we
517 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
518 /// for a missing channel. While a malicious peer could construct a second channel with the
519 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
520 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
521 /// duplicates do not occur, so such channels should fail without a monitor update completing.
522 monitor_update_blocked_actions: BTreeMap<[u8; 32], Vec<MonitorUpdateCompletionAction>>,
523 /// The peer is currently connected (i.e. we've seen a
524 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
525 /// [`ChannelMessageHandler::peer_disconnected`].
529 impl <Signer: ChannelSigner> PeerState<Signer> {
530 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
531 /// If true is passed for `require_disconnected`, the function will return false if we haven't
532 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
533 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
534 if require_disconnected && self.is_connected {
537 self.channel_by_id.is_empty() && self.monitor_update_blocked_actions.is_empty()
541 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
542 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
544 /// For users who don't want to bother doing their own payment preimage storage, we also store that
547 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
548 /// and instead encoding it in the payment secret.
549 struct PendingInboundPayment {
550 /// The payment secret that the sender must use for us to accept this payment
551 payment_secret: PaymentSecret,
552 /// Time at which this HTLC expires - blocks with a header time above this value will result in
553 /// this payment being removed.
555 /// Arbitrary identifier the user specifies (or not)
556 user_payment_id: u64,
557 // Other required attributes of the payment, optionally enforced:
558 payment_preimage: Option<PaymentPreimage>,
559 min_value_msat: Option<u64>,
562 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
563 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
564 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
565 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
566 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
567 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
568 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
569 /// of [`KeysManager`] and [`DefaultRouter`].
571 /// (C-not exported) as Arcs don't make sense in bindings
572 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
580 Arc<NetworkGraph<Arc<L>>>,
582 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>
587 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
588 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
589 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
590 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
591 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
592 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
593 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
594 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
595 /// of [`KeysManager`] and [`DefaultRouter`].
597 /// (C-not exported) as Arcs don't make sense in bindings
598 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'c KeysManager, &'c KeysManager, &'d F, &'e DefaultRouter<&'f NetworkGraph<&'g L>, &'g L, &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>>, &'g L>;
600 /// Manager which keeps track of a number of channels and sends messages to the appropriate
601 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
603 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
604 /// to individual Channels.
606 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
607 /// all peers during write/read (though does not modify this instance, only the instance being
608 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
609 /// called [`funding_transaction_generated`] for outbound channels) being closed.
611 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
612 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST write each monitor update out to disk before
613 /// returning from [`chain::Watch::watch_channel`]/[`update_channel`], with ChannelManagers, writing updates
614 /// happens out-of-band (and will prevent any other `ChannelManager` operations from occurring during
615 /// the serialization process). If the deserialized version is out-of-date compared to the
616 /// [`ChannelMonitor`] passed by reference to [`read`], those channels will be force-closed based on the
617 /// `ChannelMonitor` state and no funds will be lost (mod on-chain transaction fees).
619 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
620 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
621 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
623 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
624 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
625 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
626 /// offline for a full minute. In order to track this, you must call
627 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
629 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
630 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
631 /// not have a channel with being unable to connect to us or open new channels with us if we have
632 /// many peers with unfunded channels.
634 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
635 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
636 /// never limited. Please ensure you limit the count of such channels yourself.
638 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
639 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
640 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
641 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
642 /// you're using lightning-net-tokio.
644 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
645 /// [`funding_created`]: msgs::FundingCreated
646 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
647 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
648 /// [`update_channel`]: chain::Watch::update_channel
649 /// [`ChannelUpdate`]: msgs::ChannelUpdate
650 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
651 /// [`read`]: ReadableArgs::read
654 // The tree structure below illustrates the lock order requirements for the different locks of the
655 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
656 // and should then be taken in the order of the lowest to the highest level in the tree.
657 // Note that locks on different branches shall not be taken at the same time, as doing so will
658 // create a new lock order for those specific locks in the order they were taken.
662 // `total_consistency_lock`
664 // |__`forward_htlcs`
666 // | |__`pending_intercepted_htlcs`
668 // |__`per_peer_state`
670 // | |__`pending_inbound_payments`
672 // | |__`claimable_payments`
674 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
680 // | |__`short_to_chan_info`
682 // | |__`outbound_scid_aliases`
686 // | |__`pending_events`
688 // | |__`pending_background_events`
690 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
692 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
693 T::Target: BroadcasterInterface,
694 ES::Target: EntropySource,
695 NS::Target: NodeSigner,
696 SP::Target: SignerProvider,
697 F::Target: FeeEstimator,
701 default_configuration: UserConfig,
702 genesis_hash: BlockHash,
703 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 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
717 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
718 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
719 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
721 /// See `ChannelManager` struct-level documentation for lock order requirements.
722 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
724 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
725 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
726 /// (if the channel has been force-closed), however we track them here to prevent duplicative
727 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
728 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
729 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
730 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
731 /// after reloading from disk while replaying blocks against ChannelMonitors.
733 /// See `PendingOutboundPayment` documentation for more info.
735 /// See `ChannelManager` struct-level documentation for lock order requirements.
736 pending_outbound_payments: OutboundPayments,
738 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
740 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
741 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
742 /// and via the classic SCID.
744 /// Note that no consistency guarantees are made about the existence of a channel with the
745 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
747 /// See `ChannelManager` struct-level documentation for lock order requirements.
749 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
751 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
752 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
753 /// until the user tells us what we should do with them.
755 /// See `ChannelManager` struct-level documentation for lock order requirements.
756 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
758 /// The sets of payments which are claimable or currently being claimed. See
759 /// [`ClaimablePayments`]' individual field docs for more info.
761 /// See `ChannelManager` struct-level documentation for lock order requirements.
762 claimable_payments: Mutex<ClaimablePayments>,
764 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
765 /// and some closed channels which reached a usable state prior to being closed. This is used
766 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
767 /// active channel list on load.
769 /// See `ChannelManager` struct-level documentation for lock order requirements.
770 outbound_scid_aliases: Mutex<HashSet<u64>>,
772 /// `channel_id` -> `counterparty_node_id`.
774 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
775 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
776 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
778 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
779 /// the corresponding channel for the event, as we only have access to the `channel_id` during
780 /// the handling of the events.
782 /// Note that no consistency guarantees are made about the existence of a peer with the
783 /// `counterparty_node_id` in our other maps.
786 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
787 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
788 /// would break backwards compatability.
789 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
790 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
791 /// required to access the channel with the `counterparty_node_id`.
793 /// See `ChannelManager` struct-level documentation for lock order requirements.
794 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
796 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
798 /// Outbound SCID aliases are added here once the channel is available for normal use, with
799 /// SCIDs being added once the funding transaction is confirmed at the channel's required
800 /// confirmation depth.
802 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
803 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
804 /// channel with the `channel_id` in our other maps.
806 /// See `ChannelManager` struct-level documentation for lock order requirements.
808 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
810 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
812 our_network_pubkey: PublicKey,
814 inbound_payment_key: inbound_payment::ExpandedKey,
816 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
817 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
818 /// we encrypt the namespace identifier using these bytes.
820 /// [fake scids]: crate::util::scid_utils::fake_scid
821 fake_scid_rand_bytes: [u8; 32],
823 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
824 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
825 /// keeping additional state.
826 probing_cookie_secret: [u8; 32],
828 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
829 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
830 /// very far in the past, and can only ever be up to two hours in the future.
831 highest_seen_timestamp: AtomicUsize,
833 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
834 /// basis, as well as the peer's latest features.
836 /// If we are connected to a peer we always at least have an entry here, even if no channels
837 /// are currently open with that peer.
839 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
840 /// operate on the inner value freely. This opens up for parallel per-peer operation for
843 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
845 /// See `ChannelManager` struct-level documentation for lock order requirements.
846 #[cfg(not(any(test, feature = "_test_utils")))]
847 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
848 #[cfg(any(test, feature = "_test_utils"))]
849 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
851 /// See `ChannelManager` struct-level documentation for lock order requirements.
852 pending_events: Mutex<Vec<events::Event>>,
853 /// See `ChannelManager` struct-level documentation for lock order requirements.
854 pending_background_events: Mutex<Vec<BackgroundEvent>>,
855 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
856 /// Essentially just when we're serializing ourselves out.
857 /// Taken first everywhere where we are making changes before any other locks.
858 /// When acquiring this lock in read mode, rather than acquiring it directly, call
859 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
860 /// Notifier the lock contains sends out a notification when the lock is released.
861 total_consistency_lock: RwLock<()>,
863 persistence_notifier: Notifier,
872 /// Chain-related parameters used to construct a new `ChannelManager`.
874 /// Typically, the block-specific parameters are derived from the best block hash for the network,
875 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
876 /// are not needed when deserializing a previously constructed `ChannelManager`.
877 #[derive(Clone, Copy, PartialEq)]
878 pub struct ChainParameters {
879 /// The network for determining the `chain_hash` in Lightning messages.
880 pub network: Network,
882 /// The hash and height of the latest block successfully connected.
884 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
885 pub best_block: BestBlock,
888 #[derive(Copy, Clone, PartialEq)]
894 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
895 /// desirable to notify any listeners on `await_persistable_update_timeout`/
896 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
897 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
898 /// sending the aforementioned notification (since the lock being released indicates that the
899 /// updates are ready for persistence).
901 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
902 /// notify or not based on whether relevant changes have been made, providing a closure to
903 /// `optionally_notify` which returns a `NotifyOption`.
904 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
905 persistence_notifier: &'a Notifier,
907 // We hold onto this result so the lock doesn't get released immediately.
908 _read_guard: RwLockReadGuard<'a, ()>,
911 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
912 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
913 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
916 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
917 let read_guard = lock.read().unwrap();
919 PersistenceNotifierGuard {
920 persistence_notifier: notifier,
921 should_persist: persist_check,
922 _read_guard: read_guard,
927 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
929 if (self.should_persist)() == NotifyOption::DoPersist {
930 self.persistence_notifier.notify();
935 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
936 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
938 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
940 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
941 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
942 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
943 /// the maximum required amount in lnd as of March 2021.
944 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
946 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
947 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
949 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
951 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
952 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
953 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
954 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
955 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
956 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
957 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
958 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
959 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
960 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
961 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
962 // routing failure for any HTLC sender picking up an LDK node among the first hops.
963 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
965 /// Minimum CLTV difference between the current block height and received inbound payments.
966 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
968 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
969 // any payments to succeed. Further, we don't want payments to fail if a block was found while
970 // a payment was being routed, so we add an extra block to be safe.
971 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
973 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
974 // ie that if the next-hop peer fails the HTLC within
975 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
976 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
977 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
978 // LATENCY_GRACE_PERIOD_BLOCKS.
981 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;
983 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
984 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
987 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
989 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
990 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
992 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
993 /// idempotency of payments by [`PaymentId`]. See
994 /// [`OutboundPayments::remove_stale_resolved_payments`].
995 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
997 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
998 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
999 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1000 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1002 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1003 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1004 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1006 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1007 /// many peers we reject new (inbound) connections.
1008 const MAX_NO_CHANNEL_PEERS: usize = 250;
1010 /// Information needed for constructing an invoice route hint for this channel.
1011 #[derive(Clone, Debug, PartialEq)]
1012 pub struct CounterpartyForwardingInfo {
1013 /// Base routing fee in millisatoshis.
1014 pub fee_base_msat: u32,
1015 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1016 pub fee_proportional_millionths: u32,
1017 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1018 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1019 /// `cltv_expiry_delta` for more details.
1020 pub cltv_expiry_delta: u16,
1023 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1024 /// to better separate parameters.
1025 #[derive(Clone, Debug, PartialEq)]
1026 pub struct ChannelCounterparty {
1027 /// The node_id of our counterparty
1028 pub node_id: PublicKey,
1029 /// The Features the channel counterparty provided upon last connection.
1030 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1031 /// many routing-relevant features are present in the init context.
1032 pub features: InitFeatures,
1033 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1034 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1035 /// claiming at least this value on chain.
1037 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1039 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1040 pub unspendable_punishment_reserve: u64,
1041 /// Information on the fees and requirements that the counterparty requires when forwarding
1042 /// payments to us through this channel.
1043 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1044 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1045 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1046 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1047 pub outbound_htlc_minimum_msat: Option<u64>,
1048 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1049 pub outbound_htlc_maximum_msat: Option<u64>,
1052 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1053 #[derive(Clone, Debug, PartialEq)]
1054 pub struct ChannelDetails {
1055 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1056 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1057 /// Note that this means this value is *not* persistent - it can change once during the
1058 /// lifetime of the channel.
1059 pub channel_id: [u8; 32],
1060 /// Parameters which apply to our counterparty. See individual fields for more information.
1061 pub counterparty: ChannelCounterparty,
1062 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1063 /// our counterparty already.
1065 /// Note that, if this has been set, `channel_id` will be equivalent to
1066 /// `funding_txo.unwrap().to_channel_id()`.
1067 pub funding_txo: Option<OutPoint>,
1068 /// The features which this channel operates with. See individual features for more info.
1070 /// `None` until negotiation completes and the channel type is finalized.
1071 pub channel_type: Option<ChannelTypeFeatures>,
1072 /// The position of the funding transaction in the chain. None if the funding transaction has
1073 /// not yet been confirmed and the channel fully opened.
1075 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1076 /// payments instead of this. See [`get_inbound_payment_scid`].
1078 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1079 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1081 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1082 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1083 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1084 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1085 /// [`confirmations_required`]: Self::confirmations_required
1086 pub short_channel_id: Option<u64>,
1087 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1088 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1089 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1092 /// This will be `None` as long as the channel is not available for routing outbound payments.
1094 /// [`short_channel_id`]: Self::short_channel_id
1095 /// [`confirmations_required`]: Self::confirmations_required
1096 pub outbound_scid_alias: Option<u64>,
1097 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1098 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1099 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1100 /// when they see a payment to be routed to us.
1102 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1103 /// previous values for inbound payment forwarding.
1105 /// [`short_channel_id`]: Self::short_channel_id
1106 pub inbound_scid_alias: Option<u64>,
1107 /// The value, in satoshis, of this channel as appears in the funding output
1108 pub channel_value_satoshis: u64,
1109 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1110 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1111 /// this value on chain.
1113 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1115 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1117 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1118 pub unspendable_punishment_reserve: Option<u64>,
1119 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1120 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1122 pub user_channel_id: u128,
1123 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1124 /// which is applied to commitment and HTLC transactions.
1126 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1127 pub feerate_sat_per_1000_weight: Option<u32>,
1128 /// Our total balance. This is the amount we would get if we close the channel.
1129 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1130 /// amount is not likely to be recoverable on close.
1132 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1133 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1134 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1135 /// This does not consider any on-chain fees.
1137 /// See also [`ChannelDetails::outbound_capacity_msat`]
1138 pub balance_msat: u64,
1139 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1140 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1141 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1142 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1144 /// See also [`ChannelDetails::balance_msat`]
1146 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1147 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1148 /// should be able to spend nearly this amount.
1149 pub outbound_capacity_msat: u64,
1150 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1151 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1152 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1153 /// to use a limit as close as possible to the HTLC limit we can currently send.
1155 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1156 pub next_outbound_htlc_limit_msat: u64,
1157 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1158 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1159 /// available for inclusion in new inbound HTLCs).
1160 /// Note that there are some corner cases not fully handled here, so the actual available
1161 /// inbound capacity may be slightly higher than this.
1163 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1164 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1165 /// However, our counterparty should be able to spend nearly this amount.
1166 pub inbound_capacity_msat: u64,
1167 /// The number of required confirmations on the funding transaction before the funding will be
1168 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1169 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1170 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1171 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1173 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1175 /// [`is_outbound`]: ChannelDetails::is_outbound
1176 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1177 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1178 pub confirmations_required: Option<u32>,
1179 /// The current number of confirmations on the funding transaction.
1181 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1182 pub confirmations: Option<u32>,
1183 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1184 /// until we can claim our funds after we force-close the channel. During this time our
1185 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1186 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1187 /// time to claim our non-HTLC-encumbered funds.
1189 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1190 pub force_close_spend_delay: Option<u16>,
1191 /// True if the channel was initiated (and thus funded) by us.
1192 pub is_outbound: bool,
1193 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1194 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1195 /// required confirmation count has been reached (and we were connected to the peer at some
1196 /// point after the funding transaction received enough confirmations). The required
1197 /// confirmation count is provided in [`confirmations_required`].
1199 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1200 pub is_channel_ready: bool,
1201 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1202 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1204 /// This is a strict superset of `is_channel_ready`.
1205 pub is_usable: bool,
1206 /// True if this channel is (or will be) publicly-announced.
1207 pub is_public: bool,
1208 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1209 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1210 pub inbound_htlc_minimum_msat: Option<u64>,
1211 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1212 pub inbound_htlc_maximum_msat: Option<u64>,
1213 /// Set of configurable parameters that affect channel operation.
1215 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1216 pub config: Option<ChannelConfig>,
1219 impl ChannelDetails {
1220 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1221 /// This should be used for providing invoice hints or in any other context where our
1222 /// counterparty will forward a payment to us.
1224 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1225 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1226 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1227 self.inbound_scid_alias.or(self.short_channel_id)
1230 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1231 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1232 /// we're sending or forwarding a payment outbound over this channel.
1234 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1235 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1236 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1237 self.short_channel_id.or(self.outbound_scid_alias)
1240 fn from_channel<Signer: WriteableEcdsaChannelSigner>(channel: &Channel<Signer>,
1241 best_block_height: u32, latest_features: InitFeatures) -> Self {
1243 let balance = channel.get_available_balances();
1244 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1245 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1247 channel_id: channel.channel_id(),
1248 counterparty: ChannelCounterparty {
1249 node_id: channel.get_counterparty_node_id(),
1250 features: latest_features,
1251 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1252 forwarding_info: channel.counterparty_forwarding_info(),
1253 // Ensures that we have actually received the `htlc_minimum_msat` value
1254 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1255 // message (as they are always the first message from the counterparty).
1256 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1257 // default `0` value set by `Channel::new_outbound`.
1258 outbound_htlc_minimum_msat: if channel.have_received_message() {
1259 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1260 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1262 funding_txo: channel.get_funding_txo(),
1263 // Note that accept_channel (or open_channel) is always the first message, so
1264 // `have_received_message` indicates that type negotiation has completed.
1265 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1266 short_channel_id: channel.get_short_channel_id(),
1267 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1268 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1269 channel_value_satoshis: channel.get_value_satoshis(),
1270 feerate_sat_per_1000_weight: Some(channel.get_feerate_sat_per_1000_weight()),
1271 unspendable_punishment_reserve: to_self_reserve_satoshis,
1272 balance_msat: balance.balance_msat,
1273 inbound_capacity_msat: balance.inbound_capacity_msat,
1274 outbound_capacity_msat: balance.outbound_capacity_msat,
1275 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1276 user_channel_id: channel.get_user_id(),
1277 confirmations_required: channel.minimum_depth(),
1278 confirmations: Some(channel.get_funding_tx_confirmations(best_block_height)),
1279 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1280 is_outbound: channel.is_outbound(),
1281 is_channel_ready: channel.is_usable(),
1282 is_usable: channel.is_live(),
1283 is_public: channel.should_announce(),
1284 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1285 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1286 config: Some(channel.config()),
1291 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1292 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1293 #[derive(Debug, PartialEq)]
1294 pub enum RecentPaymentDetails {
1295 /// When a payment is still being sent and awaiting successful delivery.
1297 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1299 payment_hash: PaymentHash,
1300 /// Total amount (in msat, excluding fees) across all paths for this payment,
1301 /// not just the amount currently inflight.
1304 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1305 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1306 /// payment is removed from tracking.
1308 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1309 /// made before LDK version 0.0.104.
1310 payment_hash: Option<PaymentHash>,
1312 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1313 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1314 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1316 /// Hash of the payment that we have given up trying to send.
1317 payment_hash: PaymentHash,
1321 /// Route hints used in constructing invoices for [phantom node payents].
1323 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1325 pub struct PhantomRouteHints {
1326 /// The list of channels to be included in the invoice route hints.
1327 pub channels: Vec<ChannelDetails>,
1328 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1330 pub phantom_scid: u64,
1331 /// The pubkey of the real backing node that would ultimately receive the payment.
1332 pub real_node_pubkey: PublicKey,
1335 macro_rules! handle_error {
1336 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1339 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1340 // In testing, ensure there are no deadlocks where the lock is already held upon
1341 // entering the macro.
1342 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1343 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1345 let mut msg_events = Vec::with_capacity(2);
1347 if let Some((shutdown_res, update_option)) = shutdown_finish {
1348 $self.finish_force_close_channel(shutdown_res);
1349 if let Some(update) = update_option {
1350 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1354 if let Some((channel_id, user_channel_id)) = chan_id {
1355 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1356 channel_id, user_channel_id,
1357 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1362 log_error!($self.logger, "{}", err.err);
1363 if let msgs::ErrorAction::IgnoreError = err.action {
1365 msg_events.push(events::MessageSendEvent::HandleError {
1366 node_id: $counterparty_node_id,
1367 action: err.action.clone()
1371 if !msg_events.is_empty() {
1372 let per_peer_state = $self.per_peer_state.read().unwrap();
1373 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1374 let mut peer_state = peer_state_mutex.lock().unwrap();
1375 peer_state.pending_msg_events.append(&mut msg_events);
1379 // Return error in case higher-API need one
1386 macro_rules! update_maps_on_chan_removal {
1387 ($self: expr, $channel: expr) => {{
1388 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1389 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1390 if let Some(short_id) = $channel.get_short_channel_id() {
1391 short_to_chan_info.remove(&short_id);
1393 // If the channel was never confirmed on-chain prior to its closure, remove the
1394 // outbound SCID alias we used for it from the collision-prevention set. While we
1395 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1396 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1397 // opening a million channels with us which are closed before we ever reach the funding
1399 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1400 debug_assert!(alias_removed);
1402 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1406 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1407 macro_rules! convert_chan_err {
1408 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1410 ChannelError::Warn(msg) => {
1411 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1413 ChannelError::Ignore(msg) => {
1414 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1416 ChannelError::Close(msg) => {
1417 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1418 update_maps_on_chan_removal!($self, $channel);
1419 let shutdown_res = $channel.force_shutdown(true);
1420 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1421 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1427 macro_rules! break_chan_entry {
1428 ($self: ident, $res: expr, $entry: expr) => {
1432 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1434 $entry.remove_entry();
1442 macro_rules! try_chan_entry {
1443 ($self: ident, $res: expr, $entry: expr) => {
1447 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1449 $entry.remove_entry();
1457 macro_rules! remove_channel {
1458 ($self: expr, $entry: expr) => {
1460 let channel = $entry.remove_entry().1;
1461 update_maps_on_chan_removal!($self, channel);
1467 macro_rules! send_channel_ready {
1468 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1469 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1470 node_id: $channel.get_counterparty_node_id(),
1471 msg: $channel_ready_msg,
1473 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1474 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1475 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1476 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1477 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1478 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1479 if let Some(real_scid) = $channel.get_short_channel_id() {
1480 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1481 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1482 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1487 macro_rules! emit_channel_ready_event {
1488 ($self: expr, $channel: expr) => {
1489 if $channel.should_emit_channel_ready_event() {
1491 let mut pending_events = $self.pending_events.lock().unwrap();
1492 pending_events.push(events::Event::ChannelReady {
1493 channel_id: $channel.channel_id(),
1494 user_channel_id: $channel.get_user_id(),
1495 counterparty_node_id: $channel.get_counterparty_node_id(),
1496 channel_type: $channel.get_channel_type().clone(),
1499 $channel.set_channel_ready_event_emitted();
1504 macro_rules! handle_monitor_update_completion {
1505 ($self: ident, $update_id: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
1506 let mut updates = $chan.monitor_updating_restored(&$self.logger,
1507 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
1508 $self.best_block.read().unwrap().height());
1509 let counterparty_node_id = $chan.get_counterparty_node_id();
1510 let channel_update = if updates.channel_ready.is_some() && $chan.is_usable() {
1511 // We only send a channel_update in the case where we are just now sending a
1512 // channel_ready and the channel is in a usable state. We may re-send a
1513 // channel_update later through the announcement_signatures process for public
1514 // channels, but there's no reason not to just inform our counterparty of our fees
1516 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
1517 Some(events::MessageSendEvent::SendChannelUpdate {
1518 node_id: counterparty_node_id,
1524 let update_actions = $peer_state.monitor_update_blocked_actions
1525 .remove(&$chan.channel_id()).unwrap_or(Vec::new());
1527 let htlc_forwards = $self.handle_channel_resumption(
1528 &mut $peer_state.pending_msg_events, $chan, updates.raa,
1529 updates.commitment_update, updates.order, updates.accepted_htlcs,
1530 updates.funding_broadcastable, updates.channel_ready,
1531 updates.announcement_sigs);
1532 if let Some(upd) = channel_update {
1533 $peer_state.pending_msg_events.push(upd);
1536 let channel_id = $chan.channel_id();
1537 core::mem::drop($peer_state_lock);
1538 core::mem::drop($per_peer_state_lock);
1540 $self.handle_monitor_update_completion_actions(update_actions);
1542 if let Some(forwards) = htlc_forwards {
1543 $self.forward_htlcs(&mut [forwards][..]);
1545 $self.finalize_claims(updates.finalized_claimed_htlcs);
1546 for failure in updates.failed_htlcs.drain(..) {
1547 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1548 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
1553 macro_rules! handle_new_monitor_update {
1554 ($self: ident, $update_res: expr, $update_id: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, MANUALLY_REMOVING, $remove: expr) => { {
1555 // update_maps_on_chan_removal needs to be able to take id_to_peer, so make sure we can in
1556 // any case so that it won't deadlock.
1557 debug_assert!($self.id_to_peer.try_lock().is_ok());
1559 ChannelMonitorUpdateStatus::InProgress => {
1560 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
1561 log_bytes!($chan.channel_id()[..]));
1564 ChannelMonitorUpdateStatus::PermanentFailure => {
1565 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure",
1566 log_bytes!($chan.channel_id()[..]));
1567 update_maps_on_chan_removal!($self, $chan);
1568 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown(
1569 "ChannelMonitor storage failure".to_owned(), $chan.channel_id(),
1570 $chan.get_user_id(), $chan.force_shutdown(false),
1571 $self.get_channel_update_for_broadcast(&$chan).ok()));
1575 ChannelMonitorUpdateStatus::Completed => {
1576 if ($update_id == 0 || $chan.get_next_monitor_update()
1577 .expect("We can't be processing a monitor update if it isn't queued")
1578 .update_id == $update_id) &&
1579 $chan.get_latest_monitor_update_id() == $update_id
1581 handle_monitor_update_completion!($self, $update_id, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
1587 ($self: ident, $update_res: expr, $update_id: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr) => {
1588 handle_new_monitor_update!($self, $update_res, $update_id, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan_entry.get_mut(), MANUALLY_REMOVING, $chan_entry.remove_entry())
1592 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, ES, NS, SP, F, R, L>
1594 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
1595 T::Target: BroadcasterInterface,
1596 ES::Target: EntropySource,
1597 NS::Target: NodeSigner,
1598 SP::Target: SignerProvider,
1599 F::Target: FeeEstimator,
1603 /// Constructs a new `ChannelManager` to hold several channels and route between them.
1605 /// This is the main "logic hub" for all channel-related actions, and implements
1606 /// [`ChannelMessageHandler`].
1608 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1610 /// Users need to notify the new `ChannelManager` when a new block is connected or
1611 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
1612 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
1615 /// [`block_connected`]: chain::Listen::block_connected
1616 /// [`block_disconnected`]: chain::Listen::block_disconnected
1617 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
1618 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES, node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters) -> Self {
1619 let mut secp_ctx = Secp256k1::new();
1620 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
1621 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
1622 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1624 default_configuration: config.clone(),
1625 genesis_hash: genesis_block(params.network).header.block_hash(),
1626 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1631 best_block: RwLock::new(params.best_block),
1633 outbound_scid_aliases: Mutex::new(HashSet::new()),
1634 pending_inbound_payments: Mutex::new(HashMap::new()),
1635 pending_outbound_payments: OutboundPayments::new(),
1636 forward_htlcs: Mutex::new(HashMap::new()),
1637 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs: HashMap::new(), pending_claiming_payments: HashMap::new() }),
1638 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
1639 id_to_peer: Mutex::new(HashMap::new()),
1640 short_to_chan_info: FairRwLock::new(HashMap::new()),
1642 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
1645 inbound_payment_key: expanded_inbound_key,
1646 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
1648 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
1650 highest_seen_timestamp: AtomicUsize::new(0),
1652 per_peer_state: FairRwLock::new(HashMap::new()),
1654 pending_events: Mutex::new(Vec::new()),
1655 pending_background_events: Mutex::new(Vec::new()),
1656 total_consistency_lock: RwLock::new(()),
1657 persistence_notifier: Notifier::new(),
1667 /// Gets the current configuration applied to all new channels.
1668 pub fn get_current_default_configuration(&self) -> &UserConfig {
1669 &self.default_configuration
1672 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1673 let height = self.best_block.read().unwrap().height();
1674 let mut outbound_scid_alias = 0;
1677 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1678 outbound_scid_alias += 1;
1680 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
1682 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1686 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"); }
1691 /// Creates a new outbound channel to the given remote node and with the given value.
1693 /// `user_channel_id` will be provided back as in
1694 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1695 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1696 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1697 /// is simply copied to events and otherwise ignored.
1699 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1700 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1702 /// Note that we do not check if you are currently connected to the given peer. If no
1703 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1704 /// the channel eventually being silently forgotten (dropped on reload).
1706 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1707 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1708 /// [`ChannelDetails::channel_id`] until after
1709 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1710 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1711 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1713 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1714 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1715 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1716 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> {
1717 if channel_value_satoshis < 1000 {
1718 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1721 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1722 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1723 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1725 let per_peer_state = self.per_peer_state.read().unwrap();
1727 let peer_state_mutex = per_peer_state.get(&their_network_key)
1728 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
1730 let mut peer_state = peer_state_mutex.lock().unwrap();
1732 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1733 let their_features = &peer_state.latest_features;
1734 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1735 match Channel::new_outbound(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
1736 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1737 self.best_block.read().unwrap().height(), outbound_scid_alias)
1741 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1746 let res = channel.get_open_channel(self.genesis_hash.clone());
1748 let temporary_channel_id = channel.channel_id();
1749 match peer_state.channel_by_id.entry(temporary_channel_id) {
1750 hash_map::Entry::Occupied(_) => {
1752 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1754 panic!("RNG is bad???");
1757 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1760 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1761 node_id: their_network_key,
1764 Ok(temporary_channel_id)
1767 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<SP::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
1768 // Allocate our best estimate of the number of channels we have in the `res`
1769 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
1770 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
1771 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
1772 // unlikely as the `short_to_chan_info` map often contains 2 entries for
1773 // the same channel.
1774 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
1776 let best_block_height = self.best_block.read().unwrap().height();
1777 let per_peer_state = self.per_peer_state.read().unwrap();
1778 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
1779 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1780 let peer_state = &mut *peer_state_lock;
1781 for (_channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
1782 let details = ChannelDetails::from_channel(channel, best_block_height,
1783 peer_state.latest_features.clone());
1791 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
1792 /// more information.
1793 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1794 self.list_channels_with_filter(|_| true)
1797 /// Gets the list of usable channels, in random order. Useful as an argument to
1798 /// [`Router::find_route`] to ensure non-announced channels are used.
1800 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1801 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1803 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1804 // Note we use is_live here instead of usable which leads to somewhat confused
1805 // internal/external nomenclature, but that's ok cause that's probably what the user
1806 // really wanted anyway.
1807 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1810 /// Gets the list of channels we have with a given counterparty, in random order.
1811 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
1812 let best_block_height = self.best_block.read().unwrap().height();
1813 let per_peer_state = self.per_peer_state.read().unwrap();
1815 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
1816 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1817 let peer_state = &mut *peer_state_lock;
1818 let features = &peer_state.latest_features;
1819 return peer_state.channel_by_id
1822 ChannelDetails::from_channel(channel, best_block_height, features.clone()))
1828 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
1829 /// successful path, or have unresolved HTLCs.
1831 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
1832 /// result of a crash. If such a payment exists, is not listed here, and an
1833 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
1835 /// [`Event::PaymentSent`]: events::Event::PaymentSent
1836 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
1837 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
1838 .filter_map(|(_, pending_outbound_payment)| match pending_outbound_payment {
1839 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
1840 Some(RecentPaymentDetails::Pending {
1841 payment_hash: *payment_hash,
1842 total_msat: *total_msat,
1845 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
1846 Some(RecentPaymentDetails::Abandoned { payment_hash: *payment_hash })
1848 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
1849 Some(RecentPaymentDetails::Fulfilled { payment_hash: *payment_hash })
1851 PendingOutboundPayment::Legacy { .. } => None
1856 /// Helper function that issues the channel close events
1857 fn issue_channel_close_events(&self, channel: &Channel<<SP::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
1858 let mut pending_events_lock = self.pending_events.lock().unwrap();
1859 match channel.unbroadcasted_funding() {
1860 Some(transaction) => {
1861 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1865 pending_events_lock.push(events::Event::ChannelClosed {
1866 channel_id: channel.channel_id(),
1867 user_channel_id: channel.get_user_id(),
1868 reason: closure_reason
1872 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1873 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1875 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1876 let result: Result<(), _> = loop {
1877 let per_peer_state = self.per_peer_state.read().unwrap();
1879 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
1880 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
1882 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1883 let peer_state = &mut *peer_state_lock;
1884 match peer_state.channel_by_id.entry(channel_id.clone()) {
1885 hash_map::Entry::Occupied(mut chan_entry) => {
1886 let funding_txo_opt = chan_entry.get().get_funding_txo();
1887 let their_features = &peer_state.latest_features;
1888 let (shutdown_msg, mut monitor_update_opt, htlcs) = chan_entry.get_mut()
1889 .get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight)?;
1890 failed_htlcs = htlcs;
1892 // We can send the `shutdown` message before updating the `ChannelMonitor`
1893 // here as we don't need the monitor update to complete until we send a
1894 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
1895 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1896 node_id: *counterparty_node_id,
1900 // Update the monitor with the shutdown script if necessary.
1901 if let Some(monitor_update) = monitor_update_opt.take() {
1902 let update_id = monitor_update.update_id;
1903 let update_res = self.chain_monitor.update_channel(funding_txo_opt.unwrap(), monitor_update);
1904 break handle_new_monitor_update!(self, update_res, update_id, peer_state_lock, peer_state, per_peer_state, chan_entry);
1907 if chan_entry.get().is_shutdown() {
1908 let channel = remove_channel!(self, chan_entry);
1909 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1910 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1914 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1918 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), counterparty_node_id) })
1922 for htlc_source in failed_htlcs.drain(..) {
1923 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1924 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1925 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
1928 let _ = handle_error!(self, result, *counterparty_node_id);
1932 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1933 /// will be accepted on the given channel, and after additional timeout/the closing of all
1934 /// pending HTLCs, the channel will be closed on chain.
1936 /// * If we are the channel initiator, we will pay between our [`Background`] and
1937 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1939 /// * If our counterparty is the channel initiator, we will require a channel closing
1940 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1941 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1942 /// counterparty to pay as much fee as they'd like, however.
1944 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
1946 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1947 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1948 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1949 /// [`SendShutdown`]: crate::util::events::MessageSendEvent::SendShutdown
1950 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1951 self.close_channel_internal(channel_id, counterparty_node_id, None)
1954 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1955 /// will be accepted on the given channel, and after additional timeout/the closing of all
1956 /// pending HTLCs, the channel will be closed on chain.
1958 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1959 /// the channel being closed or not:
1960 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1961 /// transaction. The upper-bound is set by
1962 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1963 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1964 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1965 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1966 /// will appear on a force-closure transaction, whichever is lower).
1968 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
1970 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1971 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1972 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1973 /// [`SendShutdown`]: crate::util::events::MessageSendEvent::SendShutdown
1974 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> {
1975 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1979 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1980 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1981 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1982 for htlc_source in failed_htlcs.drain(..) {
1983 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1984 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1985 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1986 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
1988 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1989 // There isn't anything we can do if we get an update failure - we're already
1990 // force-closing. The monitor update on the required in-memory copy should broadcast
1991 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1992 // ignore the result here.
1993 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
1997 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1998 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1999 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2000 -> Result<PublicKey, APIError> {
2001 let per_peer_state = self.per_peer_state.read().unwrap();
2002 let peer_state_mutex = per_peer_state.get(peer_node_id)
2003 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2005 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2006 let peer_state = &mut *peer_state_lock;
2007 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
2008 if let Some(peer_msg) = peer_msg {
2009 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
2011 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
2013 remove_channel!(self, chan)
2015 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), peer_node_id) });
2018 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2019 self.finish_force_close_channel(chan.force_shutdown(broadcast));
2020 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2021 let mut peer_state = peer_state_mutex.lock().unwrap();
2022 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2027 Ok(chan.get_counterparty_node_id())
2030 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2031 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2032 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2033 Ok(counterparty_node_id) => {
2034 let per_peer_state = self.per_peer_state.read().unwrap();
2035 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2036 let mut peer_state = peer_state_mutex.lock().unwrap();
2037 peer_state.pending_msg_events.push(
2038 events::MessageSendEvent::HandleError {
2039 node_id: counterparty_node_id,
2040 action: msgs::ErrorAction::SendErrorMessage {
2041 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2052 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2053 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2054 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2056 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2057 -> Result<(), APIError> {
2058 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2061 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2062 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2063 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2065 /// You can always get the latest local transaction(s) to broadcast from
2066 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2067 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2068 -> Result<(), APIError> {
2069 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2072 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2073 /// for each to the chain and rejecting new HTLCs on each.
2074 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2075 for chan in self.list_channels() {
2076 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2080 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2081 /// local transaction(s).
2082 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2083 for chan in self.list_channels() {
2084 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2088 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2089 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2091 // final_incorrect_cltv_expiry
2092 if hop_data.outgoing_cltv_value != cltv_expiry {
2093 return Err(ReceiveError {
2094 msg: "Upstream node set CLTV to the wrong value",
2096 err_data: cltv_expiry.to_be_bytes().to_vec()
2099 // final_expiry_too_soon
2100 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2101 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2103 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2104 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2105 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2106 let current_height: u32 = self.best_block.read().unwrap().height();
2107 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2108 let mut err_data = Vec::with_capacity(12);
2109 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2110 err_data.extend_from_slice(¤t_height.to_be_bytes());
2111 return Err(ReceiveError {
2112 err_code: 0x4000 | 15, err_data,
2113 msg: "The final CLTV expiry is too soon to handle",
2116 if hop_data.amt_to_forward > amt_msat {
2117 return Err(ReceiveError {
2119 err_data: amt_msat.to_be_bytes().to_vec(),
2120 msg: "Upstream node sent less than we were supposed to receive in payment",
2124 let routing = match hop_data.format {
2125 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2126 return Err(ReceiveError {
2127 err_code: 0x4000|22,
2128 err_data: Vec::new(),
2129 msg: "Got non final data with an HMAC of 0",
2132 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2133 if payment_data.is_some() && keysend_preimage.is_some() {
2134 return Err(ReceiveError {
2135 err_code: 0x4000|22,
2136 err_data: Vec::new(),
2137 msg: "We don't support MPP keysend payments",
2139 } else if let Some(data) = payment_data {
2140 PendingHTLCRouting::Receive {
2142 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2143 phantom_shared_secret,
2145 } else if let Some(payment_preimage) = keysend_preimage {
2146 // We need to check that the sender knows the keysend preimage before processing this
2147 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2148 // could discover the final destination of X, by probing the adjacent nodes on the route
2149 // with a keysend payment of identical payment hash to X and observing the processing
2150 // time discrepancies due to a hash collision with X.
2151 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2152 if hashed_preimage != payment_hash {
2153 return Err(ReceiveError {
2154 err_code: 0x4000|22,
2155 err_data: Vec::new(),
2156 msg: "Payment preimage didn't match payment hash",
2160 PendingHTLCRouting::ReceiveKeysend {
2162 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2165 return Err(ReceiveError {
2166 err_code: 0x4000|0x2000|3,
2167 err_data: Vec::new(),
2168 msg: "We require payment_secrets",
2173 Ok(PendingHTLCInfo {
2176 incoming_shared_secret: shared_secret,
2177 incoming_amt_msat: Some(amt_msat),
2178 outgoing_amt_msat: amt_msat,
2179 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2183 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
2184 macro_rules! return_malformed_err {
2185 ($msg: expr, $err_code: expr) => {
2187 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2188 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2189 channel_id: msg.channel_id,
2190 htlc_id: msg.htlc_id,
2191 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2192 failure_code: $err_code,
2198 if let Err(_) = msg.onion_routing_packet.public_key {
2199 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2202 let shared_secret = self.node_signer.ecdh(
2203 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2204 ).unwrap().secret_bytes();
2206 if msg.onion_routing_packet.version != 0 {
2207 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2208 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2209 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2210 //receiving node would have to brute force to figure out which version was put in the
2211 //packet by the node that send us the message, in the case of hashing the hop_data, the
2212 //node knows the HMAC matched, so they already know what is there...
2213 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2215 macro_rules! return_err {
2216 ($msg: expr, $err_code: expr, $data: expr) => {
2218 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2219 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2220 channel_id: msg.channel_id,
2221 htlc_id: msg.htlc_id,
2222 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2223 .get_encrypted_failure_packet(&shared_secret, &None),
2229 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) {
2231 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2232 return_malformed_err!(err_msg, err_code);
2234 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2235 return_err!(err_msg, err_code, &[0; 0]);
2239 let pending_forward_info = match next_hop {
2240 onion_utils::Hop::Receive(next_hop_data) => {
2242 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2244 // Note that we could obviously respond immediately with an update_fulfill_htlc
2245 // message, however that would leak that we are the recipient of this payment, so
2246 // instead we stay symmetric with the forwarding case, only responding (after a
2247 // delay) once they've send us a commitment_signed!
2248 PendingHTLCStatus::Forward(info)
2250 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2253 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2254 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2255 let outgoing_packet = msgs::OnionPacket {
2257 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2258 hop_data: new_packet_bytes,
2259 hmac: next_hop_hmac.clone(),
2262 let short_channel_id = match next_hop_data.format {
2263 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2264 msgs::OnionHopDataFormat::FinalNode { .. } => {
2265 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2269 PendingHTLCStatus::Forward(PendingHTLCInfo {
2270 routing: PendingHTLCRouting::Forward {
2271 onion_packet: outgoing_packet,
2274 payment_hash: msg.payment_hash.clone(),
2275 incoming_shared_secret: shared_secret,
2276 incoming_amt_msat: Some(msg.amount_msat),
2277 outgoing_amt_msat: next_hop_data.amt_to_forward,
2278 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2283 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2284 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2285 // with a short_channel_id of 0. This is important as various things later assume
2286 // short_channel_id is non-0 in any ::Forward.
2287 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2288 if let Some((err, mut code, chan_update)) = loop {
2289 let id_option = self.short_to_chan_info.read().unwrap().get(short_channel_id).cloned();
2290 let forwarding_chan_info_opt = match id_option {
2291 None => { // unknown_next_peer
2292 // Note that this is likely a timing oracle for detecting whether an scid is a
2293 // phantom or an intercept.
2294 if (self.default_configuration.accept_intercept_htlcs &&
2295 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)) ||
2296 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)
2300 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2303 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2305 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2306 let per_peer_state = self.per_peer_state.read().unwrap();
2307 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2308 if peer_state_mutex_opt.is_none() {
2309 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2311 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2312 let peer_state = &mut *peer_state_lock;
2313 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2315 // Channel was removed. The short_to_chan_info and channel_by_id maps
2316 // have no consistency guarantees.
2317 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2321 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2322 // Note that the behavior here should be identical to the above block - we
2323 // should NOT reveal the existence or non-existence of a private channel if
2324 // we don't allow forwards outbound over them.
2325 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2327 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2328 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2329 // "refuse to forward unless the SCID alias was used", so we pretend
2330 // we don't have the channel here.
2331 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2333 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2335 // Note that we could technically not return an error yet here and just hope
2336 // that the connection is reestablished or monitor updated by the time we get
2337 // around to doing the actual forward, but better to fail early if we can and
2338 // hopefully an attacker trying to path-trace payments cannot make this occur
2339 // on a small/per-node/per-channel scale.
2340 if !chan.is_live() { // channel_disabled
2341 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2343 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2344 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2346 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2347 break Some((err, code, chan_update_opt));
2351 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2352 // We really should set `incorrect_cltv_expiry` here but as we're not
2353 // forwarding over a real channel we can't generate a channel_update
2354 // for it. Instead we just return a generic temporary_node_failure.
2356 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2363 let cur_height = self.best_block.read().unwrap().height() + 1;
2364 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2365 // but we want to be robust wrt to counterparty packet sanitization (see
2366 // HTLC_FAIL_BACK_BUFFER rationale).
2367 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2368 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2370 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2371 break Some(("CLTV expiry is too far in the future", 21, None));
2373 // If the HTLC expires ~now, don't bother trying to forward it to our
2374 // counterparty. They should fail it anyway, but we don't want to bother with
2375 // the round-trips or risk them deciding they definitely want the HTLC and
2376 // force-closing to ensure they get it if we're offline.
2377 // We previously had a much more aggressive check here which tried to ensure
2378 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2379 // but there is no need to do that, and since we're a bit conservative with our
2380 // risk threshold it just results in failing to forward payments.
2381 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2382 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2388 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2389 if let Some(chan_update) = chan_update {
2390 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2391 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2393 else if code == 0x1000 | 13 {
2394 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2396 else if code == 0x1000 | 20 {
2397 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2398 0u16.write(&mut res).expect("Writes cannot fail");
2400 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2401 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2402 chan_update.write(&mut res).expect("Writes cannot fail");
2403 } else if code & 0x1000 == 0x1000 {
2404 // If we're trying to return an error that requires a `channel_update` but
2405 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2406 // generate an update), just use the generic "temporary_node_failure"
2410 return_err!(err, code, &res.0[..]);
2415 pending_forward_info
2418 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
2419 /// public, and thus should be called whenever the result is going to be passed out in a
2420 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2422 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
2423 /// corresponding to the channel's counterparty locked, as the channel been removed from the
2424 /// storage and the `peer_state` lock has been dropped.
2426 /// [`channel_update`]: msgs::ChannelUpdate
2427 /// [`internal_closing_signed`]: Self::internal_closing_signed
2428 fn get_channel_update_for_broadcast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2429 if !chan.should_announce() {
2430 return Err(LightningError {
2431 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2432 action: msgs::ErrorAction::IgnoreError
2435 if chan.get_short_channel_id().is_none() {
2436 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2438 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2439 self.get_channel_update_for_unicast(chan)
2442 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
2443 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
2444 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2445 /// provided evidence that they know about the existence of the channel.
2447 /// Note that through [`internal_closing_signed`], this function is called without the
2448 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
2449 /// removed from the storage and the `peer_state` lock has been dropped.
2451 /// [`channel_update`]: msgs::ChannelUpdate
2452 /// [`internal_closing_signed`]: Self::internal_closing_signed
2453 fn get_channel_update_for_unicast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2454 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2455 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2456 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2460 self.get_channel_update_for_onion(short_channel_id, chan)
2462 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2463 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2464 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2466 let unsigned = msgs::UnsignedChannelUpdate {
2467 chain_hash: self.genesis_hash,
2469 timestamp: chan.get_update_time_counter(),
2470 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2471 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2472 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2473 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2474 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2475 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2476 excess_data: Vec::new(),
2478 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
2479 // If we returned an error and the `node_signer` cannot provide a signature for whatever
2480 // reason`, we wouldn't be able to receive inbound payments through the corresponding
2482 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
2484 Ok(msgs::ChannelUpdate {
2491 pub(crate) fn test_send_payment_along_path(&self, path: &Vec<RouteHop>, 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> {
2492 let _lck = self.total_consistency_lock.read().unwrap();
2493 self.send_payment_along_path(path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv_bytes)
2496 fn send_payment_along_path(&self, path: &Vec<RouteHop>, 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> {
2497 // The top-level caller should hold the total_consistency_lock read lock.
2498 debug_assert!(self.total_consistency_lock.try_write().is_err());
2500 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2501 let prng_seed = self.entropy_source.get_secure_random_bytes();
2502 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2504 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2505 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
2506 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2507 if onion_utils::route_size_insane(&onion_payloads) {
2508 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data".to_owned()});
2510 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2512 let err: Result<(), _> = loop {
2513 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2514 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2515 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2518 let per_peer_state = self.per_peer_state.read().unwrap();
2519 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
2520 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
2521 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2522 let peer_state = &mut *peer_state_lock;
2523 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
2524 if !chan.get().is_live() {
2525 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
2527 let funding_txo = chan.get().get_funding_txo().unwrap();
2528 let send_res = chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(),
2529 htlc_cltv, HTLCSource::OutboundRoute {
2531 session_priv: session_priv.clone(),
2532 first_hop_htlc_msat: htlc_msat,
2534 payment_secret: payment_secret.clone(),
2535 }, onion_packet, &self.logger);
2536 match break_chan_entry!(self, send_res, chan) {
2537 Some(monitor_update) => {
2538 let update_id = monitor_update.update_id;
2539 let update_res = self.chain_monitor.update_channel(funding_txo, monitor_update);
2540 if let Err(e) = handle_new_monitor_update!(self, update_res, update_id, peer_state_lock, peer_state, per_peer_state, chan) {
2543 if update_res == ChannelMonitorUpdateStatus::InProgress {
2544 // Note that MonitorUpdateInProgress here indicates (per function
2545 // docs) that we will resend the commitment update once monitor
2546 // updating completes. Therefore, we must return an error
2547 // indicating that it is unsafe to retry the payment wholesale,
2548 // which we do in the send_payment check for
2549 // MonitorUpdateInProgress, below.
2550 return Err(APIError::MonitorUpdateInProgress);
2556 // The channel was likely removed after we fetched the id from the
2557 // `short_to_chan_info` map, but before we successfully locked the
2558 // `channel_by_id` map.
2559 // This can occur as no consistency guarantees exists between the two maps.
2560 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2565 match handle_error!(self, err, path.first().unwrap().pubkey) {
2566 Ok(_) => unreachable!(),
2568 Err(APIError::ChannelUnavailable { err: e.err })
2573 /// Sends a payment along a given route.
2575 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
2576 /// fields for more info.
2578 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
2579 /// [`PeerManager::process_events`]).
2581 /// # Avoiding Duplicate Payments
2583 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2584 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
2585 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2586 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
2587 /// second payment with the same [`PaymentId`].
2589 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2590 /// tracking of payments, including state to indicate once a payment has completed. Because you
2591 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2592 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2593 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2595 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
2596 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
2597 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
2598 /// [`ChannelManager::list_recent_payments`] for more information.
2600 /// # Possible Error States on [`PaymentSendFailure`]
2602 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
2603 /// each entry matching the corresponding-index entry in the route paths, see
2604 /// [`PaymentSendFailure`] for more info.
2606 /// In general, a path may raise:
2607 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
2608 /// node public key) is specified.
2609 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2610 /// (including due to previous monitor update failure or new permanent monitor update
2612 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2613 /// relevant updates.
2615 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
2616 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2617 /// different route unless you intend to pay twice!
2619 /// # A caution on `payment_secret`
2621 /// `payment_secret` is unrelated to `payment_hash` (or [`PaymentPreimage`]) and exists to
2622 /// authenticate the sender to the recipient and prevent payment-probing (deanonymization)
2623 /// attacks. For newer nodes, it will be provided to you in the invoice. If you do not have one,
2624 /// the [`Route`] must not contain multiple paths as multi-path payments require a
2625 /// recipient-provided `payment_secret`.
2627 /// If a `payment_secret` *is* provided, we assume that the invoice had the payment_secret
2628 /// feature bit set (either as required or as available). If multiple paths are present in the
2629 /// [`Route`], we assume the invoice had the basic_mpp feature set.
2631 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2632 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2633 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
2634 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2635 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
2636 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2637 let best_block_height = self.best_block.read().unwrap().height();
2638 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2639 self.pending_outbound_payments
2640 .send_payment_with_route(route, payment_hash, payment_secret, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
2641 |path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2642 self.send_payment_along_path(path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2645 /// Similar to [`ChannelManager::send_payment`], but will automatically find a route based on
2646 /// `route_params` and retry failed payment paths based on `retry_strategy`.
2647 pub fn send_payment_with_retry(&self, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
2648 let best_block_height = self.best_block.read().unwrap().height();
2649 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2650 self.pending_outbound_payments
2651 .send_payment(payment_hash, payment_secret, payment_id, retry_strategy, route_params,
2652 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
2653 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
2654 &self.pending_events,
2655 |path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2656 self.send_payment_along_path(path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2660 fn test_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> {
2661 let best_block_height = self.best_block.read().unwrap().height();
2662 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2663 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer, best_block_height,
2664 |path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2665 self.send_payment_along_path(path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2669 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> {
2670 let best_block_height = self.best_block.read().unwrap().height();
2671 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, payment_secret, payment_id, route, None, &self.entropy_source, best_block_height)
2675 /// Signals that no further retries for the given payment should occur. Useful if you have a
2676 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
2677 /// retries are exhausted.
2679 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
2680 /// as there are no remaining pending HTLCs for this payment.
2682 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2683 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2684 /// determine the ultimate status of a payment.
2686 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
2687 /// [`ChannelManager`] having been persisted, another [`Event::PaymentFailed`] may be generated.
2689 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2690 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2691 pub fn abandon_payment(&self, payment_id: PaymentId) {
2692 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2693 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
2696 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2697 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2698 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2699 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2700 /// never reach the recipient.
2702 /// See [`send_payment`] documentation for more details on the return value of this function
2703 /// and idempotency guarantees provided by the [`PaymentId`] key.
2705 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2706 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2708 /// Note that `route` must have exactly one path.
2710 /// [`send_payment`]: Self::send_payment
2711 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2712 let best_block_height = self.best_block.read().unwrap().height();
2713 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2714 self.pending_outbound_payments.send_spontaneous_payment_with_route(
2715 route, payment_preimage, payment_id, &self.entropy_source, &self.node_signer,
2717 |path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2718 self.send_payment_along_path(path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2721 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
2722 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
2724 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
2727 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
2728 pub fn send_spontaneous_payment_with_retry(&self, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<PaymentHash, RetryableSendFailure> {
2729 let best_block_height = self.best_block.read().unwrap().height();
2730 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2731 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, payment_id,
2732 retry_strategy, route_params, &self.router, self.list_usable_channels(),
2733 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
2734 &self.logger, &self.pending_events,
2735 |path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2736 self.send_payment_along_path(path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2739 /// Send a payment that is probing the given route for liquidity. We calculate the
2740 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2741 /// us to easily discern them from real payments.
2742 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2743 let best_block_height = self.best_block.read().unwrap().height();
2744 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2745 self.pending_outbound_payments.send_probe(hops, self.probing_cookie_secret, &self.entropy_source, &self.node_signer, best_block_height,
2746 |path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2747 self.send_payment_along_path(path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2750 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2753 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2754 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
2757 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2758 /// which checks the correctness of the funding transaction given the associated channel.
2759 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<SP::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2760 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2761 ) -> Result<(), APIError> {
2762 let per_peer_state = self.per_peer_state.read().unwrap();
2763 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2764 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2766 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2767 let peer_state = &mut *peer_state_lock;
2770 match peer_state.channel_by_id.remove(temporary_channel_id) {
2772 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2774 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2775 .map_err(|e| if let ChannelError::Close(msg) = e {
2776 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2777 } else { unreachable!(); })
2780 None => { return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) }) },
2783 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2784 Ok(funding_msg) => {
2787 Err(_) => { return Err(APIError::ChannelUnavailable {
2788 err: "Signer refused to sign the initial commitment transaction".to_owned()
2793 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2794 node_id: chan.get_counterparty_node_id(),
2797 match peer_state.channel_by_id.entry(chan.channel_id()) {
2798 hash_map::Entry::Occupied(_) => {
2799 panic!("Generated duplicate funding txid?");
2801 hash_map::Entry::Vacant(e) => {
2802 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2803 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2804 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2813 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> {
2814 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2815 Ok(OutPoint { txid: tx.txid(), index: output_index })
2819 /// Call this upon creation of a funding transaction for the given channel.
2821 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2822 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2824 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2825 /// across the p2p network.
2827 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2828 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2830 /// May panic if the output found in the funding transaction is duplicative with some other
2831 /// channel (note that this should be trivially prevented by using unique funding transaction
2832 /// keys per-channel).
2834 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2835 /// counterparty's signature the funding transaction will automatically be broadcast via the
2836 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2838 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2839 /// not currently support replacing a funding transaction on an existing channel. Instead,
2840 /// create a new channel with a conflicting funding transaction.
2842 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2843 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2844 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2845 /// for more details.
2847 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2848 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2849 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2850 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2852 for inp in funding_transaction.input.iter() {
2853 if inp.witness.is_empty() {
2854 return Err(APIError::APIMisuseError {
2855 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2860 let height = self.best_block.read().unwrap().height();
2861 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2862 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2863 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2864 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 {
2865 return Err(APIError::APIMisuseError {
2866 err: "Funding transaction absolute timelock is non-final".to_owned()
2870 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2871 let mut output_index = None;
2872 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2873 for (idx, outp) in tx.output.iter().enumerate() {
2874 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2875 if output_index.is_some() {
2876 return Err(APIError::APIMisuseError {
2877 err: "Multiple outputs matched the expected script and value".to_owned()
2880 if idx > u16::max_value() as usize {
2881 return Err(APIError::APIMisuseError {
2882 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2885 output_index = Some(idx as u16);
2888 if output_index.is_none() {
2889 return Err(APIError::APIMisuseError {
2890 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2893 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2897 /// Atomically updates the [`ChannelConfig`] for the given channels.
2899 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2900 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2901 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2902 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2904 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2905 /// `counterparty_node_id` is provided.
2907 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2908 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2910 /// If an error is returned, none of the updates should be considered applied.
2912 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2913 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2914 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2915 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2916 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2917 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2918 /// [`APIMisuseError`]: APIError::APIMisuseError
2919 pub fn update_channel_config(
2920 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
2921 ) -> Result<(), APIError> {
2922 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
2923 return Err(APIError::APIMisuseError {
2924 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
2928 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
2929 &self.total_consistency_lock, &self.persistence_notifier,
2931 let per_peer_state = self.per_peer_state.read().unwrap();
2932 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2933 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2934 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2935 let peer_state = &mut *peer_state_lock;
2936 for channel_id in channel_ids {
2937 if !peer_state.channel_by_id.contains_key(channel_id) {
2938 return Err(APIError::ChannelUnavailable {
2939 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", log_bytes!(*channel_id), counterparty_node_id),
2943 for channel_id in channel_ids {
2944 let channel = peer_state.channel_by_id.get_mut(channel_id).unwrap();
2945 if !channel.update_config(config) {
2948 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
2949 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
2950 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
2951 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
2952 node_id: channel.get_counterparty_node_id(),
2960 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
2961 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
2963 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
2964 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
2966 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
2967 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
2968 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
2969 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
2970 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
2972 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
2973 /// you from forwarding more than you received.
2975 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2978 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
2979 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2980 // TODO: when we move to deciding the best outbound channel at forward time, only take
2981 // `next_node_id` and not `next_hop_channel_id`
2982 pub fn forward_intercepted_htlc(&self, intercept_id: InterceptId, next_hop_channel_id: &[u8; 32], next_node_id: PublicKey, amt_to_forward_msat: u64) -> Result<(), APIError> {
2983 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2985 let next_hop_scid = {
2986 let peer_state_lock = self.per_peer_state.read().unwrap();
2987 let peer_state_mutex = peer_state_lock.get(&next_node_id)
2988 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
2989 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2990 let peer_state = &mut *peer_state_lock;
2991 match peer_state.channel_by_id.get(next_hop_channel_id) {
2993 if !chan.is_usable() {
2994 return Err(APIError::ChannelUnavailable {
2995 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
2998 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
3000 None => return Err(APIError::ChannelUnavailable {
3001 err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*next_hop_channel_id), next_node_id)
3006 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3007 .ok_or_else(|| APIError::APIMisuseError {
3008 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3011 let routing = match payment.forward_info.routing {
3012 PendingHTLCRouting::Forward { onion_packet, .. } => {
3013 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3015 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3017 let pending_htlc_info = PendingHTLCInfo {
3018 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3021 let mut per_source_pending_forward = [(
3022 payment.prev_short_channel_id,
3023 payment.prev_funding_outpoint,
3024 payment.prev_user_channel_id,
3025 vec![(pending_htlc_info, payment.prev_htlc_id)]
3027 self.forward_htlcs(&mut per_source_pending_forward);
3031 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3032 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3034 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3037 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3038 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3039 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3041 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3042 .ok_or_else(|| APIError::APIMisuseError {
3043 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3046 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3047 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3048 short_channel_id: payment.prev_short_channel_id,
3049 outpoint: payment.prev_funding_outpoint,
3050 htlc_id: payment.prev_htlc_id,
3051 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3052 phantom_shared_secret: None,
3055 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3056 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3057 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3058 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3063 /// Processes HTLCs which are pending waiting on random forward delay.
3065 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3066 /// Will likely generate further events.
3067 pub fn process_pending_htlc_forwards(&self) {
3068 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3070 let mut new_events = Vec::new();
3071 let mut failed_forwards = Vec::new();
3072 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3074 let mut forward_htlcs = HashMap::new();
3075 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3077 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3078 if short_chan_id != 0 {
3079 macro_rules! forwarding_channel_not_found {
3081 for forward_info in pending_forwards.drain(..) {
3082 match forward_info {
3083 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3084 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3085 forward_info: PendingHTLCInfo {
3086 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3087 outgoing_cltv_value, incoming_amt_msat: _
3090 macro_rules! failure_handler {
3091 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3092 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3094 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3095 short_channel_id: prev_short_channel_id,
3096 outpoint: prev_funding_outpoint,
3097 htlc_id: prev_htlc_id,
3098 incoming_packet_shared_secret: incoming_shared_secret,
3099 phantom_shared_secret: $phantom_ss,
3102 let reason = if $next_hop_unknown {
3103 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3105 HTLCDestination::FailedPayment{ payment_hash }
3108 failed_forwards.push((htlc_source, payment_hash,
3109 HTLCFailReason::reason($err_code, $err_data),
3115 macro_rules! fail_forward {
3116 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3118 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3122 macro_rules! failed_payment {
3123 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3125 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3129 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3130 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3131 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3132 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3133 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3135 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3136 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3137 // In this scenario, the phantom would have sent us an
3138 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3139 // if it came from us (the second-to-last hop) but contains the sha256
3141 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3143 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3144 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3148 onion_utils::Hop::Receive(hop_data) => {
3149 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
3150 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3151 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3157 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3160 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3163 HTLCForwardInfo::FailHTLC { .. } => {
3164 // Channel went away before we could fail it. This implies
3165 // the channel is now on chain and our counterparty is
3166 // trying to broadcast the HTLC-Timeout, but that's their
3167 // problem, not ours.
3173 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3174 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3176 forwarding_channel_not_found!();
3180 let per_peer_state = self.per_peer_state.read().unwrap();
3181 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3182 if peer_state_mutex_opt.is_none() {
3183 forwarding_channel_not_found!();
3186 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3187 let peer_state = &mut *peer_state_lock;
3188 match peer_state.channel_by_id.entry(forward_chan_id) {
3189 hash_map::Entry::Vacant(_) => {
3190 forwarding_channel_not_found!();
3193 hash_map::Entry::Occupied(mut chan) => {
3194 for forward_info in pending_forwards.drain(..) {
3195 match forward_info {
3196 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3197 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
3198 forward_info: PendingHTLCInfo {
3199 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3200 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
3203 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);
3204 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3205 short_channel_id: prev_short_channel_id,
3206 outpoint: prev_funding_outpoint,
3207 htlc_id: prev_htlc_id,
3208 incoming_packet_shared_secret: incoming_shared_secret,
3209 // Phantom payments are only PendingHTLCRouting::Receive.
3210 phantom_shared_secret: None,
3212 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3213 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3214 onion_packet, &self.logger)
3216 if let ChannelError::Ignore(msg) = e {
3217 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3219 panic!("Stated return value requirements in send_htlc() were not met");
3221 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3222 failed_forwards.push((htlc_source, payment_hash,
3223 HTLCFailReason::reason(failure_code, data),
3224 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3229 HTLCForwardInfo::AddHTLC { .. } => {
3230 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3232 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3233 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3234 if let Err(e) = chan.get_mut().queue_fail_htlc(
3235 htlc_id, err_packet, &self.logger
3237 if let ChannelError::Ignore(msg) = e {
3238 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3240 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3242 // fail-backs are best-effort, we probably already have one
3243 // pending, and if not that's OK, if not, the channel is on
3244 // the chain and sending the HTLC-Timeout is their problem.
3253 for forward_info in pending_forwards.drain(..) {
3254 match forward_info {
3255 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3256 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3257 forward_info: PendingHTLCInfo {
3258 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3261 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3262 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3263 let _legacy_hop_data = Some(payment_data.clone());
3264 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3266 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3267 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3269 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3272 let claimable_htlc = ClaimableHTLC {
3273 prev_hop: HTLCPreviousHopData {
3274 short_channel_id: prev_short_channel_id,
3275 outpoint: prev_funding_outpoint,
3276 htlc_id: prev_htlc_id,
3277 incoming_packet_shared_secret: incoming_shared_secret,
3278 phantom_shared_secret,
3280 value: outgoing_amt_msat,
3282 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3287 macro_rules! fail_htlc {
3288 ($htlc: expr, $payment_hash: expr) => {
3289 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3290 htlc_msat_height_data.extend_from_slice(
3291 &self.best_block.read().unwrap().height().to_be_bytes(),
3293 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3294 short_channel_id: $htlc.prev_hop.short_channel_id,
3295 outpoint: prev_funding_outpoint,
3296 htlc_id: $htlc.prev_hop.htlc_id,
3297 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3298 phantom_shared_secret,
3300 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3301 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3305 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3306 let mut receiver_node_id = self.our_network_pubkey;
3307 if phantom_shared_secret.is_some() {
3308 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
3309 .expect("Failed to get node_id for phantom node recipient");
3312 macro_rules! check_total_value {
3313 ($payment_data: expr, $payment_preimage: expr) => {{
3314 let mut payment_claimable_generated = false;
3316 events::PaymentPurpose::InvoicePayment {
3317 payment_preimage: $payment_preimage,
3318 payment_secret: $payment_data.payment_secret,
3321 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3322 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3323 fail_htlc!(claimable_htlc, payment_hash);
3326 let (_, htlcs) = claimable_payments.claimable_htlcs.entry(payment_hash)
3327 .or_insert_with(|| (purpose(), Vec::new()));
3328 if htlcs.len() == 1 {
3329 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3330 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));
3331 fail_htlc!(claimable_htlc, payment_hash);
3335 let mut total_value = claimable_htlc.value;
3336 for htlc in htlcs.iter() {
3337 total_value += htlc.value;
3338 match &htlc.onion_payload {
3339 OnionPayload::Invoice { .. } => {
3340 if htlc.total_msat != $payment_data.total_msat {
3341 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3342 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3343 total_value = msgs::MAX_VALUE_MSAT;
3345 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3347 _ => unreachable!(),
3350 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3351 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3352 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3353 fail_htlc!(claimable_htlc, payment_hash);
3354 } else if total_value == $payment_data.total_msat {
3355 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3356 htlcs.push(claimable_htlc);
3357 new_events.push(events::Event::PaymentClaimable {
3358 receiver_node_id: Some(receiver_node_id),
3361 amount_msat: total_value,
3362 via_channel_id: Some(prev_channel_id),
3363 via_user_channel_id: Some(prev_user_channel_id),
3365 payment_claimable_generated = true;
3367 // Nothing to do - we haven't reached the total
3368 // payment value yet, wait until we receive more
3370 htlcs.push(claimable_htlc);
3372 payment_claimable_generated
3376 // Check that the payment hash and secret are known. Note that we
3377 // MUST take care to handle the "unknown payment hash" and
3378 // "incorrect payment secret" cases here identically or we'd expose
3379 // that we are the ultimate recipient of the given payment hash.
3380 // Further, we must not expose whether we have any other HTLCs
3381 // associated with the same payment_hash pending or not.
3382 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3383 match payment_secrets.entry(payment_hash) {
3384 hash_map::Entry::Vacant(_) => {
3385 match claimable_htlc.onion_payload {
3386 OnionPayload::Invoice { .. } => {
3387 let payment_data = payment_data.unwrap();
3388 let (payment_preimage, min_final_cltv_expiry_delta) = match inbound_payment::verify(payment_hash, &payment_data, self.highest_seen_timestamp.load(Ordering::Acquire) as u64, &self.inbound_payment_key, &self.logger) {
3389 Ok(result) => result,
3391 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", log_bytes!(payment_hash.0));
3392 fail_htlc!(claimable_htlc, payment_hash);
3396 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
3397 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
3398 if (cltv_expiry as u64) < expected_min_expiry_height {
3399 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
3400 log_bytes!(payment_hash.0), cltv_expiry, expected_min_expiry_height);
3401 fail_htlc!(claimable_htlc, payment_hash);
3405 check_total_value!(payment_data, payment_preimage);
3407 OnionPayload::Spontaneous(preimage) => {
3408 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3409 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3410 fail_htlc!(claimable_htlc, payment_hash);
3413 match claimable_payments.claimable_htlcs.entry(payment_hash) {
3414 hash_map::Entry::Vacant(e) => {
3415 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3416 e.insert((purpose.clone(), vec![claimable_htlc]));
3417 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3418 new_events.push(events::Event::PaymentClaimable {
3419 receiver_node_id: Some(receiver_node_id),
3421 amount_msat: outgoing_amt_msat,
3423 via_channel_id: Some(prev_channel_id),
3424 via_user_channel_id: Some(prev_user_channel_id),
3427 hash_map::Entry::Occupied(_) => {
3428 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3429 fail_htlc!(claimable_htlc, payment_hash);
3435 hash_map::Entry::Occupied(inbound_payment) => {
3436 if payment_data.is_none() {
3437 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));
3438 fail_htlc!(claimable_htlc, payment_hash);
3441 let payment_data = payment_data.unwrap();
3442 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3443 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3444 fail_htlc!(claimable_htlc, payment_hash);
3445 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3446 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3447 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3448 fail_htlc!(claimable_htlc, payment_hash);
3450 let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3451 if payment_claimable_generated {
3452 inbound_payment.remove_entry();
3458 HTLCForwardInfo::FailHTLC { .. } => {
3459 panic!("Got pending fail of our own HTLC");
3467 let best_block_height = self.best_block.read().unwrap().height();
3468 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
3469 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3470 &self.pending_events, &self.logger,
3471 |path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3472 self.send_payment_along_path(path, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv));
3474 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3475 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
3477 self.forward_htlcs(&mut phantom_receives);
3479 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
3480 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
3481 // nice to do the work now if we can rather than while we're trying to get messages in the
3483 self.check_free_holding_cells();
3485 if new_events.is_empty() { return }
3486 let mut events = self.pending_events.lock().unwrap();
3487 events.append(&mut new_events);
3490 /// Free the background events, generally called from timer_tick_occurred.
3492 /// Exposed for testing to allow us to process events quickly without generating accidental
3493 /// BroadcastChannelUpdate events in timer_tick_occurred.
3495 /// Expects the caller to have a total_consistency_lock read lock.
3496 fn process_background_events(&self) -> bool {
3497 let mut background_events = Vec::new();
3498 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3499 if background_events.is_empty() {
3503 for event in background_events.drain(..) {
3505 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3506 // The channel has already been closed, so no use bothering to care about the
3507 // monitor updating completing.
3508 let _ = self.chain_monitor.update_channel(funding_txo, &update);
3515 #[cfg(any(test, feature = "_test_utils"))]
3516 /// Process background events, for functional testing
3517 pub fn test_process_background_events(&self) {
3518 self.process_background_events();
3521 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<SP::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
3522 if !chan.is_outbound() { return NotifyOption::SkipPersist; }
3523 // If the feerate has decreased by less than half, don't bother
3524 if new_feerate <= chan.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.get_feerate_sat_per_1000_weight() {
3525 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3526 log_bytes!(chan_id[..]), chan.get_feerate_sat_per_1000_weight(), new_feerate);
3527 return NotifyOption::SkipPersist;
3529 if !chan.is_live() {
3530 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).",
3531 log_bytes!(chan_id[..]), chan.get_feerate_sat_per_1000_weight(), new_feerate);
3532 return NotifyOption::SkipPersist;
3534 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3535 log_bytes!(chan_id[..]), chan.get_feerate_sat_per_1000_weight(), new_feerate);
3537 chan.queue_update_fee(new_feerate, &self.logger);
3538 NotifyOption::DoPersist
3542 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3543 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3544 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3545 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3546 pub fn maybe_update_chan_fees(&self) {
3547 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3548 let mut should_persist = NotifyOption::SkipPersist;
3550 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3552 let per_peer_state = self.per_peer_state.read().unwrap();
3553 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
3554 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3555 let peer_state = &mut *peer_state_lock;
3556 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
3557 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3558 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3566 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3568 /// This currently includes:
3569 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3570 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
3571 /// than a minute, informing the network that they should no longer attempt to route over
3573 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
3574 /// with the current [`ChannelConfig`].
3575 /// * Removing peers which have disconnected but and no longer have any channels.
3577 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
3578 /// estimate fetches.
3580 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3581 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
3582 pub fn timer_tick_occurred(&self) {
3583 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3584 let mut should_persist = NotifyOption::SkipPersist;
3585 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3587 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3589 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
3590 let mut timed_out_mpp_htlcs = Vec::new();
3591 let mut pending_peers_awaiting_removal = Vec::new();
3593 let per_peer_state = self.per_peer_state.read().unwrap();
3594 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
3595 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3596 let peer_state = &mut *peer_state_lock;
3597 let pending_msg_events = &mut peer_state.pending_msg_events;
3598 let counterparty_node_id = *counterparty_node_id;
3599 peer_state.channel_by_id.retain(|chan_id, chan| {
3600 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3601 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3603 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3604 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3605 handle_errors.push((Err(err), counterparty_node_id));
3606 if needs_close { return false; }
3609 match chan.channel_update_status() {
3610 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3611 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3612 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3613 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3614 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3615 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3616 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3620 should_persist = NotifyOption::DoPersist;
3621 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3623 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3624 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3625 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3629 should_persist = NotifyOption::DoPersist;
3630 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3635 chan.maybe_expire_prev_config();
3639 if peer_state.ok_to_remove(true) {
3640 pending_peers_awaiting_removal.push(counterparty_node_id);
3645 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
3646 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
3647 // of to that peer is later closed while still being disconnected (i.e. force closed),
3648 // we therefore need to remove the peer from `peer_state` separately.
3649 // To avoid having to take the `per_peer_state` `write` lock once the channels are
3650 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
3651 // negative effects on parallelism as much as possible.
3652 if pending_peers_awaiting_removal.len() > 0 {
3653 let mut per_peer_state = self.per_peer_state.write().unwrap();
3654 for counterparty_node_id in pending_peers_awaiting_removal {
3655 match per_peer_state.entry(counterparty_node_id) {
3656 hash_map::Entry::Occupied(entry) => {
3657 // Remove the entry if the peer is still disconnected and we still
3658 // have no channels to the peer.
3659 let remove_entry = {
3660 let peer_state = entry.get().lock().unwrap();
3661 peer_state.ok_to_remove(true)
3664 entry.remove_entry();
3667 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
3672 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3673 if htlcs.is_empty() {
3674 // This should be unreachable
3675 debug_assert!(false);
3678 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3679 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3680 // In this case we're not going to handle any timeouts of the parts here.
3681 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3683 } else if htlcs.into_iter().any(|htlc| {
3684 htlc.timer_ticks += 1;
3685 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3687 timed_out_mpp_htlcs.extend(htlcs.drain(..).map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
3694 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3695 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
3696 let reason = HTLCFailReason::from_failure_code(23);
3697 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3698 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
3701 for (err, counterparty_node_id) in handle_errors.drain(..) {
3702 let _ = handle_error!(self, err, counterparty_node_id);
3705 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
3707 // Technically we don't need to do this here, but if we have holding cell entries in a
3708 // channel that need freeing, it's better to do that here and block a background task
3709 // than block the message queueing pipeline.
3710 if self.check_free_holding_cells() {
3711 should_persist = NotifyOption::DoPersist;
3718 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3719 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
3720 /// along the path (including in our own channel on which we received it).
3722 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3723 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3724 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
3725 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3727 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3728 /// [`ChannelManager::claim_funds`]), you should still monitor for
3729 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3730 /// startup during which time claims that were in-progress at shutdown may be replayed.
3731 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3732 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
3735 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
3736 /// reason for the failure.
3738 /// See [`FailureCode`] for valid failure codes.
3739 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
3740 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3742 let removed_source = self.claimable_payments.lock().unwrap().claimable_htlcs.remove(payment_hash);
3743 if let Some((_, mut sources)) = removed_source {
3744 for htlc in sources.drain(..) {
3745 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
3746 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3747 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
3748 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3753 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
3754 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
3755 match failure_code {
3756 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code as u16),
3757 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code as u16),
3758 FailureCode::IncorrectOrUnknownPaymentDetails => {
3759 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3760 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3761 HTLCFailReason::reason(failure_code as u16, htlc_msat_height_data)
3766 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3767 /// that we want to return and a channel.
3769 /// This is for failures on the channel on which the HTLC was *received*, not failures
3771 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3772 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3773 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3774 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3775 // an inbound SCID alias before the real SCID.
3776 let scid_pref = if chan.should_announce() {
3777 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3779 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3781 if let Some(scid) = scid_pref {
3782 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3784 (0x4000|10, Vec::new())
3789 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3790 /// that we want to return and a channel.
3791 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3792 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3793 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3794 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3795 if desired_err_code == 0x1000 | 20 {
3796 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3797 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3798 0u16.write(&mut enc).expect("Writes cannot fail");
3800 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3801 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3802 upd.write(&mut enc).expect("Writes cannot fail");
3803 (desired_err_code, enc.0)
3805 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3806 // which means we really shouldn't have gotten a payment to be forwarded over this
3807 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3808 // PERM|no_such_channel should be fine.
3809 (0x4000|10, Vec::new())
3813 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3814 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3815 // be surfaced to the user.
3816 fn fail_holding_cell_htlcs(
3817 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3818 counterparty_node_id: &PublicKey
3820 let (failure_code, onion_failure_data) = {
3821 let per_peer_state = self.per_peer_state.read().unwrap();
3822 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
3823 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3824 let peer_state = &mut *peer_state_lock;
3825 match peer_state.channel_by_id.entry(channel_id) {
3826 hash_map::Entry::Occupied(chan_entry) => {
3827 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3829 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3831 } else { (0x4000|10, Vec::new()) }
3834 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3835 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
3836 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3837 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
3841 /// Fails an HTLC backwards to the sender of it to us.
3842 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3843 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
3844 // Ensure that no peer state channel storage lock is held when calling this function.
3845 // This ensures that future code doesn't introduce a lock-order requirement for
3846 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
3847 // this function with any `per_peer_state` peer lock acquired would.
3848 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
3849 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
3852 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3853 //identify whether we sent it or not based on the (I presume) very different runtime
3854 //between the branches here. We should make this async and move it into the forward HTLCs
3857 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3858 // from block_connected which may run during initialization prior to the chain_monitor
3859 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3861 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
3862 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
3863 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
3864 &self.pending_events, &self.logger)
3865 { self.push_pending_forwards_ev(); }
3867 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
3868 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
3869 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
3871 let mut push_forward_ev = false;
3872 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
3873 if forward_htlcs.is_empty() {
3874 push_forward_ev = true;
3876 match forward_htlcs.entry(*short_channel_id) {
3877 hash_map::Entry::Occupied(mut entry) => {
3878 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
3880 hash_map::Entry::Vacant(entry) => {
3881 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
3884 mem::drop(forward_htlcs);
3885 if push_forward_ev { self.push_pending_forwards_ev(); }
3886 let mut pending_events = self.pending_events.lock().unwrap();
3887 pending_events.push(events::Event::HTLCHandlingFailed {
3888 prev_channel_id: outpoint.to_channel_id(),
3889 failed_next_destination: destination,
3895 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
3896 /// [`MessageSendEvent`]s needed to claim the payment.
3898 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3899 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3900 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3902 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3903 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
3904 /// event matches your expectation. If you fail to do so and call this method, you may provide
3905 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3907 /// [`Event::PaymentClaimable`]: crate::util::events::Event::PaymentClaimable
3908 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3909 /// [`process_pending_events`]: EventsProvider::process_pending_events
3910 /// [`create_inbound_payment`]: Self::create_inbound_payment
3911 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3912 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3913 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3915 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3918 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3919 if let Some((payment_purpose, sources)) = claimable_payments.claimable_htlcs.remove(&payment_hash) {
3920 let mut receiver_node_id = self.our_network_pubkey;
3921 for htlc in sources.iter() {
3922 if htlc.prev_hop.phantom_shared_secret.is_some() {
3923 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
3924 .expect("Failed to get node_id for phantom node recipient");
3925 receiver_node_id = phantom_pubkey;
3930 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
3931 ClaimingPayment { amount_msat: sources.iter().map(|source| source.value).sum(),
3932 payment_purpose, receiver_node_id,
3934 if dup_purpose.is_some() {
3935 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
3936 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
3937 log_bytes!(payment_hash.0));
3942 debug_assert!(!sources.is_empty());
3944 // If we are claiming an MPP payment, we check that all channels which contain a claimable
3945 // HTLC still exist. While this isn't guaranteed to remain true if a channel closes while
3946 // we're claiming (or even after we claim, before the commitment update dance completes),
3947 // it should be a relatively rare race, and we'd rather not claim HTLCs that require us to
3948 // go on-chain (and lose the on-chain fee to do so) than just reject the payment.
3950 // Note that we'll still always get our funds - as long as the generated
3951 // `ChannelMonitorUpdate` makes it out to the relevant monitor we can claim on-chain.
3953 // If we find an HTLC which we would need to claim but for which we do not have a
3954 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3955 // the sender retries the already-failed path(s), it should be a pretty rare case where
3956 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3957 // provide the preimage, so worrying too much about the optimal handling isn't worth
3959 let mut claimable_amt_msat = 0;
3960 let mut expected_amt_msat = None;
3961 let mut valid_mpp = true;
3962 let mut errs = Vec::new();
3963 let per_peer_state = self.per_peer_state.read().unwrap();
3964 for htlc in sources.iter() {
3965 let (counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
3966 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3973 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3974 if peer_state_mutex_opt.is_none() {
3979 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3980 let peer_state = &mut *peer_state_lock;
3982 if peer_state.channel_by_id.get(&chan_id).is_none() {
3987 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3988 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3989 debug_assert!(false);
3994 expected_amt_msat = Some(htlc.total_msat);
3995 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3996 // We don't currently support MPP for spontaneous payments, so just check
3997 // that there's one payment here and move on.
3998 if sources.len() != 1 {
3999 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
4000 debug_assert!(false);
4006 claimable_amt_msat += htlc.value;
4008 mem::drop(per_peer_state);
4009 if sources.is_empty() || expected_amt_msat.is_none() {
4010 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4011 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4014 if claimable_amt_msat != expected_amt_msat.unwrap() {
4015 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4016 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4017 expected_amt_msat.unwrap(), claimable_amt_msat);
4021 for htlc in sources.drain(..) {
4022 if let Err((pk, err)) = self.claim_funds_from_hop(
4023 htlc.prev_hop, payment_preimage,
4024 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
4026 if let msgs::ErrorAction::IgnoreError = err.err.action {
4027 // We got a temporary failure updating monitor, but will claim the
4028 // HTLC when the monitor updating is restored (or on chain).
4029 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4030 } else { errs.push((pk, err)); }
4035 for htlc in sources.drain(..) {
4036 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4037 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4038 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4039 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
4040 let receiver = HTLCDestination::FailedPayment { payment_hash };
4041 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4043 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4046 // Now we can handle any errors which were generated.
4047 for (counterparty_node_id, err) in errs.drain(..) {
4048 let res: Result<(), _> = Err(err);
4049 let _ = handle_error!(self, res, counterparty_node_id);
4053 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
4054 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
4055 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
4056 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4058 let per_peer_state = self.per_peer_state.read().unwrap();
4059 let chan_id = prev_hop.outpoint.to_channel_id();
4060 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
4061 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
4065 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
4066 |counterparty_node_id| per_peer_state.get(counterparty_node_id).map(
4067 |peer_mutex| peer_mutex.lock().unwrap()
4071 if peer_state_opt.is_some() {
4072 let mut peer_state_lock = peer_state_opt.unwrap();
4073 let peer_state = &mut *peer_state_lock;
4074 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(chan_id) {
4075 let counterparty_node_id = chan.get().get_counterparty_node_id();
4076 let fulfill_res = chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
4078 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
4079 if let Some(action) = completion_action(Some(htlc_value_msat)) {
4080 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
4081 log_bytes!(chan_id), action);
4082 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
4084 let update_id = monitor_update.update_id;
4085 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, monitor_update);
4086 let res = handle_new_monitor_update!(self, update_res, update_id, peer_state_lock,
4087 peer_state, per_peer_state, chan);
4088 if let Err(e) = res {
4089 // TODO: This is a *critical* error - we probably updated the outbound edge
4090 // of the HTLC's monitor with a preimage. We should retry this monitor
4091 // update over and over again until morale improves.
4092 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
4093 return Err((counterparty_node_id, e));
4099 let preimage_update = ChannelMonitorUpdate {
4100 update_id: CLOSED_CHANNEL_UPDATE_ID,
4101 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4105 // We update the ChannelMonitor on the backward link, after
4106 // receiving an `update_fulfill_htlc` from the forward link.
4107 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
4108 if update_res != ChannelMonitorUpdateStatus::Completed {
4109 // TODO: This needs to be handled somehow - if we receive a monitor update
4110 // with a preimage we *must* somehow manage to propagate it to the upstream
4111 // channel, or we must have an ability to receive the same event and try
4112 // again on restart.
4113 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4114 payment_preimage, update_res);
4116 // Note that we do process the completion action here. This totally could be a
4117 // duplicate claim, but we have no way of knowing without interrogating the
4118 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
4119 // generally always allowed to be duplicative (and it's specifically noted in
4120 // `PaymentForwarded`).
4121 self.handle_monitor_update_completion_actions(completion_action(None));
4125 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
4126 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
4129 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4131 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4132 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
4134 HTLCSource::PreviousHopData(hop_data) => {
4135 let prev_outpoint = hop_data.outpoint;
4136 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
4137 |htlc_claim_value_msat| {
4138 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4139 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4140 Some(claimed_htlc_value - forwarded_htlc_value)
4143 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4144 let next_channel_id = Some(next_channel_id);
4146 Some(MonitorUpdateCompletionAction::EmitEvent { event: events::Event::PaymentForwarded {
4148 claim_from_onchain_tx: from_onchain,
4154 if let Err((pk, err)) = res {
4155 let result: Result<(), _> = Err(err);
4156 let _ = handle_error!(self, result, pk);
4162 /// Gets the node_id held by this ChannelManager
4163 pub fn get_our_node_id(&self) -> PublicKey {
4164 self.our_network_pubkey.clone()
4167 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
4168 for action in actions.into_iter() {
4170 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
4171 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4172 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
4173 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4174 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
4178 MonitorUpdateCompletionAction::EmitEvent { event } => {
4179 self.pending_events.lock().unwrap().push(event);
4185 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
4186 /// update completion.
4187 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
4188 channel: &mut Channel<<SP::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
4189 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
4190 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
4191 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
4192 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
4193 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
4194 log_bytes!(channel.channel_id()),
4195 if raa.is_some() { "an" } else { "no" },
4196 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
4197 if funding_broadcastable.is_some() { "" } else { "not " },
4198 if channel_ready.is_some() { "sending" } else { "without" },
4199 if announcement_sigs.is_some() { "sending" } else { "without" });
4201 let mut htlc_forwards = None;
4203 let counterparty_node_id = channel.get_counterparty_node_id();
4204 if !pending_forwards.is_empty() {
4205 htlc_forwards = Some((channel.get_short_channel_id().unwrap_or(channel.outbound_scid_alias()),
4206 channel.get_funding_txo().unwrap(), channel.get_user_id(), pending_forwards));
4209 if let Some(msg) = channel_ready {
4210 send_channel_ready!(self, pending_msg_events, channel, msg);
4212 if let Some(msg) = announcement_sigs {
4213 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4214 node_id: counterparty_node_id,
4219 emit_channel_ready_event!(self, channel);
4221 macro_rules! handle_cs { () => {
4222 if let Some(update) = commitment_update {
4223 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4224 node_id: counterparty_node_id,
4229 macro_rules! handle_raa { () => {
4230 if let Some(revoke_and_ack) = raa {
4231 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4232 node_id: counterparty_node_id,
4233 msg: revoke_and_ack,
4238 RAACommitmentOrder::CommitmentFirst => {
4242 RAACommitmentOrder::RevokeAndACKFirst => {
4248 if let Some(tx) = funding_broadcastable {
4249 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4250 self.tx_broadcaster.broadcast_transaction(&tx);
4256 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
4257 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
4259 let counterparty_node_id = match counterparty_node_id {
4260 Some(cp_id) => cp_id.clone(),
4262 // TODO: Once we can rely on the counterparty_node_id from the
4263 // monitor event, this and the id_to_peer map should be removed.
4264 let id_to_peer = self.id_to_peer.lock().unwrap();
4265 match id_to_peer.get(&funding_txo.to_channel_id()) {
4266 Some(cp_id) => cp_id.clone(),
4271 let per_peer_state = self.per_peer_state.read().unwrap();
4272 let mut peer_state_lock;
4273 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4274 if peer_state_mutex_opt.is_none() { return }
4275 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4276 let peer_state = &mut *peer_state_lock;
4278 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()){
4279 hash_map::Entry::Occupied(chan) => chan,
4280 hash_map::Entry::Vacant(_) => return,
4283 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}",
4284 highest_applied_update_id, channel.get().get_latest_monitor_update_id());
4285 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4288 handle_monitor_update_completion!(self, highest_applied_update_id, peer_state_lock, peer_state, per_peer_state, channel.get_mut());
4291 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4293 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4294 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4297 /// The `user_channel_id` parameter will be provided back in
4298 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4299 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4301 /// Note that this method will return an error and reject the channel, if it requires support
4302 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4303 /// used to accept such channels.
4305 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4306 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4307 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4308 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4311 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4312 /// it as confirmed immediately.
4314 /// The `user_channel_id` parameter will be provided back in
4315 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4316 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4318 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4319 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4321 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4322 /// transaction and blindly assumes that it will eventually confirm.
4324 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4325 /// does not pay to the correct script the correct amount, *you will lose funds*.
4327 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4328 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4329 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> {
4330 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4333 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4334 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4336 let peers_without_funded_channels = self.peers_without_funded_channels(|peer| !peer.channel_by_id.is_empty());
4337 let per_peer_state = self.per_peer_state.read().unwrap();
4338 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4339 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4340 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4341 let peer_state = &mut *peer_state_lock;
4342 let is_only_peer_channel = peer_state.channel_by_id.len() == 1;
4343 match peer_state.channel_by_id.entry(temporary_channel_id.clone()) {
4344 hash_map::Entry::Occupied(mut channel) => {
4345 if !channel.get().inbound_is_awaiting_accept() {
4346 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4349 channel.get_mut().set_0conf();
4350 } else if channel.get().get_channel_type().requires_zero_conf() {
4351 let send_msg_err_event = events::MessageSendEvent::HandleError {
4352 node_id: channel.get().get_counterparty_node_id(),
4353 action: msgs::ErrorAction::SendErrorMessage{
4354 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4357 peer_state.pending_msg_events.push(send_msg_err_event);
4358 let _ = remove_channel!(self, channel);
4359 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4361 // If this peer already has some channels, a new channel won't increase our number of peers
4362 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
4363 // channels per-peer we can accept channels from a peer with existing ones.
4364 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
4365 let send_msg_err_event = events::MessageSendEvent::HandleError {
4366 node_id: channel.get().get_counterparty_node_id(),
4367 action: msgs::ErrorAction::SendErrorMessage{
4368 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
4371 peer_state.pending_msg_events.push(send_msg_err_event);
4372 let _ = remove_channel!(self, channel);
4373 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
4377 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4378 node_id: channel.get().get_counterparty_node_id(),
4379 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4382 hash_map::Entry::Vacant(_) => {
4383 return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) });
4389 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
4390 /// or 0-conf channels.
4392 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
4393 /// non-0-conf channels we have with the peer.
4394 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
4395 where Filter: Fn(&PeerState<<SP::Target as SignerProvider>::Signer>) -> bool {
4396 let mut peers_without_funded_channels = 0;
4397 let best_block_height = self.best_block.read().unwrap().height();
4399 let peer_state_lock = self.per_peer_state.read().unwrap();
4400 for (_, peer_mtx) in peer_state_lock.iter() {
4401 let peer = peer_mtx.lock().unwrap();
4402 if !maybe_count_peer(&*peer) { continue; }
4403 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
4404 if num_unfunded_channels == peer.channel_by_id.len() {
4405 peers_without_funded_channels += 1;
4409 return peers_without_funded_channels;
4412 fn unfunded_channel_count(
4413 peer: &PeerState<<SP::Target as SignerProvider>::Signer>, best_block_height: u32
4415 let mut num_unfunded_channels = 0;
4416 for (_, chan) in peer.channel_by_id.iter() {
4417 if !chan.is_outbound() && chan.minimum_depth().unwrap_or(1) != 0 &&
4418 chan.get_funding_tx_confirmations(best_block_height) == 0
4420 num_unfunded_channels += 1;
4423 num_unfunded_channels
4426 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4427 if msg.chain_hash != self.genesis_hash {
4428 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4431 if !self.default_configuration.accept_inbound_channels {
4432 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4435 let mut random_bytes = [0u8; 16];
4436 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
4437 let user_channel_id = u128::from_be_bytes(random_bytes);
4438 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4440 // Get the number of peers with channels, but without funded ones. We don't care too much
4441 // about peers that never open a channel, so we filter by peers that have at least one
4442 // channel, and then limit the number of those with unfunded channels.
4443 let channeled_peers_without_funding = self.peers_without_funded_channels(|node| !node.channel_by_id.is_empty());
4445 let per_peer_state = self.per_peer_state.read().unwrap();
4446 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4448 debug_assert!(false);
4449 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id.clone())
4451 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4452 let peer_state = &mut *peer_state_lock;
4454 // If this peer already has some channels, a new channel won't increase our number of peers
4455 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
4456 // channels per-peer we can accept channels from a peer with existing ones.
4457 if peer_state.channel_by_id.is_empty() &&
4458 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
4459 !self.default_configuration.manually_accept_inbound_channels
4461 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4462 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
4463 msg.temporary_channel_id.clone()));
4466 let best_block_height = self.best_block.read().unwrap().height();
4467 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
4468 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4469 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
4470 msg.temporary_channel_id.clone()));
4473 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
4474 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
4475 &self.default_configuration, best_block_height, &self.logger, outbound_scid_alias)
4478 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4479 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4483 match peer_state.channel_by_id.entry(channel.channel_id()) {
4484 hash_map::Entry::Occupied(_) => {
4485 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4486 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()))
4488 hash_map::Entry::Vacant(entry) => {
4489 if !self.default_configuration.manually_accept_inbound_channels {
4490 if channel.get_channel_type().requires_zero_conf() {
4491 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4493 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4494 node_id: counterparty_node_id.clone(),
4495 msg: channel.accept_inbound_channel(user_channel_id),
4498 let mut pending_events = self.pending_events.lock().unwrap();
4499 pending_events.push(
4500 events::Event::OpenChannelRequest {
4501 temporary_channel_id: msg.temporary_channel_id.clone(),
4502 counterparty_node_id: counterparty_node_id.clone(),
4503 funding_satoshis: msg.funding_satoshis,
4504 push_msat: msg.push_msat,
4505 channel_type: channel.get_channel_type().clone(),
4510 entry.insert(channel);
4516 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4517 let (value, output_script, user_id) = {
4518 let per_peer_state = self.per_peer_state.read().unwrap();
4519 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4521 debug_assert!(false);
4522 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id)
4524 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4525 let peer_state = &mut *peer_state_lock;
4526 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4527 hash_map::Entry::Occupied(mut chan) => {
4528 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
4529 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4531 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4534 let mut pending_events = self.pending_events.lock().unwrap();
4535 pending_events.push(events::Event::FundingGenerationReady {
4536 temporary_channel_id: msg.temporary_channel_id,
4537 counterparty_node_id: *counterparty_node_id,
4538 channel_value_satoshis: value,
4540 user_channel_id: user_id,
4545 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4546 let best_block = *self.best_block.read().unwrap();
4548 let per_peer_state = self.per_peer_state.read().unwrap();
4549 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4551 debug_assert!(false);
4552 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id)
4555 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4556 let peer_state = &mut *peer_state_lock;
4557 let ((funding_msg, monitor), chan) =
4558 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4559 hash_map::Entry::Occupied(mut chan) => {
4560 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.signer_provider, &self.logger), chan), chan.remove())
4562 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4565 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
4566 hash_map::Entry::Occupied(_) => {
4567 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4569 hash_map::Entry::Vacant(e) => {
4570 match self.id_to_peer.lock().unwrap().entry(chan.channel_id()) {
4571 hash_map::Entry::Occupied(_) => {
4572 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4573 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4574 funding_msg.channel_id))
4576 hash_map::Entry::Vacant(i_e) => {
4577 i_e.insert(chan.get_counterparty_node_id());
4581 // There's no problem signing a counterparty's funding transaction if our monitor
4582 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4583 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4584 // until we have persisted our monitor.
4585 let new_channel_id = funding_msg.channel_id;
4586 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4587 node_id: counterparty_node_id.clone(),
4591 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
4593 let chan = e.insert(chan);
4594 let mut res = handle_new_monitor_update!(self, monitor_res, 0, peer_state_lock, peer_state,
4595 per_peer_state, chan, MANUALLY_REMOVING, { peer_state.channel_by_id.remove(&new_channel_id) });
4597 // Note that we reply with the new channel_id in error messages if we gave up on the
4598 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4599 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4600 // any messages referencing a previously-closed channel anyway.
4601 // We do not propagate the monitor update to the user as it would be for a monitor
4602 // that we didn't manage to store (and that we don't care about - we don't respond
4603 // with the funding_signed so the channel can never go on chain).
4604 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
4612 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4613 let best_block = *self.best_block.read().unwrap();
4614 let per_peer_state = self.per_peer_state.read().unwrap();
4615 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4617 debug_assert!(false);
4618 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4621 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4622 let peer_state = &mut *peer_state_lock;
4623 match peer_state.channel_by_id.entry(msg.channel_id) {
4624 hash_map::Entry::Occupied(mut chan) => {
4625 let monitor = try_chan_entry!(self,
4626 chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan);
4627 let update_res = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor);
4628 let mut res = handle_new_monitor_update!(self, update_res, 0, peer_state_lock, peer_state, per_peer_state, chan);
4629 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4630 // We weren't able to watch the channel to begin with, so no updates should be made on
4631 // it. Previously, full_stack_target found an (unreachable) panic when the
4632 // monitor update contained within `shutdown_finish` was applied.
4633 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4634 shutdown_finish.0.take();
4639 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4643 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4644 let per_peer_state = self.per_peer_state.read().unwrap();
4645 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4647 debug_assert!(false);
4648 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4650 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4651 let peer_state = &mut *peer_state_lock;
4652 match peer_state.channel_by_id.entry(msg.channel_id) {
4653 hash_map::Entry::Occupied(mut chan) => {
4654 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
4655 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
4656 if let Some(announcement_sigs) = announcement_sigs_opt {
4657 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4658 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4659 node_id: counterparty_node_id.clone(),
4660 msg: announcement_sigs,
4662 } else if chan.get().is_usable() {
4663 // If we're sending an announcement_signatures, we'll send the (public)
4664 // channel_update after sending a channel_announcement when we receive our
4665 // counterparty's announcement_signatures. Thus, we only bother to send a
4666 // channel_update here if the channel is not public, i.e. we're not sending an
4667 // announcement_signatures.
4668 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4669 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4670 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4671 node_id: counterparty_node_id.clone(),
4677 emit_channel_ready_event!(self, chan.get_mut());
4681 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4685 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4686 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4687 let result: Result<(), _> = loop {
4688 let per_peer_state = self.per_peer_state.read().unwrap();
4689 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4691 debug_assert!(false);
4692 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4694 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4695 let peer_state = &mut *peer_state_lock;
4696 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4697 hash_map::Entry::Occupied(mut chan_entry) => {
4699 if !chan_entry.get().received_shutdown() {
4700 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4701 log_bytes!(msg.channel_id),
4702 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4705 let funding_txo_opt = chan_entry.get().get_funding_txo();
4706 let (shutdown, monitor_update_opt, htlcs) = try_chan_entry!(self,
4707 chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
4708 dropped_htlcs = htlcs;
4710 if let Some(msg) = shutdown {
4711 // We can send the `shutdown` message before updating the `ChannelMonitor`
4712 // here as we don't need the monitor update to complete until we send a
4713 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
4714 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4715 node_id: *counterparty_node_id,
4720 // Update the monitor with the shutdown script if necessary.
4721 if let Some(monitor_update) = monitor_update_opt {
4722 let update_id = monitor_update.update_id;
4723 let update_res = self.chain_monitor.update_channel(funding_txo_opt.unwrap(), monitor_update);
4724 break handle_new_monitor_update!(self, update_res, update_id, peer_state_lock, peer_state, per_peer_state, chan_entry);
4728 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4731 for htlc_source in dropped_htlcs.drain(..) {
4732 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4733 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
4734 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
4740 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4741 let per_peer_state = self.per_peer_state.read().unwrap();
4742 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4744 debug_assert!(false);
4745 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4747 let (tx, chan_option) = {
4748 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4749 let peer_state = &mut *peer_state_lock;
4750 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4751 hash_map::Entry::Occupied(mut chan_entry) => {
4752 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
4753 if let Some(msg) = closing_signed {
4754 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4755 node_id: counterparty_node_id.clone(),
4760 // We're done with this channel, we've got a signed closing transaction and
4761 // will send the closing_signed back to the remote peer upon return. This
4762 // also implies there are no pending HTLCs left on the channel, so we can
4763 // fully delete it from tracking (the channel monitor is still around to
4764 // watch for old state broadcasts)!
4765 (tx, Some(remove_channel!(self, chan_entry)))
4766 } else { (tx, None) }
4768 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4771 if let Some(broadcast_tx) = tx {
4772 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4773 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4775 if let Some(chan) = chan_option {
4776 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4777 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4778 let peer_state = &mut *peer_state_lock;
4779 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4783 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4788 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4789 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4790 //determine the state of the payment based on our response/if we forward anything/the time
4791 //we take to respond. We should take care to avoid allowing such an attack.
4793 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4794 //us repeatedly garbled in different ways, and compare our error messages, which are
4795 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4796 //but we should prevent it anyway.
4798 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4799 let per_peer_state = self.per_peer_state.read().unwrap();
4800 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4802 debug_assert!(false);
4803 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4805 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4806 let peer_state = &mut *peer_state_lock;
4807 match peer_state.channel_by_id.entry(msg.channel_id) {
4808 hash_map::Entry::Occupied(mut chan) => {
4810 let create_pending_htlc_status = |chan: &Channel<<SP::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4811 // If the update_add is completely bogus, the call will Err and we will close,
4812 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4813 // want to reject the new HTLC and fail it backwards instead of forwarding.
4814 match pending_forward_info {
4815 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4816 let reason = if (error_code & 0x1000) != 0 {
4817 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4818 HTLCFailReason::reason(real_code, error_data)
4820 HTLCFailReason::from_failure_code(error_code)
4821 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
4822 let msg = msgs::UpdateFailHTLC {
4823 channel_id: msg.channel_id,
4824 htlc_id: msg.htlc_id,
4827 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4829 _ => pending_forward_info
4832 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
4834 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4839 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4840 let (htlc_source, forwarded_htlc_value) = {
4841 let per_peer_state = self.per_peer_state.read().unwrap();
4842 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4844 debug_assert!(false);
4845 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4847 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4848 let peer_state = &mut *peer_state_lock;
4849 match peer_state.channel_by_id.entry(msg.channel_id) {
4850 hash_map::Entry::Occupied(mut chan) => {
4851 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
4853 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4856 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4860 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4861 let per_peer_state = self.per_peer_state.read().unwrap();
4862 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4864 debug_assert!(false);
4865 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4867 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4868 let peer_state = &mut *peer_state_lock;
4869 match peer_state.channel_by_id.entry(msg.channel_id) {
4870 hash_map::Entry::Occupied(mut chan) => {
4871 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
4873 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4878 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4879 let per_peer_state = self.per_peer_state.read().unwrap();
4880 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4882 debug_assert!(false);
4883 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4885 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4886 let peer_state = &mut *peer_state_lock;
4887 match peer_state.channel_by_id.entry(msg.channel_id) {
4888 hash_map::Entry::Occupied(mut chan) => {
4889 if (msg.failure_code & 0x8000) == 0 {
4890 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4891 try_chan_entry!(self, Err(chan_err), chan);
4893 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
4896 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4900 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4901 let per_peer_state = self.per_peer_state.read().unwrap();
4902 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4904 debug_assert!(false);
4905 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4907 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4908 let peer_state = &mut *peer_state_lock;
4909 match peer_state.channel_by_id.entry(msg.channel_id) {
4910 hash_map::Entry::Occupied(mut chan) => {
4911 let funding_txo = chan.get().get_funding_txo();
4912 let monitor_update = try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &self.logger), chan);
4913 let update_res = self.chain_monitor.update_channel(funding_txo.unwrap(), monitor_update);
4914 let update_id = monitor_update.update_id;
4915 handle_new_monitor_update!(self, update_res, update_id, peer_state_lock,
4916 peer_state, per_peer_state, chan)
4918 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4923 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
4924 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
4925 let mut push_forward_event = false;
4926 let mut new_intercept_events = Vec::new();
4927 let mut failed_intercept_forwards = Vec::new();
4928 if !pending_forwards.is_empty() {
4929 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4930 let scid = match forward_info.routing {
4931 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4932 PendingHTLCRouting::Receive { .. } => 0,
4933 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4935 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
4936 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
4938 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4939 let forward_htlcs_empty = forward_htlcs.is_empty();
4940 match forward_htlcs.entry(scid) {
4941 hash_map::Entry::Occupied(mut entry) => {
4942 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4943 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
4945 hash_map::Entry::Vacant(entry) => {
4946 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
4947 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
4949 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
4950 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
4951 match pending_intercepts.entry(intercept_id) {
4952 hash_map::Entry::Vacant(entry) => {
4953 new_intercept_events.push(events::Event::HTLCIntercepted {
4954 requested_next_hop_scid: scid,
4955 payment_hash: forward_info.payment_hash,
4956 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
4957 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
4960 entry.insert(PendingAddHTLCInfo {
4961 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
4963 hash_map::Entry::Occupied(_) => {
4964 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
4965 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4966 short_channel_id: prev_short_channel_id,
4967 outpoint: prev_funding_outpoint,
4968 htlc_id: prev_htlc_id,
4969 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
4970 phantom_shared_secret: None,
4973 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
4974 HTLCFailReason::from_failure_code(0x4000 | 10),
4975 HTLCDestination::InvalidForward { requested_forward_scid: scid },
4980 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
4981 // payments are being processed.
4982 if forward_htlcs_empty {
4983 push_forward_event = true;
4985 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4986 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
4993 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
4994 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4997 if !new_intercept_events.is_empty() {
4998 let mut events = self.pending_events.lock().unwrap();
4999 events.append(&mut new_intercept_events);
5001 if push_forward_event { self.push_pending_forwards_ev() }
5005 // We only want to push a PendingHTLCsForwardable event if no others are queued.
5006 fn push_pending_forwards_ev(&self) {
5007 let mut pending_events = self.pending_events.lock().unwrap();
5008 let forward_ev_exists = pending_events.iter()
5009 .find(|ev| if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false })
5011 if !forward_ev_exists {
5012 pending_events.push(events::Event::PendingHTLCsForwardable {
5014 Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
5019 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
5020 let (htlcs_to_fail, res) = {
5021 let per_peer_state = self.per_peer_state.read().unwrap();
5022 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
5024 debug_assert!(false);
5025 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5026 }).map(|mtx| mtx.lock().unwrap())?;
5027 let peer_state = &mut *peer_state_lock;
5028 match peer_state.channel_by_id.entry(msg.channel_id) {
5029 hash_map::Entry::Occupied(mut chan) => {
5030 let funding_txo = chan.get().get_funding_txo();
5031 let (htlcs_to_fail, monitor_update) = try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
5032 let update_res = self.chain_monitor.update_channel(funding_txo.unwrap(), monitor_update);
5033 let update_id = monitor_update.update_id;
5034 let res = handle_new_monitor_update!(self, update_res, update_id,
5035 peer_state_lock, peer_state, per_peer_state, chan);
5036 (htlcs_to_fail, res)
5038 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5041 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
5045 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
5046 let per_peer_state = self.per_peer_state.read().unwrap();
5047 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5049 debug_assert!(false);
5050 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5052 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5053 let peer_state = &mut *peer_state_lock;
5054 match peer_state.channel_by_id.entry(msg.channel_id) {
5055 hash_map::Entry::Occupied(mut chan) => {
5056 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
5058 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5063 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
5064 let per_peer_state = self.per_peer_state.read().unwrap();
5065 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5067 debug_assert!(false);
5068 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5070 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5071 let peer_state = &mut *peer_state_lock;
5072 match peer_state.channel_by_id.entry(msg.channel_id) {
5073 hash_map::Entry::Occupied(mut chan) => {
5074 if !chan.get().is_usable() {
5075 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5078 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5079 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5080 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
5081 msg, &self.default_configuration
5083 // Note that announcement_signatures fails if the channel cannot be announced,
5084 // so get_channel_update_for_broadcast will never fail by the time we get here.
5085 update_msg: Some(self.get_channel_update_for_broadcast(chan.get()).unwrap()),
5088 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5093 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5094 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5095 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
5096 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
5098 // It's not a local channel
5099 return Ok(NotifyOption::SkipPersist)
5102 let per_peer_state = self.per_peer_state.read().unwrap();
5103 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
5104 if peer_state_mutex_opt.is_none() {
5105 return Ok(NotifyOption::SkipPersist)
5107 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5108 let peer_state = &mut *peer_state_lock;
5109 match peer_state.channel_by_id.entry(chan_id) {
5110 hash_map::Entry::Occupied(mut chan) => {
5111 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5112 if chan.get().should_announce() {
5113 // If the announcement is about a channel of ours which is public, some
5114 // other peer may simply be forwarding all its gossip to us. Don't provide
5115 // a scary-looking error message and return Ok instead.
5116 return Ok(NotifyOption::SkipPersist);
5118 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));
5120 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5121 let msg_from_node_one = msg.contents.flags & 1 == 0;
5122 if were_node_one == msg_from_node_one {
5123 return Ok(NotifyOption::SkipPersist);
5125 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5126 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
5129 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5131 Ok(NotifyOption::DoPersist)
5134 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5136 let need_lnd_workaround = {
5137 let per_peer_state = self.per_peer_state.read().unwrap();
5139 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5141 debug_assert!(false);
5142 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5144 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5145 let peer_state = &mut *peer_state_lock;
5146 match peer_state.channel_by_id.entry(msg.channel_id) {
5147 hash_map::Entry::Occupied(mut chan) => {
5148 // Currently, we expect all holding cell update_adds to be dropped on peer
5149 // disconnect, so Channel's reestablish will never hand us any holding cell
5150 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5151 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5152 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5153 msg, &self.logger, &self.node_signer, self.genesis_hash,
5154 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
5155 let mut channel_update = None;
5156 if let Some(msg) = responses.shutdown_msg {
5157 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5158 node_id: counterparty_node_id.clone(),
5161 } else if chan.get().is_usable() {
5162 // If the channel is in a usable state (ie the channel is not being shut
5163 // down), send a unicast channel_update to our counterparty to make sure
5164 // they have the latest channel parameters.
5165 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5166 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5167 node_id: chan.get().get_counterparty_node_id(),
5172 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5173 htlc_forwards = self.handle_channel_resumption(
5174 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
5175 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5176 if let Some(upd) = channel_update {
5177 peer_state.pending_msg_events.push(upd);
5181 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5185 if let Some(forwards) = htlc_forwards {
5186 self.forward_htlcs(&mut [forwards][..]);
5189 if let Some(channel_ready_msg) = need_lnd_workaround {
5190 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5195 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
5196 fn process_pending_monitor_events(&self) -> bool {
5197 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5199 let mut failed_channels = Vec::new();
5200 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5201 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5202 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5203 for monitor_event in monitor_events.drain(..) {
5204 match monitor_event {
5205 MonitorEvent::HTLCEvent(htlc_update) => {
5206 if let Some(preimage) = htlc_update.payment_preimage {
5207 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5208 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5210 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5211 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5212 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5213 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
5216 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5217 MonitorEvent::UpdateFailed(funding_outpoint) => {
5218 let counterparty_node_id_opt = match counterparty_node_id {
5219 Some(cp_id) => Some(cp_id),
5221 // TODO: Once we can rely on the counterparty_node_id from the
5222 // monitor event, this and the id_to_peer map should be removed.
5223 let id_to_peer = self.id_to_peer.lock().unwrap();
5224 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
5227 if let Some(counterparty_node_id) = counterparty_node_id_opt {
5228 let per_peer_state = self.per_peer_state.read().unwrap();
5229 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
5230 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5231 let peer_state = &mut *peer_state_lock;
5232 let pending_msg_events = &mut peer_state.pending_msg_events;
5233 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
5234 let mut chan = remove_channel!(self, chan_entry);
5235 failed_channels.push(chan.force_shutdown(false));
5236 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5237 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5241 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5242 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5244 ClosureReason::CommitmentTxConfirmed
5246 self.issue_channel_close_events(&chan, reason);
5247 pending_msg_events.push(events::MessageSendEvent::HandleError {
5248 node_id: chan.get_counterparty_node_id(),
5249 action: msgs::ErrorAction::SendErrorMessage {
5250 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5257 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5258 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
5264 for failure in failed_channels.drain(..) {
5265 self.finish_force_close_channel(failure);
5268 has_pending_monitor_events
5271 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5272 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5273 /// update events as a separate process method here.
5275 pub fn process_monitor_events(&self) {
5276 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5277 if self.process_pending_monitor_events() {
5278 NotifyOption::DoPersist
5280 NotifyOption::SkipPersist
5285 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5286 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5287 /// update was applied.
5288 fn check_free_holding_cells(&self) -> bool {
5289 let mut has_monitor_update = false;
5290 let mut failed_htlcs = Vec::new();
5291 let mut handle_errors = Vec::new();
5293 // Walk our list of channels and find any that need to update. Note that when we do find an
5294 // update, if it includes actions that must be taken afterwards, we have to drop the
5295 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
5296 // manage to go through all our peers without finding a single channel to update.
5298 let per_peer_state = self.per_peer_state.read().unwrap();
5299 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5301 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5302 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
5303 for (channel_id, chan) in peer_state.channel_by_id.iter_mut() {
5304 let counterparty_node_id = chan.get_counterparty_node_id();
5305 let funding_txo = chan.get_funding_txo();
5306 let (monitor_opt, holding_cell_failed_htlcs) =
5307 chan.maybe_free_holding_cell_htlcs(&self.logger);
5308 if !holding_cell_failed_htlcs.is_empty() {
5309 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
5311 if let Some(monitor_update) = monitor_opt {
5312 has_monitor_update = true;
5314 let update_res = self.chain_monitor.update_channel(
5315 funding_txo.expect("channel is live"), monitor_update);
5316 let update_id = monitor_update.update_id;
5317 let channel_id: [u8; 32] = *channel_id;
5318 let res = handle_new_monitor_update!(self, update_res, update_id,
5319 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
5320 peer_state.channel_by_id.remove(&channel_id));
5322 handle_errors.push((counterparty_node_id, res));
5324 continue 'peer_loop;
5333 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5334 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5335 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5338 for (counterparty_node_id, err) in handle_errors.drain(..) {
5339 let _ = handle_error!(self, err, counterparty_node_id);
5345 /// Check whether any channels have finished removing all pending updates after a shutdown
5346 /// exchange and can now send a closing_signed.
5347 /// Returns whether any closing_signed messages were generated.
5348 fn maybe_generate_initial_closing_signed(&self) -> bool {
5349 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5350 let mut has_update = false;
5352 let per_peer_state = self.per_peer_state.read().unwrap();
5354 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5355 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5356 let peer_state = &mut *peer_state_lock;
5357 let pending_msg_events = &mut peer_state.pending_msg_events;
5358 peer_state.channel_by_id.retain(|channel_id, chan| {
5359 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5360 Ok((msg_opt, tx_opt)) => {
5361 if let Some(msg) = msg_opt {
5363 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5364 node_id: chan.get_counterparty_node_id(), msg,
5367 if let Some(tx) = tx_opt {
5368 // We're done with this channel. We got a closing_signed and sent back
5369 // a closing_signed with a closing transaction to broadcast.
5370 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5371 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5376 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5378 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5379 self.tx_broadcaster.broadcast_transaction(&tx);
5380 update_maps_on_chan_removal!(self, chan);
5386 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5387 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5395 for (counterparty_node_id, err) in handle_errors.drain(..) {
5396 let _ = handle_error!(self, err, counterparty_node_id);
5402 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5403 /// pushing the channel monitor update (if any) to the background events queue and removing the
5405 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5406 for mut failure in failed_channels.drain(..) {
5407 // Either a commitment transactions has been confirmed on-chain or
5408 // Channel::block_disconnected detected that the funding transaction has been
5409 // reorganized out of the main chain.
5410 // We cannot broadcast our latest local state via monitor update (as
5411 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5412 // so we track the update internally and handle it when the user next calls
5413 // timer_tick_occurred, guaranteeing we're running normally.
5414 if let Some((funding_txo, update)) = failure.0.take() {
5415 assert_eq!(update.updates.len(), 1);
5416 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5417 assert!(should_broadcast);
5418 } else { unreachable!(); }
5419 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5421 self.finish_force_close_channel(failure);
5425 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> {
5426 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5428 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5429 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5432 let payment_secret = PaymentSecret(self.entropy_source.get_secure_random_bytes());
5434 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5435 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5436 match payment_secrets.entry(payment_hash) {
5437 hash_map::Entry::Vacant(e) => {
5438 e.insert(PendingInboundPayment {
5439 payment_secret, min_value_msat, payment_preimage,
5440 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5441 // We assume that highest_seen_timestamp is pretty close to the current time -
5442 // it's updated when we receive a new block with the maximum time we've seen in
5443 // a header. It should never be more than two hours in the future.
5444 // Thus, we add two hours here as a buffer to ensure we absolutely
5445 // never fail a payment too early.
5446 // Note that we assume that received blocks have reasonably up-to-date
5448 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5451 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5456 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5459 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5460 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5462 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
5463 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
5464 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
5465 /// passed directly to [`claim_funds`].
5467 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5469 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5470 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5474 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5475 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5477 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5479 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
5480 /// on versions of LDK prior to 0.0.114.
5482 /// [`claim_funds`]: Self::claim_funds
5483 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5484 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
5485 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
5486 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
5487 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5488 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
5489 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
5490 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
5491 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
5492 min_final_cltv_expiry_delta)
5495 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5496 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5498 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5501 /// This method is deprecated and will be removed soon.
5503 /// [`create_inbound_payment`]: Self::create_inbound_payment
5505 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5506 let payment_preimage = PaymentPreimage(self.entropy_source.get_secure_random_bytes());
5507 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5508 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5509 Ok((payment_hash, payment_secret))
5512 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5513 /// stored external to LDK.
5515 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
5516 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5517 /// the `min_value_msat` provided here, if one is provided.
5519 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5520 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5523 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5524 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5525 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
5526 /// sender "proof-of-payment" unless they have paid the required amount.
5528 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5529 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5530 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5531 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5532 /// invoices when no timeout is set.
5534 /// Note that we use block header time to time-out pending inbound payments (with some margin
5535 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5536 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
5537 /// If you need exact expiry semantics, you should enforce them upon receipt of
5538 /// [`PaymentClaimable`].
5540 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
5541 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
5543 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5544 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5548 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5549 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5551 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5553 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
5554 /// on versions of LDK prior to 0.0.114.
5556 /// [`create_inbound_payment`]: Self::create_inbound_payment
5557 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5558 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
5559 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
5560 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
5561 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
5562 min_final_cltv_expiry)
5565 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5566 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5568 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5571 /// This method is deprecated and will be removed soon.
5573 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5575 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> {
5576 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5579 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5580 /// previously returned from [`create_inbound_payment`].
5582 /// [`create_inbound_payment`]: Self::create_inbound_payment
5583 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5584 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5587 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5588 /// are used when constructing the phantom invoice's route hints.
5590 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5591 pub fn get_phantom_scid(&self) -> u64 {
5592 let best_block_height = self.best_block.read().unwrap().height();
5593 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5595 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
5596 // Ensure the generated scid doesn't conflict with a real channel.
5597 match short_to_chan_info.get(&scid_candidate) {
5598 Some(_) => continue,
5599 None => return scid_candidate
5604 /// Gets route hints for use in receiving [phantom node payments].
5606 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5607 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5609 channels: self.list_usable_channels(),
5610 phantom_scid: self.get_phantom_scid(),
5611 real_node_pubkey: self.get_our_node_id(),
5615 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
5616 /// used when constructing the route hints for HTLCs intended to be intercepted. See
5617 /// [`ChannelManager::forward_intercepted_htlc`].
5619 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
5620 /// times to get a unique scid.
5621 pub fn get_intercept_scid(&self) -> u64 {
5622 let best_block_height = self.best_block.read().unwrap().height();
5623 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5625 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
5626 // Ensure the generated scid doesn't conflict with a real channel.
5627 if short_to_chan_info.contains_key(&scid_candidate) { continue }
5628 return scid_candidate
5632 /// Gets inflight HTLC information by processing pending outbound payments that are in
5633 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
5634 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
5635 let mut inflight_htlcs = InFlightHtlcs::new();
5637 let per_peer_state = self.per_peer_state.read().unwrap();
5638 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5639 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5640 let peer_state = &mut *peer_state_lock;
5641 for chan in peer_state.channel_by_id.values() {
5642 for (htlc_source, _) in chan.inflight_htlc_sources() {
5643 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
5644 inflight_htlcs.process_path(path, self.get_our_node_id());
5653 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5654 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5655 let events = core::cell::RefCell::new(Vec::new());
5656 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5657 self.process_pending_events(&event_handler);
5661 #[cfg(feature = "_test_utils")]
5662 pub fn push_pending_event(&self, event: events::Event) {
5663 let mut events = self.pending_events.lock().unwrap();
5668 pub fn pop_pending_event(&self) -> Option<events::Event> {
5669 let mut events = self.pending_events.lock().unwrap();
5670 if events.is_empty() { None } else { Some(events.remove(0)) }
5674 pub fn has_pending_payments(&self) -> bool {
5675 self.pending_outbound_payments.has_pending_payments()
5679 pub fn clear_pending_payments(&self) {
5680 self.pending_outbound_payments.clear_pending_payments()
5683 /// Processes any events asynchronously in the order they were generated since the last call
5684 /// using the given event handler.
5686 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5687 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5690 // We'll acquire our total consistency lock until the returned future completes so that
5691 // we can be sure no other persists happen while processing events.
5692 let _read_guard = self.total_consistency_lock.read().unwrap();
5694 let mut result = NotifyOption::SkipPersist;
5696 // TODO: This behavior should be documented. It's unintuitive that we query
5697 // ChannelMonitors when clearing other events.
5698 if self.process_pending_monitor_events() {
5699 result = NotifyOption::DoPersist;
5702 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5703 if !pending_events.is_empty() {
5704 result = NotifyOption::DoPersist;
5707 for event in pending_events {
5708 handler(event).await;
5711 if result == NotifyOption::DoPersist {
5712 self.persistence_notifier.notify();
5717 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, ES, NS, SP, F, R, L>
5719 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5720 T::Target: BroadcasterInterface,
5721 ES::Target: EntropySource,
5722 NS::Target: NodeSigner,
5723 SP::Target: SignerProvider,
5724 F::Target: FeeEstimator,
5728 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
5729 /// The returned array will contain `MessageSendEvent`s for different peers if
5730 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
5731 /// is always placed next to each other.
5733 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
5734 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
5735 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
5736 /// will randomly be placed first or last in the returned array.
5738 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
5739 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
5740 /// the `MessageSendEvent`s to the specific peer they were generated under.
5741 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5742 let events = RefCell::new(Vec::new());
5743 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5744 let mut result = NotifyOption::SkipPersist;
5746 // TODO: This behavior should be documented. It's unintuitive that we query
5747 // ChannelMonitors when clearing other events.
5748 if self.process_pending_monitor_events() {
5749 result = NotifyOption::DoPersist;
5752 if self.check_free_holding_cells() {
5753 result = NotifyOption::DoPersist;
5755 if self.maybe_generate_initial_closing_signed() {
5756 result = NotifyOption::DoPersist;
5759 let mut pending_events = Vec::new();
5760 let per_peer_state = self.per_peer_state.read().unwrap();
5761 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5762 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5763 let peer_state = &mut *peer_state_lock;
5764 if peer_state.pending_msg_events.len() > 0 {
5765 pending_events.append(&mut peer_state.pending_msg_events);
5769 if !pending_events.is_empty() {
5770 events.replace(pending_events);
5779 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> EventsProvider for ChannelManager<M, T, ES, NS, SP, F, R, L>
5781 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5782 T::Target: BroadcasterInterface,
5783 ES::Target: EntropySource,
5784 NS::Target: NodeSigner,
5785 SP::Target: SignerProvider,
5786 F::Target: FeeEstimator,
5790 /// Processes events that must be periodically handled.
5792 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5793 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5794 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5795 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5796 let mut result = NotifyOption::SkipPersist;
5798 // TODO: This behavior should be documented. It's unintuitive that we query
5799 // ChannelMonitors when clearing other events.
5800 if self.process_pending_monitor_events() {
5801 result = NotifyOption::DoPersist;
5804 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5805 if !pending_events.is_empty() {
5806 result = NotifyOption::DoPersist;
5809 for event in pending_events {
5810 handler.handle_event(event);
5818 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> chain::Listen for ChannelManager<M, T, ES, NS, SP, F, R, L>
5820 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5821 T::Target: BroadcasterInterface,
5822 ES::Target: EntropySource,
5823 NS::Target: NodeSigner,
5824 SP::Target: SignerProvider,
5825 F::Target: FeeEstimator,
5829 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5831 let best_block = self.best_block.read().unwrap();
5832 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5833 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5834 assert_eq!(best_block.height(), height - 1,
5835 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5838 self.transactions_confirmed(header, txdata, height);
5839 self.best_block_updated(header, height);
5842 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5843 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5844 let new_height = height - 1;
5846 let mut best_block = self.best_block.write().unwrap();
5847 assert_eq!(best_block.block_hash(), header.block_hash(),
5848 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5849 assert_eq!(best_block.height(), height,
5850 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5851 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5854 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
5858 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, ES, NS, SP, F, R, L>
5860 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5861 T::Target: BroadcasterInterface,
5862 ES::Target: EntropySource,
5863 NS::Target: NodeSigner,
5864 SP::Target: SignerProvider,
5865 F::Target: FeeEstimator,
5869 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5870 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5871 // during initialization prior to the chain_monitor being fully configured in some cases.
5872 // See the docs for `ChannelManagerReadArgs` for more.
5874 let block_hash = header.block_hash();
5875 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5877 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5878 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger)
5879 .map(|(a, b)| (a, Vec::new(), b)));
5881 let last_best_block_height = self.best_block.read().unwrap().height();
5882 if height < last_best_block_height {
5883 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5884 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.node_signer, &self.default_configuration, &self.logger));
5888 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5889 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5890 // during initialization prior to the chain_monitor being fully configured in some cases.
5891 // See the docs for `ChannelManagerReadArgs` for more.
5893 let block_hash = header.block_hash();
5894 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5896 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5898 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5900 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
5902 macro_rules! max_time {
5903 ($timestamp: expr) => {
5905 // Update $timestamp to be the max of its current value and the block
5906 // timestamp. This should keep us close to the current time without relying on
5907 // having an explicit local time source.
5908 // Just in case we end up in a race, we loop until we either successfully
5909 // update $timestamp or decide we don't need to.
5910 let old_serial = $timestamp.load(Ordering::Acquire);
5911 if old_serial >= header.time as usize { break; }
5912 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5918 max_time!(self.highest_seen_timestamp);
5919 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5920 payment_secrets.retain(|_, inbound_payment| {
5921 inbound_payment.expiry_time > header.time as u64
5925 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
5926 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
5927 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
5928 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5929 let peer_state = &mut *peer_state_lock;
5930 for chan in peer_state.channel_by_id.values() {
5931 if let (Some(funding_txo), Some(block_hash)) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
5932 res.push((funding_txo.txid, Some(block_hash)));
5939 fn transaction_unconfirmed(&self, txid: &Txid) {
5940 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5941 self.do_chain_event(None, |channel| {
5942 if let Some(funding_txo) = channel.get_funding_txo() {
5943 if funding_txo.txid == *txid {
5944 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5945 } else { Ok((None, Vec::new(), None)) }
5946 } else { Ok((None, Vec::new(), None)) }
5951 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, ES, NS, SP, F, R, L>
5953 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5954 T::Target: BroadcasterInterface,
5955 ES::Target: EntropySource,
5956 NS::Target: NodeSigner,
5957 SP::Target: SignerProvider,
5958 F::Target: FeeEstimator,
5962 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5963 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5965 fn do_chain_event<FN: Fn(&mut Channel<<SP::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5966 (&self, height_opt: Option<u32>, f: FN) {
5967 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5968 // during initialization prior to the chain_monitor being fully configured in some cases.
5969 // See the docs for `ChannelManagerReadArgs` for more.
5971 let mut failed_channels = Vec::new();
5972 let mut timed_out_htlcs = Vec::new();
5974 let per_peer_state = self.per_peer_state.read().unwrap();
5975 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5976 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5977 let peer_state = &mut *peer_state_lock;
5978 let pending_msg_events = &mut peer_state.pending_msg_events;
5979 peer_state.channel_by_id.retain(|_, channel| {
5980 let res = f(channel);
5981 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5982 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5983 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5984 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
5985 HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5987 if let Some(channel_ready) = channel_ready_opt {
5988 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
5989 if channel.is_usable() {
5990 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5991 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5992 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5993 node_id: channel.get_counterparty_node_id(),
5998 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
6002 emit_channel_ready_event!(self, channel);
6004 if let Some(announcement_sigs) = announcement_sigs {
6005 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
6006 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6007 node_id: channel.get_counterparty_node_id(),
6008 msg: announcement_sigs,
6010 if let Some(height) = height_opt {
6011 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
6012 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6014 // Note that announcement_signatures fails if the channel cannot be announced,
6015 // so get_channel_update_for_broadcast will never fail by the time we get here.
6016 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
6021 if channel.is_our_channel_ready() {
6022 if let Some(real_scid) = channel.get_short_channel_id() {
6023 // If we sent a 0conf channel_ready, and now have an SCID, we add it
6024 // to the short_to_chan_info map here. Note that we check whether we
6025 // can relay using the real SCID at relay-time (i.e.
6026 // enforce option_scid_alias then), and if the funding tx is ever
6027 // un-confirmed we force-close the channel, ensuring short_to_chan_info
6028 // is always consistent.
6029 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
6030 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
6031 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
6032 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
6033 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
6036 } else if let Err(reason) = res {
6037 update_maps_on_chan_removal!(self, channel);
6038 // It looks like our counterparty went on-chain or funding transaction was
6039 // reorged out of the main chain. Close the channel.
6040 failed_channels.push(channel.force_shutdown(true));
6041 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
6042 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6046 let reason_message = format!("{}", reason);
6047 self.issue_channel_close_events(channel, reason);
6048 pending_msg_events.push(events::MessageSendEvent::HandleError {
6049 node_id: channel.get_counterparty_node_id(),
6050 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
6051 channel_id: channel.channel_id(),
6052 data: reason_message,
6062 if let Some(height) = height_opt {
6063 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
6064 htlcs.retain(|htlc| {
6065 // If height is approaching the number of blocks we think it takes us to get
6066 // our commitment transaction confirmed before the HTLC expires, plus the
6067 // number of blocks we generally consider it to take to do a commitment update,
6068 // just give up on it and fail the HTLC.
6069 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
6070 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
6071 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
6073 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
6074 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
6075 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
6079 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
6082 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
6083 intercepted_htlcs.retain(|_, htlc| {
6084 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
6085 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6086 short_channel_id: htlc.prev_short_channel_id,
6087 htlc_id: htlc.prev_htlc_id,
6088 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
6089 phantom_shared_secret: None,
6090 outpoint: htlc.prev_funding_outpoint,
6093 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
6094 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6095 _ => unreachable!(),
6097 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
6098 HTLCFailReason::from_failure_code(0x2000 | 2),
6099 HTLCDestination::InvalidForward { requested_forward_scid }));
6100 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
6106 self.handle_init_event_channel_failures(failed_channels);
6108 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6109 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
6113 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
6114 /// indicating whether persistence is necessary. Only one listener on
6115 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
6116 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6118 /// Note that this method is not available with the `no-std` feature.
6120 /// [`await_persistable_update`]: Self::await_persistable_update
6121 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
6122 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6123 #[cfg(any(test, feature = "std"))]
6124 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
6125 self.persistence_notifier.wait_timeout(max_wait)
6128 /// Blocks until ChannelManager needs to be persisted. Only one listener on
6129 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
6130 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6132 /// [`await_persistable_update`]: Self::await_persistable_update
6133 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6134 pub fn await_persistable_update(&self) {
6135 self.persistence_notifier.wait()
6138 /// Gets a [`Future`] that completes when a persistable update is available. Note that
6139 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
6140 /// should instead register actions to be taken later.
6141 pub fn get_persistable_update_future(&self) -> Future {
6142 self.persistence_notifier.get_future()
6145 #[cfg(any(test, feature = "_test_utils"))]
6146 pub fn get_persistence_condvar_value(&self) -> bool {
6147 self.persistence_notifier.notify_pending()
6150 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6151 /// [`chain::Confirm`] interfaces.
6152 pub fn current_best_block(&self) -> BestBlock {
6153 self.best_block.read().unwrap().clone()
6156 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6157 /// [`ChannelManager`].
6158 pub fn node_features(&self) -> NodeFeatures {
6159 provided_node_features(&self.default_configuration)
6162 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6163 /// [`ChannelManager`].
6165 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6166 /// or not. Thus, this method is not public.
6167 #[cfg(any(feature = "_test_utils", test))]
6168 pub fn invoice_features(&self) -> InvoiceFeatures {
6169 provided_invoice_features(&self.default_configuration)
6172 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6173 /// [`ChannelManager`].
6174 pub fn channel_features(&self) -> ChannelFeatures {
6175 provided_channel_features(&self.default_configuration)
6178 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6179 /// [`ChannelManager`].
6180 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
6181 provided_channel_type_features(&self.default_configuration)
6184 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6185 /// [`ChannelManager`].
6186 pub fn init_features(&self) -> InitFeatures {
6187 provided_init_features(&self.default_configuration)
6191 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
6192 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
6194 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6195 T::Target: BroadcasterInterface,
6196 ES::Target: EntropySource,
6197 NS::Target: NodeSigner,
6198 SP::Target: SignerProvider,
6199 F::Target: FeeEstimator,
6203 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
6204 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6205 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
6208 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
6209 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6210 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
6213 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6214 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6215 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6218 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6219 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6220 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6223 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6224 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6225 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6228 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
6229 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6230 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
6233 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6234 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6235 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6238 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6239 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6240 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6243 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6244 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6245 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6248 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6249 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6250 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6253 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6254 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6255 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6258 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6259 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6260 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6263 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6264 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6265 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6268 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6269 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6270 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6273 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6274 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6275 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6278 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6279 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6280 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6283 NotifyOption::SkipPersist
6288 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6289 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6290 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6293 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
6294 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6295 let mut failed_channels = Vec::new();
6296 let mut per_peer_state = self.per_peer_state.write().unwrap();
6298 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
6299 log_pubkey!(counterparty_node_id));
6300 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
6301 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6302 let peer_state = &mut *peer_state_lock;
6303 let pending_msg_events = &mut peer_state.pending_msg_events;
6304 peer_state.channel_by_id.retain(|_, chan| {
6305 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6306 if chan.is_shutdown() {
6307 update_maps_on_chan_removal!(self, chan);
6308 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6313 pending_msg_events.retain(|msg| {
6315 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
6316 &events::MessageSendEvent::SendOpenChannel { .. } => false,
6317 &events::MessageSendEvent::SendFundingCreated { .. } => false,
6318 &events::MessageSendEvent::SendFundingSigned { .. } => false,
6319 &events::MessageSendEvent::SendChannelReady { .. } => false,
6320 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
6321 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
6322 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
6323 &events::MessageSendEvent::SendClosingSigned { .. } => false,
6324 &events::MessageSendEvent::SendShutdown { .. } => false,
6325 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
6326 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
6327 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6328 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6329 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
6330 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
6331 &events::MessageSendEvent::HandleError { .. } => false,
6332 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6333 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6334 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6335 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6338 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
6339 peer_state.is_connected = false;
6340 peer_state.ok_to_remove(true)
6341 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
6344 per_peer_state.remove(counterparty_node_id);
6346 mem::drop(per_peer_state);
6348 for failure in failed_channels.drain(..) {
6349 self.finish_force_close_channel(failure);
6353 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
6354 if !init_msg.features.supports_static_remote_key() {
6355 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
6359 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6361 // If we have too many peers connected which don't have funded channels, disconnect the
6362 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
6363 // unfunded channels taking up space in memory for disconnected peers, we still let new
6364 // peers connect, but we'll reject new channels from them.
6365 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
6366 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
6369 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6370 match peer_state_lock.entry(counterparty_node_id.clone()) {
6371 hash_map::Entry::Vacant(e) => {
6372 if inbound_peer_limited {
6375 e.insert(Mutex::new(PeerState {
6376 channel_by_id: HashMap::new(),
6377 latest_features: init_msg.features.clone(),
6378 pending_msg_events: Vec::new(),
6379 monitor_update_blocked_actions: BTreeMap::new(),
6383 hash_map::Entry::Occupied(e) => {
6384 let mut peer_state = e.get().lock().unwrap();
6385 peer_state.latest_features = init_msg.features.clone();
6387 let best_block_height = self.best_block.read().unwrap().height();
6388 if inbound_peer_limited &&
6389 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
6390 peer_state.channel_by_id.len()
6395 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
6396 peer_state.is_connected = true;
6401 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6403 let per_peer_state = self.per_peer_state.read().unwrap();
6404 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6405 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6406 let peer_state = &mut *peer_state_lock;
6407 let pending_msg_events = &mut peer_state.pending_msg_events;
6408 peer_state.channel_by_id.retain(|_, chan| {
6409 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6410 if !chan.have_received_message() {
6411 // If we created this (outbound) channel while we were disconnected from the
6412 // peer we probably failed to send the open_channel message, which is now
6413 // lost. We can't have had anything pending related to this channel, so we just
6417 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6418 node_id: chan.get_counterparty_node_id(),
6419 msg: chan.get_channel_reestablish(&self.logger),
6424 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6425 if let Some(msg) = chan.get_signed_channel_announcement(&self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(), &self.default_configuration) {
6426 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6427 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6428 node_id: *counterparty_node_id,
6437 //TODO: Also re-broadcast announcement_signatures
6441 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6442 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6444 if msg.channel_id == [0; 32] {
6445 let channel_ids: Vec<[u8; 32]> = {
6446 let per_peer_state = self.per_peer_state.read().unwrap();
6447 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6448 if peer_state_mutex_opt.is_none() { return; }
6449 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6450 let peer_state = &mut *peer_state_lock;
6451 peer_state.channel_by_id.keys().cloned().collect()
6453 for channel_id in channel_ids {
6454 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6455 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
6459 // First check if we can advance the channel type and try again.
6460 let per_peer_state = self.per_peer_state.read().unwrap();
6461 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6462 if peer_state_mutex_opt.is_none() { return; }
6463 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6464 let peer_state = &mut *peer_state_lock;
6465 if let Some(chan) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
6466 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6467 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6468 node_id: *counterparty_node_id,
6476 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6477 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6481 fn provided_node_features(&self) -> NodeFeatures {
6482 provided_node_features(&self.default_configuration)
6485 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6486 provided_init_features(&self.default_configuration)
6490 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6491 /// [`ChannelManager`].
6492 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
6493 provided_init_features(config).to_context()
6496 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6497 /// [`ChannelManager`].
6499 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6500 /// or not. Thus, this method is not public.
6501 #[cfg(any(feature = "_test_utils", test))]
6502 pub(crate) fn provided_invoice_features(config: &UserConfig) -> InvoiceFeatures {
6503 provided_init_features(config).to_context()
6506 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6507 /// [`ChannelManager`].
6508 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
6509 provided_init_features(config).to_context()
6512 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6513 /// [`ChannelManager`].
6514 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
6515 ChannelTypeFeatures::from_init(&provided_init_features(config))
6518 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6519 /// [`ChannelManager`].
6520 pub fn provided_init_features(_config: &UserConfig) -> InitFeatures {
6521 // Note that if new features are added here which other peers may (eventually) require, we
6522 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
6523 // [`ErroringMessageHandler`].
6524 let mut features = InitFeatures::empty();
6525 features.set_data_loss_protect_optional();
6526 features.set_upfront_shutdown_script_optional();
6527 features.set_variable_length_onion_required();
6528 features.set_static_remote_key_required();
6529 features.set_payment_secret_required();
6530 features.set_basic_mpp_optional();
6531 features.set_wumbo_optional();
6532 features.set_shutdown_any_segwit_optional();
6533 features.set_channel_type_optional();
6534 features.set_scid_privacy_optional();
6535 features.set_zero_conf_optional();
6537 { // Attributes are not allowed on if expressions on our current MSRV of 1.41.
6538 if _config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
6539 features.set_anchors_zero_fee_htlc_tx_optional();
6545 const SERIALIZATION_VERSION: u8 = 1;
6546 const MIN_SERIALIZATION_VERSION: u8 = 1;
6548 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6549 (2, fee_base_msat, required),
6550 (4, fee_proportional_millionths, required),
6551 (6, cltv_expiry_delta, required),
6554 impl_writeable_tlv_based!(ChannelCounterparty, {
6555 (2, node_id, required),
6556 (4, features, required),
6557 (6, unspendable_punishment_reserve, required),
6558 (8, forwarding_info, option),
6559 (9, outbound_htlc_minimum_msat, option),
6560 (11, outbound_htlc_maximum_msat, option),
6563 impl Writeable for ChannelDetails {
6564 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6565 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6566 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6567 let user_channel_id_low = self.user_channel_id as u64;
6568 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6569 write_tlv_fields!(writer, {
6570 (1, self.inbound_scid_alias, option),
6571 (2, self.channel_id, required),
6572 (3, self.channel_type, option),
6573 (4, self.counterparty, required),
6574 (5, self.outbound_scid_alias, option),
6575 (6, self.funding_txo, option),
6576 (7, self.config, option),
6577 (8, self.short_channel_id, option),
6578 (9, self.confirmations, option),
6579 (10, self.channel_value_satoshis, required),
6580 (12, self.unspendable_punishment_reserve, option),
6581 (14, user_channel_id_low, required),
6582 (16, self.balance_msat, required),
6583 (18, self.outbound_capacity_msat, required),
6584 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6585 // filled in, so we can safely unwrap it here.
6586 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6587 (20, self.inbound_capacity_msat, required),
6588 (22, self.confirmations_required, option),
6589 (24, self.force_close_spend_delay, option),
6590 (26, self.is_outbound, required),
6591 (28, self.is_channel_ready, required),
6592 (30, self.is_usable, required),
6593 (32, self.is_public, required),
6594 (33, self.inbound_htlc_minimum_msat, option),
6595 (35, self.inbound_htlc_maximum_msat, option),
6596 (37, user_channel_id_high_opt, option),
6597 (39, self.feerate_sat_per_1000_weight, option),
6603 impl Readable for ChannelDetails {
6604 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6605 _init_and_read_tlv_fields!(reader, {
6606 (1, inbound_scid_alias, option),
6607 (2, channel_id, required),
6608 (3, channel_type, option),
6609 (4, counterparty, required),
6610 (5, outbound_scid_alias, option),
6611 (6, funding_txo, option),
6612 (7, config, option),
6613 (8, short_channel_id, option),
6614 (9, confirmations, option),
6615 (10, channel_value_satoshis, required),
6616 (12, unspendable_punishment_reserve, option),
6617 (14, user_channel_id_low, required),
6618 (16, balance_msat, required),
6619 (18, outbound_capacity_msat, required),
6620 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6621 // filled in, so we can safely unwrap it here.
6622 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6623 (20, inbound_capacity_msat, required),
6624 (22, confirmations_required, option),
6625 (24, force_close_spend_delay, option),
6626 (26, is_outbound, required),
6627 (28, is_channel_ready, required),
6628 (30, is_usable, required),
6629 (32, is_public, required),
6630 (33, inbound_htlc_minimum_msat, option),
6631 (35, inbound_htlc_maximum_msat, option),
6632 (37, user_channel_id_high_opt, option),
6633 (39, feerate_sat_per_1000_weight, option),
6636 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6637 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6638 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6639 let user_channel_id = user_channel_id_low as u128 +
6640 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6644 channel_id: channel_id.0.unwrap(),
6646 counterparty: counterparty.0.unwrap(),
6647 outbound_scid_alias,
6651 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6652 unspendable_punishment_reserve,
6654 balance_msat: balance_msat.0.unwrap(),
6655 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6656 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6657 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6658 confirmations_required,
6660 force_close_spend_delay,
6661 is_outbound: is_outbound.0.unwrap(),
6662 is_channel_ready: is_channel_ready.0.unwrap(),
6663 is_usable: is_usable.0.unwrap(),
6664 is_public: is_public.0.unwrap(),
6665 inbound_htlc_minimum_msat,
6666 inbound_htlc_maximum_msat,
6667 feerate_sat_per_1000_weight,
6672 impl_writeable_tlv_based!(PhantomRouteHints, {
6673 (2, channels, vec_type),
6674 (4, phantom_scid, required),
6675 (6, real_node_pubkey, required),
6678 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6680 (0, onion_packet, required),
6681 (2, short_channel_id, required),
6684 (0, payment_data, required),
6685 (1, phantom_shared_secret, option),
6686 (2, incoming_cltv_expiry, required),
6688 (2, ReceiveKeysend) => {
6689 (0, payment_preimage, required),
6690 (2, incoming_cltv_expiry, required),
6694 impl_writeable_tlv_based!(PendingHTLCInfo, {
6695 (0, routing, required),
6696 (2, incoming_shared_secret, required),
6697 (4, payment_hash, required),
6698 (6, outgoing_amt_msat, required),
6699 (8, outgoing_cltv_value, required),
6700 (9, incoming_amt_msat, option),
6704 impl Writeable for HTLCFailureMsg {
6705 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6707 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6709 channel_id.write(writer)?;
6710 htlc_id.write(writer)?;
6711 reason.write(writer)?;
6713 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6714 channel_id, htlc_id, sha256_of_onion, failure_code
6717 channel_id.write(writer)?;
6718 htlc_id.write(writer)?;
6719 sha256_of_onion.write(writer)?;
6720 failure_code.write(writer)?;
6727 impl Readable for HTLCFailureMsg {
6728 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6729 let id: u8 = Readable::read(reader)?;
6732 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6733 channel_id: Readable::read(reader)?,
6734 htlc_id: Readable::read(reader)?,
6735 reason: Readable::read(reader)?,
6739 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6740 channel_id: Readable::read(reader)?,
6741 htlc_id: Readable::read(reader)?,
6742 sha256_of_onion: Readable::read(reader)?,
6743 failure_code: Readable::read(reader)?,
6746 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6747 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6748 // messages contained in the variants.
6749 // In version 0.0.101, support for reading the variants with these types was added, and
6750 // we should migrate to writing these variants when UpdateFailHTLC or
6751 // UpdateFailMalformedHTLC get TLV fields.
6753 let length: BigSize = Readable::read(reader)?;
6754 let mut s = FixedLengthReader::new(reader, length.0);
6755 let res = Readable::read(&mut s)?;
6756 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6757 Ok(HTLCFailureMsg::Relay(res))
6760 let length: BigSize = Readable::read(reader)?;
6761 let mut s = FixedLengthReader::new(reader, length.0);
6762 let res = Readable::read(&mut s)?;
6763 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6764 Ok(HTLCFailureMsg::Malformed(res))
6766 _ => Err(DecodeError::UnknownRequiredFeature),
6771 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6776 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6777 (0, short_channel_id, required),
6778 (1, phantom_shared_secret, option),
6779 (2, outpoint, required),
6780 (4, htlc_id, required),
6781 (6, incoming_packet_shared_secret, required)
6784 impl Writeable for ClaimableHTLC {
6785 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6786 let (payment_data, keysend_preimage) = match &self.onion_payload {
6787 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6788 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6790 write_tlv_fields!(writer, {
6791 (0, self.prev_hop, required),
6792 (1, self.total_msat, required),
6793 (2, self.value, required),
6794 (4, payment_data, option),
6795 (6, self.cltv_expiry, required),
6796 (8, keysend_preimage, option),
6802 impl Readable for ClaimableHTLC {
6803 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6804 let mut prev_hop = crate::util::ser::RequiredWrapper(None);
6806 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6807 let mut cltv_expiry = 0;
6808 let mut total_msat = None;
6809 let mut keysend_preimage: Option<PaymentPreimage> = None;
6810 read_tlv_fields!(reader, {
6811 (0, prev_hop, required),
6812 (1, total_msat, option),
6813 (2, value, required),
6814 (4, payment_data, option),
6815 (6, cltv_expiry, required),
6816 (8, keysend_preimage, option)
6818 let onion_payload = match keysend_preimage {
6820 if payment_data.is_some() {
6821 return Err(DecodeError::InvalidValue)
6823 if total_msat.is_none() {
6824 total_msat = Some(value);
6826 OnionPayload::Spontaneous(p)
6829 if total_msat.is_none() {
6830 if payment_data.is_none() {
6831 return Err(DecodeError::InvalidValue)
6833 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6835 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6839 prev_hop: prev_hop.0.unwrap(),
6842 total_msat: total_msat.unwrap(),
6849 impl Readable for HTLCSource {
6850 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6851 let id: u8 = Readable::read(reader)?;
6854 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
6855 let mut first_hop_htlc_msat: u64 = 0;
6856 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
6857 let mut payment_id = None;
6858 let mut payment_secret = None;
6859 let mut payment_params: Option<PaymentParameters> = None;
6860 read_tlv_fields!(reader, {
6861 (0, session_priv, required),
6862 (1, payment_id, option),
6863 (2, first_hop_htlc_msat, required),
6864 (3, payment_secret, option),
6865 (4, path, vec_type),
6866 (5, payment_params, (option: ReadableArgs, 0)),
6868 if payment_id.is_none() {
6869 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6871 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6873 if path.is_none() || path.as_ref().unwrap().is_empty() {
6874 return Err(DecodeError::InvalidValue);
6876 let path = path.unwrap();
6877 if let Some(params) = payment_params.as_mut() {
6878 if params.final_cltv_expiry_delta == 0 {
6879 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
6882 Ok(HTLCSource::OutboundRoute {
6883 session_priv: session_priv.0.unwrap(),
6884 first_hop_htlc_msat,
6886 payment_id: payment_id.unwrap(),
6890 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6891 _ => Err(DecodeError::UnknownRequiredFeature),
6896 impl Writeable for HTLCSource {
6897 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6899 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret } => {
6901 let payment_id_opt = Some(payment_id);
6902 write_tlv_fields!(writer, {
6903 (0, session_priv, required),
6904 (1, payment_id_opt, option),
6905 (2, first_hop_htlc_msat, required),
6906 (3, payment_secret, option),
6907 (4, *path, vec_type),
6908 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
6911 HTLCSource::PreviousHopData(ref field) => {
6913 field.write(writer)?;
6920 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
6921 (0, forward_info, required),
6922 (1, prev_user_channel_id, (default_value, 0)),
6923 (2, prev_short_channel_id, required),
6924 (4, prev_htlc_id, required),
6925 (6, prev_funding_outpoint, required),
6928 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6930 (0, htlc_id, required),
6931 (2, err_packet, required),
6936 impl_writeable_tlv_based!(PendingInboundPayment, {
6937 (0, payment_secret, required),
6938 (2, expiry_time, required),
6939 (4, user_payment_id, required),
6940 (6, payment_preimage, required),
6941 (8, min_value_msat, required),
6944 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> Writeable for ChannelManager<M, T, ES, NS, SP, F, R, L>
6946 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6947 T::Target: BroadcasterInterface,
6948 ES::Target: EntropySource,
6949 NS::Target: NodeSigner,
6950 SP::Target: SignerProvider,
6951 F::Target: FeeEstimator,
6955 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6956 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6958 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6960 self.genesis_hash.write(writer)?;
6962 let best_block = self.best_block.read().unwrap();
6963 best_block.height().write(writer)?;
6964 best_block.block_hash().write(writer)?;
6967 let mut serializable_peer_count: u64 = 0;
6969 let per_peer_state = self.per_peer_state.read().unwrap();
6970 let mut unfunded_channels = 0;
6971 let mut number_of_channels = 0;
6972 for (_, peer_state_mutex) in per_peer_state.iter() {
6973 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6974 let peer_state = &mut *peer_state_lock;
6975 if !peer_state.ok_to_remove(false) {
6976 serializable_peer_count += 1;
6978 number_of_channels += peer_state.channel_by_id.len();
6979 for (_, channel) in peer_state.channel_by_id.iter() {
6980 if !channel.is_funding_initiated() {
6981 unfunded_channels += 1;
6986 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
6988 for (_, peer_state_mutex) in per_peer_state.iter() {
6989 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6990 let peer_state = &mut *peer_state_lock;
6991 for (_, channel) in peer_state.channel_by_id.iter() {
6992 if channel.is_funding_initiated() {
6993 channel.write(writer)?;
7000 let forward_htlcs = self.forward_htlcs.lock().unwrap();
7001 (forward_htlcs.len() as u64).write(writer)?;
7002 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
7003 short_channel_id.write(writer)?;
7004 (pending_forwards.len() as u64).write(writer)?;
7005 for forward in pending_forwards {
7006 forward.write(writer)?;
7011 let per_peer_state = self.per_peer_state.write().unwrap();
7013 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
7014 let claimable_payments = self.claimable_payments.lock().unwrap();
7015 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
7017 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
7018 (claimable_payments.claimable_htlcs.len() as u64).write(writer)?;
7019 for (payment_hash, (purpose, previous_hops)) in claimable_payments.claimable_htlcs.iter() {
7020 payment_hash.write(writer)?;
7021 (previous_hops.len() as u64).write(writer)?;
7022 for htlc in previous_hops.iter() {
7023 htlc.write(writer)?;
7025 htlc_purposes.push(purpose);
7028 let mut monitor_update_blocked_actions_per_peer = None;
7029 let mut peer_states = Vec::new();
7030 for (_, peer_state_mutex) in per_peer_state.iter() {
7031 // Because we're holding the owning `per_peer_state` write lock here there's no chance
7032 // of a lockorder violation deadlock - no other thread can be holding any
7033 // per_peer_state lock at all.
7034 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
7037 (serializable_peer_count).write(writer)?;
7038 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
7039 // Peers which we have no channels to should be dropped once disconnected. As we
7040 // disconnect all peers when shutting down and serializing the ChannelManager, we
7041 // consider all peers as disconnected here. There's therefore no need write peers with
7043 if !peer_state.ok_to_remove(false) {
7044 peer_pubkey.write(writer)?;
7045 peer_state.latest_features.write(writer)?;
7046 if !peer_state.monitor_update_blocked_actions.is_empty() {
7047 monitor_update_blocked_actions_per_peer
7048 .get_or_insert_with(Vec::new)
7049 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
7054 let events = self.pending_events.lock().unwrap();
7055 (events.len() as u64).write(writer)?;
7056 for event in events.iter() {
7057 event.write(writer)?;
7060 let background_events = self.pending_background_events.lock().unwrap();
7061 (background_events.len() as u64).write(writer)?;
7062 for event in background_events.iter() {
7064 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
7066 funding_txo.write(writer)?;
7067 monitor_update.write(writer)?;
7072 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
7073 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
7074 // likely to be identical.
7075 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7076 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7078 (pending_inbound_payments.len() as u64).write(writer)?;
7079 for (hash, pending_payment) in pending_inbound_payments.iter() {
7080 hash.write(writer)?;
7081 pending_payment.write(writer)?;
7084 // For backwards compat, write the session privs and their total length.
7085 let mut num_pending_outbounds_compat: u64 = 0;
7086 for (_, outbound) in pending_outbound_payments.iter() {
7087 if !outbound.is_fulfilled() && !outbound.abandoned() {
7088 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
7091 num_pending_outbounds_compat.write(writer)?;
7092 for (_, outbound) in pending_outbound_payments.iter() {
7094 PendingOutboundPayment::Legacy { session_privs } |
7095 PendingOutboundPayment::Retryable { session_privs, .. } => {
7096 for session_priv in session_privs.iter() {
7097 session_priv.write(writer)?;
7100 PendingOutboundPayment::Fulfilled { .. } => {},
7101 PendingOutboundPayment::Abandoned { .. } => {},
7105 // Encode without retry info for 0.0.101 compatibility.
7106 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
7107 for (id, outbound) in pending_outbound_payments.iter() {
7109 PendingOutboundPayment::Legacy { session_privs } |
7110 PendingOutboundPayment::Retryable { session_privs, .. } => {
7111 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
7117 let mut pending_intercepted_htlcs = None;
7118 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
7119 if our_pending_intercepts.len() != 0 {
7120 pending_intercepted_htlcs = Some(our_pending_intercepts);
7123 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
7124 if pending_claiming_payments.as_ref().unwrap().is_empty() {
7125 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
7126 // map. Thus, if there are no entries we skip writing a TLV for it.
7127 pending_claiming_payments = None;
7130 write_tlv_fields!(writer, {
7131 (1, pending_outbound_payments_no_retry, required),
7132 (2, pending_intercepted_htlcs, option),
7133 (3, pending_outbound_payments, required),
7134 (4, pending_claiming_payments, option),
7135 (5, self.our_network_pubkey, required),
7136 (6, monitor_update_blocked_actions_per_peer, option),
7137 (7, self.fake_scid_rand_bytes, required),
7138 (9, htlc_purposes, vec_type),
7139 (11, self.probing_cookie_secret, required),
7146 /// Arguments for the creation of a ChannelManager that are not deserialized.
7148 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
7150 /// 1) Deserialize all stored [`ChannelMonitor`]s.
7151 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
7152 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
7153 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
7154 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
7155 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
7156 /// same way you would handle a [`chain::Filter`] call using
7157 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
7158 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
7159 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
7160 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
7161 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
7162 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
7164 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
7165 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
7167 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
7168 /// call any other methods on the newly-deserialized [`ChannelManager`].
7170 /// Note that because some channels may be closed during deserialization, it is critical that you
7171 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
7172 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
7173 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
7174 /// not force-close the same channels but consider them live), you may end up revoking a state for
7175 /// which you've already broadcasted the transaction.
7177 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
7178 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7180 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7181 T::Target: BroadcasterInterface,
7182 ES::Target: EntropySource,
7183 NS::Target: NodeSigner,
7184 SP::Target: SignerProvider,
7185 F::Target: FeeEstimator,
7189 /// A cryptographically secure source of entropy.
7190 pub entropy_source: ES,
7192 /// A signer that is able to perform node-scoped cryptographic operations.
7193 pub node_signer: NS,
7195 /// The keys provider which will give us relevant keys. Some keys will be loaded during
7196 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
7198 pub signer_provider: SP,
7200 /// The fee_estimator for use in the ChannelManager in the future.
7202 /// No calls to the FeeEstimator will be made during deserialization.
7203 pub fee_estimator: F,
7204 /// The chain::Watch for use in the ChannelManager in the future.
7206 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
7207 /// you have deserialized ChannelMonitors separately and will add them to your
7208 /// chain::Watch after deserializing this ChannelManager.
7209 pub chain_monitor: M,
7211 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
7212 /// used to broadcast the latest local commitment transactions of channels which must be
7213 /// force-closed during deserialization.
7214 pub tx_broadcaster: T,
7215 /// The router which will be used in the ChannelManager in the future for finding routes
7216 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
7218 /// No calls to the router will be made during deserialization.
7220 /// The Logger for use in the ChannelManager and which may be used to log information during
7221 /// deserialization.
7223 /// Default settings used for new channels. Any existing channels will continue to use the
7224 /// runtime settings which were stored when the ChannelManager was serialized.
7225 pub default_config: UserConfig,
7227 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
7228 /// value.get_funding_txo() should be the key).
7230 /// If a monitor is inconsistent with the channel state during deserialization the channel will
7231 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
7232 /// is true for missing channels as well. If there is a monitor missing for which we find
7233 /// channel data Err(DecodeError::InvalidValue) will be returned.
7235 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
7238 /// (C-not exported) because we have no HashMap bindings
7239 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
7242 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7243 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
7245 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7246 T::Target: BroadcasterInterface,
7247 ES::Target: EntropySource,
7248 NS::Target: NodeSigner,
7249 SP::Target: SignerProvider,
7250 F::Target: FeeEstimator,
7254 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
7255 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
7256 /// populate a HashMap directly from C.
7257 pub fn new(entropy_source: ES, node_signer: NS, signer_provider: SP, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, default_config: UserConfig,
7258 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
7260 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
7261 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
7266 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
7267 // SipmleArcChannelManager type:
7268 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7269 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
7271 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7272 T::Target: BroadcasterInterface,
7273 ES::Target: EntropySource,
7274 NS::Target: NodeSigner,
7275 SP::Target: SignerProvider,
7276 F::Target: FeeEstimator,
7280 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
7281 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
7282 Ok((blockhash, Arc::new(chan_manager)))
7286 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7287 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
7289 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7290 T::Target: BroadcasterInterface,
7291 ES::Target: EntropySource,
7292 NS::Target: NodeSigner,
7293 SP::Target: SignerProvider,
7294 F::Target: FeeEstimator,
7298 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
7299 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
7301 let genesis_hash: BlockHash = Readable::read(reader)?;
7302 let best_block_height: u32 = Readable::read(reader)?;
7303 let best_block_hash: BlockHash = Readable::read(reader)?;
7305 let mut failed_htlcs = Vec::new();
7307 let channel_count: u64 = Readable::read(reader)?;
7308 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
7309 let mut peer_channels: HashMap<PublicKey, HashMap<[u8; 32], Channel<<SP::Target as SignerProvider>::Signer>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7310 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7311 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7312 let mut channel_closures = Vec::new();
7313 let mut pending_background_events = Vec::new();
7314 for _ in 0..channel_count {
7315 let mut channel: Channel<<SP::Target as SignerProvider>::Signer> = Channel::read(reader, (
7316 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
7318 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
7319 funding_txo_set.insert(funding_txo.clone());
7320 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
7321 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
7322 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
7323 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
7324 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7325 // If the channel is ahead of the monitor, return InvalidValue:
7326 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7327 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7328 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7329 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7330 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7331 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7332 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");
7333 return Err(DecodeError::InvalidValue);
7334 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7335 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7336 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7337 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7338 // But if the channel is behind of the monitor, close the channel:
7339 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7340 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7341 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7342 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7343 let (monitor_update, mut new_failed_htlcs) = channel.force_shutdown(true);
7344 if let Some(monitor_update) = monitor_update {
7345 pending_background_events.push(BackgroundEvent::ClosingMonitorUpdate(monitor_update));
7347 failed_htlcs.append(&mut new_failed_htlcs);
7348 channel_closures.push(events::Event::ChannelClosed {
7349 channel_id: channel.channel_id(),
7350 user_channel_id: channel.get_user_id(),
7351 reason: ClosureReason::OutdatedChannelManager
7353 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
7354 let mut found_htlc = false;
7355 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
7356 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
7359 // If we have some HTLCs in the channel which are not present in the newer
7360 // ChannelMonitor, they have been removed and should be failed back to
7361 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
7362 // were actually claimed we'd have generated and ensured the previous-hop
7363 // claim update ChannelMonitor updates were persisted prior to persising
7364 // the ChannelMonitor update for the forward leg, so attempting to fail the
7365 // backwards leg of the HTLC will simply be rejected.
7366 log_info!(args.logger,
7367 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
7368 log_bytes!(channel.channel_id()), log_bytes!(payment_hash.0));
7369 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.get_counterparty_node_id(), channel.channel_id()));
7373 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7374 if let Some(short_channel_id) = channel.get_short_channel_id() {
7375 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7377 if channel.is_funding_initiated() {
7378 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7380 match peer_channels.entry(channel.get_counterparty_node_id()) {
7381 hash_map::Entry::Occupied(mut entry) => {
7382 let by_id_map = entry.get_mut();
7383 by_id_map.insert(channel.channel_id(), channel);
7385 hash_map::Entry::Vacant(entry) => {
7386 let mut by_id_map = HashMap::new();
7387 by_id_map.insert(channel.channel_id(), channel);
7388 entry.insert(by_id_map);
7392 } else if channel.is_awaiting_initial_mon_persist() {
7393 // If we were persisted and shut down while the initial ChannelMonitor persistence
7394 // was in-progress, we never broadcasted the funding transaction and can still
7395 // safely discard the channel.
7396 let _ = channel.force_shutdown(false);
7397 channel_closures.push(events::Event::ChannelClosed {
7398 channel_id: channel.channel_id(),
7399 user_channel_id: channel.get_user_id(),
7400 reason: ClosureReason::DisconnectedPeer,
7403 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7404 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7405 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7406 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7407 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");
7408 return Err(DecodeError::InvalidValue);
7412 for (funding_txo, _) in args.channel_monitors.iter() {
7413 if !funding_txo_set.contains(funding_txo) {
7414 let monitor_update = ChannelMonitorUpdate {
7415 update_id: CLOSED_CHANNEL_UPDATE_ID,
7416 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
7418 pending_background_events.push(BackgroundEvent::ClosingMonitorUpdate((*funding_txo, monitor_update)));
7422 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7423 let forward_htlcs_count: u64 = Readable::read(reader)?;
7424 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7425 for _ in 0..forward_htlcs_count {
7426 let short_channel_id = Readable::read(reader)?;
7427 let pending_forwards_count: u64 = Readable::read(reader)?;
7428 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7429 for _ in 0..pending_forwards_count {
7430 pending_forwards.push(Readable::read(reader)?);
7432 forward_htlcs.insert(short_channel_id, pending_forwards);
7435 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7436 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7437 for _ in 0..claimable_htlcs_count {
7438 let payment_hash = Readable::read(reader)?;
7439 let previous_hops_len: u64 = Readable::read(reader)?;
7440 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7441 for _ in 0..previous_hops_len {
7442 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7444 claimable_htlcs_list.push((payment_hash, previous_hops));
7447 let peer_count: u64 = Readable::read(reader)?;
7448 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>)>()));
7449 for _ in 0..peer_count {
7450 let peer_pubkey = Readable::read(reader)?;
7451 let peer_state = PeerState {
7452 channel_by_id: peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new()),
7453 latest_features: Readable::read(reader)?,
7454 pending_msg_events: Vec::new(),
7455 monitor_update_blocked_actions: BTreeMap::new(),
7456 is_connected: false,
7458 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7461 let event_count: u64 = Readable::read(reader)?;
7462 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>()));
7463 for _ in 0..event_count {
7464 match MaybeReadable::read(reader)? {
7465 Some(event) => pending_events_read.push(event),
7470 let background_event_count: u64 = Readable::read(reader)?;
7471 for _ in 0..background_event_count {
7472 match <u8 as Readable>::read(reader)? {
7474 let (funding_txo, monitor_update): (OutPoint, ChannelMonitorUpdate) = (Readable::read(reader)?, Readable::read(reader)?);
7475 if pending_background_events.iter().find(|e| {
7476 let BackgroundEvent::ClosingMonitorUpdate((pending_funding_txo, pending_monitor_update)) = e;
7477 *pending_funding_txo == funding_txo && *pending_monitor_update == monitor_update
7479 pending_background_events.push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)));
7482 _ => return Err(DecodeError::InvalidValue),
7486 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7487 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7489 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7490 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7491 for _ in 0..pending_inbound_payment_count {
7492 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7493 return Err(DecodeError::InvalidValue);
7497 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7498 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7499 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7500 for _ in 0..pending_outbound_payments_count_compat {
7501 let session_priv = Readable::read(reader)?;
7502 let payment = PendingOutboundPayment::Legacy {
7503 session_privs: [session_priv].iter().cloned().collect()
7505 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7506 return Err(DecodeError::InvalidValue)
7510 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7511 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7512 let mut pending_outbound_payments = None;
7513 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
7514 let mut received_network_pubkey: Option<PublicKey> = None;
7515 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7516 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7517 let mut claimable_htlc_purposes = None;
7518 let mut pending_claiming_payments = Some(HashMap::new());
7519 let mut monitor_update_blocked_actions_per_peer = Some(Vec::new());
7520 read_tlv_fields!(reader, {
7521 (1, pending_outbound_payments_no_retry, option),
7522 (2, pending_intercepted_htlcs, option),
7523 (3, pending_outbound_payments, option),
7524 (4, pending_claiming_payments, option),
7525 (5, received_network_pubkey, option),
7526 (6, monitor_update_blocked_actions_per_peer, option),
7527 (7, fake_scid_rand_bytes, option),
7528 (9, claimable_htlc_purposes, vec_type),
7529 (11, probing_cookie_secret, option),
7531 if fake_scid_rand_bytes.is_none() {
7532 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
7535 if probing_cookie_secret.is_none() {
7536 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
7539 if !channel_closures.is_empty() {
7540 pending_events_read.append(&mut channel_closures);
7543 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7544 pending_outbound_payments = Some(pending_outbound_payments_compat);
7545 } else if pending_outbound_payments.is_none() {
7546 let mut outbounds = HashMap::new();
7547 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7548 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7550 pending_outbound_payments = Some(outbounds);
7552 let pending_outbounds = OutboundPayments {
7553 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7554 retry_lock: Mutex::new(())
7558 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7559 // ChannelMonitor data for any channels for which we do not have authorative state
7560 // (i.e. those for which we just force-closed above or we otherwise don't have a
7561 // corresponding `Channel` at all).
7562 // This avoids several edge-cases where we would otherwise "forget" about pending
7563 // payments which are still in-flight via their on-chain state.
7564 // We only rebuild the pending payments map if we were most recently serialized by
7566 for (_, monitor) in args.channel_monitors.iter() {
7567 if id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7568 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
7569 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7570 if path.is_empty() {
7571 log_error!(args.logger, "Got an empty path for a pending payment");
7572 return Err(DecodeError::InvalidValue);
7575 let path_amt = path.last().unwrap().fee_msat;
7576 let mut session_priv_bytes = [0; 32];
7577 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7578 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
7579 hash_map::Entry::Occupied(mut entry) => {
7580 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7581 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7582 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7584 hash_map::Entry::Vacant(entry) => {
7585 let path_fee = path.get_path_fees();
7586 entry.insert(PendingOutboundPayment::Retryable {
7587 retry_strategy: None,
7588 attempts: PaymentAttempts::new(),
7589 payment_params: None,
7590 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7591 payment_hash: htlc.payment_hash,
7593 keysend_preimage: None, // only used for retries, and we'll never retry on startup
7594 pending_amt_msat: path_amt,
7595 pending_fee_msat: Some(path_fee),
7596 total_msat: path_amt,
7597 starting_block_height: best_block_height,
7599 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7600 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7605 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
7607 HTLCSource::PreviousHopData(prev_hop_data) => {
7608 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
7609 info.prev_funding_outpoint == prev_hop_data.outpoint &&
7610 info.prev_htlc_id == prev_hop_data.htlc_id
7612 // The ChannelMonitor is now responsible for this HTLC's
7613 // failure/success and will let us know what its outcome is. If we
7614 // still have an entry for this HTLC in `forward_htlcs` or
7615 // `pending_intercepted_htlcs`, we were apparently not persisted after
7616 // the monitor was when forwarding the payment.
7617 forward_htlcs.retain(|_, forwards| {
7618 forwards.retain(|forward| {
7619 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
7620 if pending_forward_matches_htlc(&htlc_info) {
7621 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
7622 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7627 !forwards.is_empty()
7629 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
7630 if pending_forward_matches_htlc(&htlc_info) {
7631 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
7632 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7633 pending_events_read.retain(|event| {
7634 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
7635 intercepted_id != ev_id
7642 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
7643 if let Some(preimage) = preimage_opt {
7644 let pending_events = Mutex::new(pending_events_read);
7645 // Note that we set `from_onchain` to "false" here,
7646 // deliberately keeping the pending payment around forever.
7647 // Given it should only occur when we have a channel we're
7648 // force-closing for being stale that's okay.
7649 // The alternative would be to wipe the state when claiming,
7650 // generating a `PaymentPathSuccessful` event but regenerating
7651 // it and the `PaymentSent` on every restart until the
7652 // `ChannelMonitor` is removed.
7653 pending_outbounds.claim_htlc(payment_id, preimage, session_priv, path, false, &pending_events, &args.logger);
7654 pending_events_read = pending_events.into_inner().unwrap();
7663 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
7664 // If we have pending HTLCs to forward, assume we either dropped a
7665 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7666 // shut down before the timer hit. Either way, set the time_forwardable to a small
7667 // constant as enough time has likely passed that we should simply handle the forwards
7668 // now, or at least after the user gets a chance to reconnect to our peers.
7669 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7670 time_forwardable: Duration::from_secs(2),
7674 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
7675 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7677 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7678 if let Some(mut purposes) = claimable_htlc_purposes {
7679 if purposes.len() != claimable_htlcs_list.len() {
7680 return Err(DecodeError::InvalidValue);
7682 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7683 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7686 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7687 // include a `_legacy_hop_data` in the `OnionPayload`.
7688 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7689 if previous_hops.is_empty() {
7690 return Err(DecodeError::InvalidValue);
7692 let purpose = match &previous_hops[0].onion_payload {
7693 OnionPayload::Invoice { _legacy_hop_data } => {
7694 if let Some(hop_data) = _legacy_hop_data {
7695 events::PaymentPurpose::InvoicePayment {
7696 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7697 Some(inbound_payment) => inbound_payment.payment_preimage,
7698 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7699 Ok((payment_preimage, _)) => payment_preimage,
7701 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));
7702 return Err(DecodeError::InvalidValue);
7706 payment_secret: hop_data.payment_secret,
7708 } else { return Err(DecodeError::InvalidValue); }
7710 OnionPayload::Spontaneous(payment_preimage) =>
7711 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7713 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7717 let mut secp_ctx = Secp256k1::new();
7718 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
7720 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
7722 Err(()) => return Err(DecodeError::InvalidValue)
7724 if let Some(network_pubkey) = received_network_pubkey {
7725 if network_pubkey != our_network_pubkey {
7726 log_error!(args.logger, "Key that was generated does not match the existing key.");
7727 return Err(DecodeError::InvalidValue);
7731 let mut outbound_scid_aliases = HashSet::new();
7732 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
7733 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7734 let peer_state = &mut *peer_state_lock;
7735 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
7736 if chan.outbound_scid_alias() == 0 {
7737 let mut outbound_scid_alias;
7739 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7740 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
7741 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7743 chan.set_outbound_scid_alias(outbound_scid_alias);
7744 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7745 // Note that in rare cases its possible to hit this while reading an older
7746 // channel if we just happened to pick a colliding outbound alias above.
7747 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7748 return Err(DecodeError::InvalidValue);
7750 if chan.is_usable() {
7751 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7752 // Note that in rare cases its possible to hit this while reading an older
7753 // channel if we just happened to pick a colliding outbound alias above.
7754 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7755 return Err(DecodeError::InvalidValue);
7761 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7763 for (_, monitor) in args.channel_monitors.iter() {
7764 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7765 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7766 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7767 let mut claimable_amt_msat = 0;
7768 let mut receiver_node_id = Some(our_network_pubkey);
7769 let phantom_shared_secret = claimable_htlcs[0].prev_hop.phantom_shared_secret;
7770 if phantom_shared_secret.is_some() {
7771 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
7772 .expect("Failed to get node_id for phantom node recipient");
7773 receiver_node_id = Some(phantom_pubkey)
7775 for claimable_htlc in claimable_htlcs {
7776 claimable_amt_msat += claimable_htlc.value;
7778 // Add a holding-cell claim of the payment to the Channel, which should be
7779 // applied ~immediately on peer reconnection. Because it won't generate a
7780 // new commitment transaction we can just provide the payment preimage to
7781 // the corresponding ChannelMonitor and nothing else.
7783 // We do so directly instead of via the normal ChannelMonitor update
7784 // procedure as the ChainMonitor hasn't yet been initialized, implying
7785 // we're not allowed to call it directly yet. Further, we do the update
7786 // without incrementing the ChannelMonitor update ID as there isn't any
7788 // If we were to generate a new ChannelMonitor update ID here and then
7789 // crash before the user finishes block connect we'd end up force-closing
7790 // this channel as well. On the flip side, there's no harm in restarting
7791 // without the new monitor persisted - we'll end up right back here on
7793 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7794 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
7795 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
7796 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7797 let peer_state = &mut *peer_state_lock;
7798 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
7799 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7802 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7803 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7806 pending_events_read.push(events::Event::PaymentClaimed {
7809 purpose: payment_purpose,
7810 amount_msat: claimable_amt_msat,
7816 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
7817 if let Some(peer_state) = per_peer_state.get_mut(&node_id) {
7818 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
7820 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
7821 return Err(DecodeError::InvalidValue);
7825 let channel_manager = ChannelManager {
7827 fee_estimator: bounded_fee_estimator,
7828 chain_monitor: args.chain_monitor,
7829 tx_broadcaster: args.tx_broadcaster,
7830 router: args.router,
7832 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7834 inbound_payment_key: expanded_inbound_key,
7835 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7836 pending_outbound_payments: pending_outbounds,
7837 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
7839 forward_htlcs: Mutex::new(forward_htlcs),
7840 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs, pending_claiming_payments: pending_claiming_payments.unwrap() }),
7841 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7842 id_to_peer: Mutex::new(id_to_peer),
7843 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7844 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7846 probing_cookie_secret: probing_cookie_secret.unwrap(),
7851 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7853 per_peer_state: FairRwLock::new(per_peer_state),
7855 pending_events: Mutex::new(pending_events_read),
7856 pending_background_events: Mutex::new(pending_background_events),
7857 total_consistency_lock: RwLock::new(()),
7858 persistence_notifier: Notifier::new(),
7860 entropy_source: args.entropy_source,
7861 node_signer: args.node_signer,
7862 signer_provider: args.signer_provider,
7864 logger: args.logger,
7865 default_configuration: args.default_config,
7868 for htlc_source in failed_htlcs.drain(..) {
7869 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7870 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7871 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7872 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
7875 //TODO: Broadcast channel update for closed channels, but only after we've made a
7876 //connection or two.
7878 Ok((best_block_hash.clone(), channel_manager))
7884 use bitcoin::hashes::Hash;
7885 use bitcoin::hashes::sha256::Hash as Sha256;
7886 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
7887 use core::time::Duration;
7888 use core::sync::atomic::Ordering;
7889 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7890 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, InterceptId};
7891 use crate::ln::functional_test_utils::*;
7892 use crate::ln::msgs;
7893 use crate::ln::msgs::ChannelMessageHandler;
7894 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7895 use crate::util::errors::APIError;
7896 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7897 use crate::util::test_utils;
7898 use crate::util::config::ChannelConfig;
7899 use crate::chain::keysinterface::EntropySource;
7902 fn test_notify_limits() {
7903 // Check that a few cases which don't require the persistence of a new ChannelManager,
7904 // indeed, do not cause the persistence of a new ChannelManager.
7905 let chanmon_cfgs = create_chanmon_cfgs(3);
7906 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7907 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7908 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7910 // All nodes start with a persistable update pending as `create_network` connects each node
7911 // with all other nodes to make most tests simpler.
7912 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7913 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7914 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7916 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
7918 // We check that the channel info nodes have doesn't change too early, even though we try
7919 // to connect messages with new values
7920 chan.0.contents.fee_base_msat *= 2;
7921 chan.1.contents.fee_base_msat *= 2;
7922 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
7923 &nodes[1].node.get_our_node_id()).pop().unwrap();
7924 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
7925 &nodes[0].node.get_our_node_id()).pop().unwrap();
7927 // The first two nodes (which opened a channel) should now require fresh persistence
7928 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7929 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7930 // ... but the last node should not.
7931 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7932 // After persisting the first two nodes they should no longer need fresh persistence.
7933 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7934 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7936 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7937 // about the channel.
7938 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7939 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7940 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7942 // The nodes which are a party to the channel should also ignore messages from unrelated
7944 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7945 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7946 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7947 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7948 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7949 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7951 // At this point the channel info given by peers should still be the same.
7952 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7953 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7955 // An earlier version of handle_channel_update didn't check the directionality of the
7956 // update message and would always update the local fee info, even if our peer was
7957 // (spuriously) forwarding us our own channel_update.
7958 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7959 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7960 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7962 // First deliver each peers' own message, checking that the node doesn't need to be
7963 // persisted and that its channel info remains the same.
7964 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7965 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7966 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7967 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7968 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7969 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7971 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7972 // the channel info has updated.
7973 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7974 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7975 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7976 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7977 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7978 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7982 fn test_keysend_dup_hash_partial_mpp() {
7983 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7985 let chanmon_cfgs = create_chanmon_cfgs(2);
7986 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7987 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7988 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7989 create_announced_chan_between_nodes(&nodes, 0, 1);
7991 // First, send a partial MPP payment.
7992 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7993 let mut mpp_route = route.clone();
7994 mpp_route.paths.push(mpp_route.paths[0].clone());
7996 let payment_id = PaymentId([42; 32]);
7997 // Use the utility function send_payment_along_path to send the payment with MPP data which
7998 // indicates there are more HTLCs coming.
7999 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.
8000 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
8001 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
8002 check_added_monitors!(nodes[0], 1);
8003 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8004 assert_eq!(events.len(), 1);
8005 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
8007 // Next, send a keysend payment with the same payment_hash and make sure it fails.
8008 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8009 check_added_monitors!(nodes[0], 1);
8010 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8011 assert_eq!(events.len(), 1);
8012 let ev = events.drain(..).next().unwrap();
8013 let payment_event = SendEvent::from_event(ev);
8014 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8015 check_added_monitors!(nodes[1], 0);
8016 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8017 expect_pending_htlcs_forwardable!(nodes[1]);
8018 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
8019 check_added_monitors!(nodes[1], 1);
8020 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8021 assert!(updates.update_add_htlcs.is_empty());
8022 assert!(updates.update_fulfill_htlcs.is_empty());
8023 assert_eq!(updates.update_fail_htlcs.len(), 1);
8024 assert!(updates.update_fail_malformed_htlcs.is_empty());
8025 assert!(updates.update_fee.is_none());
8026 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8027 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8028 expect_payment_failed!(nodes[0], our_payment_hash, true);
8030 // Send the second half of the original MPP payment.
8031 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
8032 check_added_monitors!(nodes[0], 1);
8033 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8034 assert_eq!(events.len(), 1);
8035 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
8037 // Claim the full MPP payment. Note that we can't use a test utility like
8038 // claim_funds_along_route because the ordering of the messages causes the second half of the
8039 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
8040 // lightning messages manually.
8041 nodes[1].node.claim_funds(payment_preimage);
8042 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
8043 check_added_monitors!(nodes[1], 2);
8045 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8046 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
8047 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
8048 check_added_monitors!(nodes[0], 1);
8049 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8050 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
8051 check_added_monitors!(nodes[1], 1);
8052 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8053 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
8054 check_added_monitors!(nodes[1], 1);
8055 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
8056 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
8057 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
8058 check_added_monitors!(nodes[0], 1);
8059 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
8060 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
8061 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8062 check_added_monitors!(nodes[0], 1);
8063 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
8064 check_added_monitors!(nodes[1], 1);
8065 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
8066 check_added_monitors!(nodes[1], 1);
8067 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
8068 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
8069 check_added_monitors!(nodes[0], 1);
8071 // Note that successful MPP payments will generate a single PaymentSent event upon the first
8072 // path's success and a PaymentPathSuccessful event for each path's success.
8073 let events = nodes[0].node.get_and_clear_pending_events();
8074 assert_eq!(events.len(), 3);
8076 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
8077 assert_eq!(Some(payment_id), *id);
8078 assert_eq!(payment_preimage, *preimage);
8079 assert_eq!(our_payment_hash, *hash);
8081 _ => panic!("Unexpected event"),
8084 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
8085 assert_eq!(payment_id, *actual_payment_id);
8086 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
8087 assert_eq!(route.paths[0], *path);
8089 _ => panic!("Unexpected event"),
8092 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
8093 assert_eq!(payment_id, *actual_payment_id);
8094 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
8095 assert_eq!(route.paths[0], *path);
8097 _ => panic!("Unexpected event"),
8102 fn test_keysend_dup_payment_hash() {
8103 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
8104 // outbound regular payment fails as expected.
8105 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
8106 // fails as expected.
8107 let chanmon_cfgs = create_chanmon_cfgs(2);
8108 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8109 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8110 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8111 create_announced_chan_between_nodes(&nodes, 0, 1);
8112 let scorer = test_utils::TestScorer::new();
8113 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8115 // To start (1), send a regular payment but don't claim it.
8116 let expected_route = [&nodes[1]];
8117 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
8119 // Next, attempt a keysend payment and make sure it fails.
8120 let route_params = RouteParameters {
8121 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
8122 final_value_msat: 100_000,
8124 let route = find_route(
8125 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
8126 None, nodes[0].logger, &scorer, &random_seed_bytes
8128 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8129 check_added_monitors!(nodes[0], 1);
8130 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8131 assert_eq!(events.len(), 1);
8132 let ev = events.drain(..).next().unwrap();
8133 let payment_event = SendEvent::from_event(ev);
8134 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8135 check_added_monitors!(nodes[1], 0);
8136 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8137 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
8138 // fails), the second will process the resulting failure and fail the HTLC backward
8139 expect_pending_htlcs_forwardable!(nodes[1]);
8140 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
8141 check_added_monitors!(nodes[1], 1);
8142 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8143 assert!(updates.update_add_htlcs.is_empty());
8144 assert!(updates.update_fulfill_htlcs.is_empty());
8145 assert_eq!(updates.update_fail_htlcs.len(), 1);
8146 assert!(updates.update_fail_malformed_htlcs.is_empty());
8147 assert!(updates.update_fee.is_none());
8148 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8149 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8150 expect_payment_failed!(nodes[0], payment_hash, true);
8152 // Finally, claim the original payment.
8153 claim_payment(&nodes[0], &expected_route, payment_preimage);
8155 // To start (2), send a keysend payment but don't claim it.
8156 let payment_preimage = PaymentPreimage([42; 32]);
8157 let route = find_route(
8158 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
8159 None, nodes[0].logger, &scorer, &random_seed_bytes
8161 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8162 check_added_monitors!(nodes[0], 1);
8163 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8164 assert_eq!(events.len(), 1);
8165 let event = events.pop().unwrap();
8166 let path = vec![&nodes[1]];
8167 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
8169 // Next, attempt a regular payment and make sure it fails.
8170 let payment_secret = PaymentSecret([43; 32]);
8171 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8172 check_added_monitors!(nodes[0], 1);
8173 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8174 assert_eq!(events.len(), 1);
8175 let ev = events.drain(..).next().unwrap();
8176 let payment_event = SendEvent::from_event(ev);
8177 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8178 check_added_monitors!(nodes[1], 0);
8179 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8180 expect_pending_htlcs_forwardable!(nodes[1]);
8181 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
8182 check_added_monitors!(nodes[1], 1);
8183 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8184 assert!(updates.update_add_htlcs.is_empty());
8185 assert!(updates.update_fulfill_htlcs.is_empty());
8186 assert_eq!(updates.update_fail_htlcs.len(), 1);
8187 assert!(updates.update_fail_malformed_htlcs.is_empty());
8188 assert!(updates.update_fee.is_none());
8189 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8190 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8191 expect_payment_failed!(nodes[0], payment_hash, true);
8193 // Finally, succeed the keysend payment.
8194 claim_payment(&nodes[0], &expected_route, payment_preimage);
8198 fn test_keysend_hash_mismatch() {
8199 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
8200 // preimage doesn't match the msg's payment hash.
8201 let chanmon_cfgs = create_chanmon_cfgs(2);
8202 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8203 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8204 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8206 let payer_pubkey = nodes[0].node.get_our_node_id();
8207 let payee_pubkey = nodes[1].node.get_our_node_id();
8209 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
8210 let route_params = RouteParameters {
8211 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
8212 final_value_msat: 10_000,
8214 let network_graph = nodes[0].network_graph.clone();
8215 let first_hops = nodes[0].node.list_usable_channels();
8216 let scorer = test_utils::TestScorer::new();
8217 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8218 let route = find_route(
8219 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8220 nodes[0].logger, &scorer, &random_seed_bytes
8223 let test_preimage = PaymentPreimage([42; 32]);
8224 let mismatch_payment_hash = PaymentHash([43; 32]);
8225 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
8226 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
8227 check_added_monitors!(nodes[0], 1);
8229 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8230 assert_eq!(updates.update_add_htlcs.len(), 1);
8231 assert!(updates.update_fulfill_htlcs.is_empty());
8232 assert!(updates.update_fail_htlcs.is_empty());
8233 assert!(updates.update_fail_malformed_htlcs.is_empty());
8234 assert!(updates.update_fee.is_none());
8235 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8237 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
8241 fn test_keysend_msg_with_secret_err() {
8242 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
8243 let chanmon_cfgs = create_chanmon_cfgs(2);
8244 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8245 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8246 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8248 let payer_pubkey = nodes[0].node.get_our_node_id();
8249 let payee_pubkey = nodes[1].node.get_our_node_id();
8251 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
8252 let route_params = RouteParameters {
8253 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
8254 final_value_msat: 10_000,
8256 let network_graph = nodes[0].network_graph.clone();
8257 let first_hops = nodes[0].node.list_usable_channels();
8258 let scorer = test_utils::TestScorer::new();
8259 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8260 let route = find_route(
8261 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8262 nodes[0].logger, &scorer, &random_seed_bytes
8265 let test_preimage = PaymentPreimage([42; 32]);
8266 let test_secret = PaymentSecret([43; 32]);
8267 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
8268 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
8269 nodes[0].node.test_send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
8270 check_added_monitors!(nodes[0], 1);
8272 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8273 assert_eq!(updates.update_add_htlcs.len(), 1);
8274 assert!(updates.update_fulfill_htlcs.is_empty());
8275 assert!(updates.update_fail_htlcs.is_empty());
8276 assert!(updates.update_fail_malformed_htlcs.is_empty());
8277 assert!(updates.update_fee.is_none());
8278 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8280 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
8284 fn test_multi_hop_missing_secret() {
8285 let chanmon_cfgs = create_chanmon_cfgs(4);
8286 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8287 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8288 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8290 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8291 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
8292 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
8293 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
8295 // Marshall an MPP route.
8296 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
8297 let path = route.paths[0].clone();
8298 route.paths.push(path);
8299 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8300 route.paths[0][0].short_channel_id = chan_1_id;
8301 route.paths[0][1].short_channel_id = chan_3_id;
8302 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8303 route.paths[1][0].short_channel_id = chan_2_id;
8304 route.paths[1][1].short_channel_id = chan_4_id;
8306 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
8307 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
8308 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
8310 _ => panic!("unexpected error")
8315 fn test_drop_disconnected_peers_when_removing_channels() {
8316 let chanmon_cfgs = create_chanmon_cfgs(2);
8317 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8318 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8319 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8321 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
8323 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
8324 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
8326 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
8327 check_closed_broadcast!(nodes[0], true);
8328 check_added_monitors!(nodes[0], 1);
8329 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
8332 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
8333 // disconnected and the channel between has been force closed.
8334 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
8335 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
8336 assert_eq!(nodes_0_per_peer_state.len(), 1);
8337 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
8340 nodes[0].node.timer_tick_occurred();
8343 // Assert that nodes[1] has now been removed.
8344 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
8349 fn bad_inbound_payment_hash() {
8350 // Add coverage for checking that a user-provided payment hash matches the payment secret.
8351 let chanmon_cfgs = create_chanmon_cfgs(2);
8352 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8353 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8354 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8356 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
8357 let payment_data = msgs::FinalOnionHopData {
8359 total_msat: 100_000,
8362 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
8363 // payment verification fails as expected.
8364 let mut bad_payment_hash = payment_hash.clone();
8365 bad_payment_hash.0[0] += 1;
8366 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) {
8367 Ok(_) => panic!("Unexpected ok"),
8369 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
8373 // Check that using the original payment hash succeeds.
8374 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());
8378 fn test_id_to_peer_coverage() {
8379 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
8380 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
8381 // the channel is successfully closed.
8382 let chanmon_cfgs = create_chanmon_cfgs(2);
8383 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8384 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8385 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8387 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8388 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8389 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
8390 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8391 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
8393 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
8394 let channel_id = &tx.txid().into_inner();
8396 // Ensure that the `id_to_peer` map is empty until either party has received the
8397 // funding transaction, and have the real `channel_id`.
8398 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8399 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8402 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8404 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
8405 // as it has the funding transaction.
8406 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8407 assert_eq!(nodes_0_lock.len(), 1);
8408 assert!(nodes_0_lock.contains_key(channel_id));
8411 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8413 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8415 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8417 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8418 assert_eq!(nodes_0_lock.len(), 1);
8419 assert!(nodes_0_lock.contains_key(channel_id));
8423 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
8424 // as it has the funding transaction.
8425 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8426 assert_eq!(nodes_1_lock.len(), 1);
8427 assert!(nodes_1_lock.contains_key(channel_id));
8429 check_added_monitors!(nodes[1], 1);
8430 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8431 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8432 check_added_monitors!(nodes[0], 1);
8433 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8434 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8435 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8437 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8438 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
8439 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8440 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
8442 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8443 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8445 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8446 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8447 // fee for the closing transaction has been negotiated and the parties has the other
8448 // party's signature for the fee negotiated closing transaction.)
8449 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8450 assert_eq!(nodes_0_lock.len(), 1);
8451 assert!(nodes_0_lock.contains_key(channel_id));
8455 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8456 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8457 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8458 // kept in the `nodes[1]`'s `id_to_peer` map.
8459 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8460 assert_eq!(nodes_1_lock.len(), 1);
8461 assert!(nodes_1_lock.contains_key(channel_id));
8464 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()));
8466 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8467 // therefore has all it needs to fully close the channel (both signatures for the
8468 // closing transaction).
8469 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8470 // fully closed by `nodes[0]`.
8471 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8473 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8474 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8475 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8476 assert_eq!(nodes_1_lock.len(), 1);
8477 assert!(nodes_1_lock.contains_key(channel_id));
8480 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8482 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8484 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8485 // they both have everything required to fully close the channel.
8486 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8488 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8490 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8491 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8494 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8495 let expected_message = format!("Not connected to node: {}", expected_public_key);
8496 check_api_error_message(expected_message, res_err)
8499 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8500 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
8501 check_api_error_message(expected_message, res_err)
8504 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
8506 Err(APIError::APIMisuseError { err }) => {
8507 assert_eq!(err, expected_err_message);
8509 Err(APIError::ChannelUnavailable { err }) => {
8510 assert_eq!(err, expected_err_message);
8512 Ok(_) => panic!("Unexpected Ok"),
8513 Err(_) => panic!("Unexpected Error"),
8518 fn test_api_calls_with_unkown_counterparty_node() {
8519 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
8520 // expected if the `counterparty_node_id` is an unkown peer in the
8521 // `ChannelManager::per_peer_state` map.
8522 let chanmon_cfg = create_chanmon_cfgs(2);
8523 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
8524 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
8525 let nodes = create_network(2, &node_cfg, &node_chanmgr);
8528 let channel_id = [4; 32];
8529 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
8530 let intercept_id = InterceptId([0; 32]);
8532 // Test the API functions.
8533 check_not_connected_to_peer_error(nodes[0].node.create_channel(unkown_public_key, 1_000_000, 500_000_000, 42, None), unkown_public_key);
8535 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
8537 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
8539 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
8541 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
8543 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
8545 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
8549 fn test_connection_limiting() {
8550 // Test that we limit un-channel'd peers and un-funded channels properly.
8551 let chanmon_cfgs = create_chanmon_cfgs(2);
8552 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8553 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8554 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8556 // Note that create_network connects the nodes together for us
8558 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
8559 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8561 let mut funding_tx = None;
8562 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
8563 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8564 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8567 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
8568 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
8569 funding_tx = Some(tx.clone());
8570 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
8571 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8573 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8574 check_added_monitors!(nodes[1], 1);
8575 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8577 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8578 check_added_monitors!(nodes[0], 1);
8580 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8583 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
8584 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8585 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8586 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
8587 open_channel_msg.temporary_channel_id);
8589 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
8590 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
8592 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
8593 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
8594 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
8595 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
8596 peer_pks.push(random_pk);
8597 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
8598 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8600 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
8601 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
8602 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
8603 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap_err();
8605 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
8606 // them if we have too many un-channel'd peers.
8607 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
8608 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
8609 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
8610 for ev in chan_closed_events {
8611 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
8613 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
8614 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8615 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
8616 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap_err();
8618 // but of course if the connection is outbound its allowed...
8619 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
8620 features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
8621 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
8623 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
8624 // Even though we accept one more connection from new peers, we won't actually let them
8626 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
8627 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
8628 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
8629 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
8630 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8632 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
8633 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
8634 open_channel_msg.temporary_channel_id);
8636 // Of course, however, outbound channels are always allowed
8637 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
8638 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
8640 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
8641 // "protected" and can connect again.
8642 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
8643 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
8644 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8645 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8647 // Further, because the first channel was funded, we can open another channel with
8649 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
8650 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
8654 fn test_outbound_chans_unlimited() {
8655 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
8656 let chanmon_cfgs = create_chanmon_cfgs(2);
8657 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8658 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8659 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8661 // Note that create_network connects the nodes together for us
8663 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
8664 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8666 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
8667 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8668 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8669 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8672 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
8674 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8675 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
8676 open_channel_msg.temporary_channel_id);
8678 // but we can still open an outbound channel.
8679 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
8680 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
8682 // but even with such an outbound channel, additional inbound channels will still fail.
8683 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8684 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
8685 open_channel_msg.temporary_channel_id);
8689 fn test_0conf_limiting() {
8690 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
8691 // flag set and (sometimes) accept channels as 0conf.
8692 let chanmon_cfgs = create_chanmon_cfgs(2);
8693 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8694 let mut settings = test_default_channel_config();
8695 settings.manually_accept_inbound_channels = true;
8696 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
8697 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8699 // Note that create_network connects the nodes together for us
8701 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
8702 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8704 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
8705 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
8706 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
8707 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
8708 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
8709 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8711 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
8712 let events = nodes[1].node.get_and_clear_pending_events();
8714 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8715 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
8717 _ => panic!("Unexpected event"),
8719 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
8720 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8723 // If we try to accept a channel from another peer non-0conf it will fail.
8724 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
8725 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
8726 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
8727 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8728 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
8729 let events = nodes[1].node.get_and_clear_pending_events();
8731 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8732 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
8733 Err(APIError::APIMisuseError { err }) =>
8734 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
8738 _ => panic!("Unexpected event"),
8740 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
8741 open_channel_msg.temporary_channel_id);
8743 // ...however if we accept the same channel 0conf it should work just fine.
8744 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
8745 let events = nodes[1].node.get_and_clear_pending_events();
8747 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8748 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
8750 _ => panic!("Unexpected event"),
8752 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
8757 fn test_anchors_zero_fee_htlc_tx_fallback() {
8758 // Tests that if both nodes support anchors, but the remote node does not want to accept
8759 // anchor channels at the moment, an error it sent to the local node such that it can retry
8760 // the channel without the anchors feature.
8761 let chanmon_cfgs = create_chanmon_cfgs(2);
8762 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8763 let mut anchors_config = test_default_channel_config();
8764 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
8765 anchors_config.manually_accept_inbound_channels = true;
8766 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
8767 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8769 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
8770 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8771 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
8773 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8774 let events = nodes[1].node.get_and_clear_pending_events();
8776 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8777 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
8779 _ => panic!("Unexpected event"),
8782 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
8783 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
8785 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8786 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
8788 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
8792 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8794 use crate::chain::Listen;
8795 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8796 use crate::chain::keysinterface::{EntropySource, KeysManager, InMemorySigner};
8797 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8798 use crate::ln::functional_test_utils::*;
8799 use crate::ln::msgs::{ChannelMessageHandler, Init};
8800 use crate::routing::gossip::NetworkGraph;
8801 use crate::routing::router::{PaymentParameters, get_route};
8802 use crate::util::test_utils;
8803 use crate::util::config::UserConfig;
8804 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8806 use bitcoin::hashes::Hash;
8807 use bitcoin::hashes::sha256::Hash as Sha256;
8808 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8810 use crate::sync::{Arc, Mutex};
8814 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8815 node: &'a ChannelManager<
8816 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8817 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8818 &'a test_utils::TestLogger, &'a P>,
8819 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
8820 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
8821 &'a test_utils::TestLogger>,
8826 fn bench_sends(bench: &mut Bencher) {
8827 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8830 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8831 // Do a simple benchmark of sending a payment back and forth between two nodes.
8832 // Note that this is unrealistic as each payment send will require at least two fsync
8834 let network = bitcoin::Network::Testnet;
8836 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8837 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8838 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8839 let scorer = Mutex::new(test_utils::TestScorer::new());
8840 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
8842 let mut config: UserConfig = Default::default();
8843 config.channel_handshake_config.minimum_depth = 1;
8845 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8846 let seed_a = [1u8; 32];
8847 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8848 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &router, &logger_a, &keys_manager_a, &keys_manager_a, &keys_manager_a, config.clone(), ChainParameters {
8850 best_block: BestBlock::from_network(network),
8852 let node_a_holder = NodeHolder { node: &node_a };
8854 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8855 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8856 let seed_b = [2u8; 32];
8857 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8858 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &router, &logger_b, &keys_manager_b, &keys_manager_b, &keys_manager_b, config.clone(), ChainParameters {
8860 best_block: BestBlock::from_network(network),
8862 let node_b_holder = NodeHolder { node: &node_b };
8864 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: node_b.init_features(), remote_network_address: None }, true).unwrap();
8865 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: node_a.init_features(), remote_network_address: None }, false).unwrap();
8866 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8867 node_b.handle_open_channel(&node_a.get_our_node_id(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
8868 node_a.handle_accept_channel(&node_b.get_our_node_id(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
8871 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8872 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8873 value: 8_000_000, script_pubkey: output_script,
8875 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8876 } else { panic!(); }
8878 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()));
8879 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()));
8881 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8884 header: BlockHeader { version: 0x20000000, prev_blockhash: BestBlock::from_network(network).block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8887 Listen::block_connected(&node_a, &block, 1);
8888 Listen::block_connected(&node_b, &block, 1);
8890 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()));
8891 let msg_events = node_a.get_and_clear_pending_msg_events();
8892 assert_eq!(msg_events.len(), 2);
8893 match msg_events[0] {
8894 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8895 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8896 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8900 match msg_events[1] {
8901 MessageSendEvent::SendChannelUpdate { .. } => {},
8905 let events_a = node_a.get_and_clear_pending_events();
8906 assert_eq!(events_a.len(), 1);
8908 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8909 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8911 _ => panic!("Unexpected event"),
8914 let events_b = node_b.get_and_clear_pending_events();
8915 assert_eq!(events_b.len(), 1);
8917 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8918 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8920 _ => panic!("Unexpected event"),
8923 let dummy_graph = NetworkGraph::new(network, &logger_a);
8925 let mut payment_count: u64 = 0;
8926 macro_rules! send_payment {
8927 ($node_a: expr, $node_b: expr) => {
8928 let usable_channels = $node_a.list_usable_channels();
8929 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
8930 .with_features($node_b.invoice_features());
8931 let scorer = test_utils::TestScorer::new();
8932 let seed = [3u8; 32];
8933 let keys_manager = KeysManager::new(&seed, 42, 42);
8934 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8935 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8936 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8938 let mut payment_preimage = PaymentPreimage([0; 32]);
8939 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8941 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8942 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
8944 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8945 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8946 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8947 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8948 let (raa, cs) = do_get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
8949 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8950 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8951 $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()));
8953 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8954 expect_payment_claimable!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8955 $node_b.claim_funds(payment_preimage);
8956 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8958 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8959 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8960 assert_eq!(node_id, $node_a.get_our_node_id());
8961 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8962 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8964 _ => panic!("Failed to generate claim event"),
8967 let (raa, cs) = do_get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
8968 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8969 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8970 $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()));
8972 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8977 send_payment!(node_a, node_b);
8978 send_payment!(node_b, node_a);