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::ChainHash;
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};
39 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
40 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
41 // construct one themselves.
42 use crate::ln::{inbound_payment, ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelPhase, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UnfundedChannelContext, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel};
44 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
45 #[cfg(any(feature = "_test_utils", test))]
46 use crate::ln::features::Bolt11InvoiceFeatures;
47 use crate::routing::gossip::NetworkGraph;
48 use crate::routing::router::{BlindedTail, DefaultRouter, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
49 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
51 use crate::ln::onion_utils;
52 use crate::ln::onion_utils::HTLCFailReason;
53 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
55 use crate::ln::outbound_payment;
56 use crate::ln::outbound_payment::{OutboundPayments, PaymentAttempts, PendingOutboundPayment, SendAlongPathArgs};
57 use crate::ln::wire::Encode;
58 use crate::sign::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, WriteableEcdsaChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
60 use crate::util::wakers::{Future, Notifier};
61 use crate::util::scid_utils::fake_scid;
62 use crate::util::string::UntrustedString;
63 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
64 use crate::util::logger::{Level, Logger};
65 use crate::util::errors::APIError;
67 use alloc::collections::{btree_map, BTreeMap};
70 use crate::prelude::*;
72 use core::cell::RefCell;
74 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
75 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
76 use core::time::Duration;
79 // Re-export this for use in the public API.
80 pub use crate::ln::outbound_payment::{PaymentSendFailure, ProbeSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
81 use crate::ln::script::ShutdownScript;
83 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
85 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
86 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
87 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
89 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
90 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
91 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
92 // before we forward it.
94 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
95 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
96 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
97 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
98 // our payment, which we can use to decode errors or inform the user that the payment was sent.
100 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
101 pub(super) enum PendingHTLCRouting {
103 onion_packet: msgs::OnionPacket,
104 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
105 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
106 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
109 payment_data: msgs::FinalOnionHopData,
110 payment_metadata: Option<Vec<u8>>,
111 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
112 phantom_shared_secret: Option<[u8; 32]>,
113 /// See [`RecipientOnionFields::custom_tlvs`] for more info.
114 custom_tlvs: Vec<(u64, Vec<u8>)>,
117 /// This was added in 0.0.116 and will break deserialization on downgrades.
118 payment_data: Option<msgs::FinalOnionHopData>,
119 payment_preimage: PaymentPreimage,
120 payment_metadata: Option<Vec<u8>>,
121 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
122 /// See [`RecipientOnionFields::custom_tlvs`] for more info.
123 custom_tlvs: Vec<(u64, Vec<u8>)>,
127 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
128 pub(super) struct PendingHTLCInfo {
129 pub(super) routing: PendingHTLCRouting,
130 pub(super) incoming_shared_secret: [u8; 32],
131 payment_hash: PaymentHash,
133 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
134 /// Sender intended amount to forward or receive (actual amount received
135 /// may overshoot this in either case)
136 pub(super) outgoing_amt_msat: u64,
137 pub(super) outgoing_cltv_value: u32,
138 /// The fee being skimmed off the top of this HTLC. If this is a forward, it'll be the fee we are
139 /// skimming. If we're receiving this HTLC, it's the fee that our counterparty skimmed.
140 pub(super) skimmed_fee_msat: Option<u64>,
143 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
144 pub(super) enum HTLCFailureMsg {
145 Relay(msgs::UpdateFailHTLC),
146 Malformed(msgs::UpdateFailMalformedHTLC),
149 /// Stores whether we can't forward an HTLC or relevant forwarding info
150 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
151 pub(super) enum PendingHTLCStatus {
152 Forward(PendingHTLCInfo),
153 Fail(HTLCFailureMsg),
156 pub(super) struct PendingAddHTLCInfo {
157 pub(super) forward_info: PendingHTLCInfo,
159 // These fields are produced in `forward_htlcs()` and consumed in
160 // `process_pending_htlc_forwards()` for constructing the
161 // `HTLCSource::PreviousHopData` for failed and forwarded
164 // Note that this may be an outbound SCID alias for the associated channel.
165 prev_short_channel_id: u64,
167 prev_funding_outpoint: OutPoint,
168 prev_user_channel_id: u128,
171 pub(super) enum HTLCForwardInfo {
172 AddHTLC(PendingAddHTLCInfo),
175 err_packet: msgs::OnionErrorPacket,
179 /// Tracks the inbound corresponding to an outbound HTLC
180 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
181 pub(crate) struct HTLCPreviousHopData {
182 // Note that this may be an outbound SCID alias for the associated channel.
183 short_channel_id: u64,
184 user_channel_id: Option<u128>,
186 incoming_packet_shared_secret: [u8; 32],
187 phantom_shared_secret: Option<[u8; 32]>,
189 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
190 // channel with a preimage provided by the forward channel.
195 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
197 /// This is only here for backwards-compatibility in serialization, in the future it can be
198 /// removed, breaking clients running 0.0.106 and earlier.
199 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
201 /// Contains the payer-provided preimage.
202 Spontaneous(PaymentPreimage),
205 /// HTLCs that are to us and can be failed/claimed by the user
206 struct ClaimableHTLC {
207 prev_hop: HTLCPreviousHopData,
209 /// The amount (in msats) of this MPP part
211 /// The amount (in msats) that the sender intended to be sent in this MPP
212 /// part (used for validating total MPP amount)
213 sender_intended_value: u64,
214 onion_payload: OnionPayload,
216 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
217 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
218 total_value_received: Option<u64>,
219 /// The sender intended sum total of all MPP parts specified in the onion
221 /// The extra fee our counterparty skimmed off the top of this HTLC.
222 counterparty_skimmed_fee_msat: Option<u64>,
225 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
226 fn from(val: &ClaimableHTLC) -> Self {
227 events::ClaimedHTLC {
228 channel_id: val.prev_hop.outpoint.to_channel_id(),
229 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
230 cltv_expiry: val.cltv_expiry,
231 value_msat: val.value,
236 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
237 /// a payment and ensure idempotency in LDK.
239 /// This is not exported to bindings users as we just use [u8; 32] directly
240 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
241 pub struct PaymentId(pub [u8; Self::LENGTH]);
244 /// Number of bytes in the id.
245 pub const LENGTH: usize = 32;
248 impl Writeable for PaymentId {
249 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
254 impl Readable for PaymentId {
255 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
256 let buf: [u8; 32] = Readable::read(r)?;
261 impl core::fmt::Display for PaymentId {
262 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
263 crate::util::logger::DebugBytes(&self.0).fmt(f)
267 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
269 /// This is not exported to bindings users as we just use [u8; 32] directly
270 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
271 pub struct InterceptId(pub [u8; 32]);
273 impl Writeable for InterceptId {
274 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
279 impl Readable for InterceptId {
280 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
281 let buf: [u8; 32] = Readable::read(r)?;
286 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
287 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
288 pub(crate) enum SentHTLCId {
289 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
290 OutboundRoute { session_priv: SecretKey },
293 pub(crate) fn from_source(source: &HTLCSource) -> Self {
295 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
296 short_channel_id: hop_data.short_channel_id,
297 htlc_id: hop_data.htlc_id,
299 HTLCSource::OutboundRoute { session_priv, .. } =>
300 Self::OutboundRoute { session_priv: *session_priv },
304 impl_writeable_tlv_based_enum!(SentHTLCId,
305 (0, PreviousHopData) => {
306 (0, short_channel_id, required),
307 (2, htlc_id, required),
309 (2, OutboundRoute) => {
310 (0, session_priv, required),
315 /// Tracks the inbound corresponding to an outbound HTLC
316 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
317 #[derive(Clone, Debug, PartialEq, Eq)]
318 pub(crate) enum HTLCSource {
319 PreviousHopData(HTLCPreviousHopData),
322 session_priv: SecretKey,
323 /// Technically we can recalculate this from the route, but we cache it here to avoid
324 /// doing a double-pass on route when we get a failure back
325 first_hop_htlc_msat: u64,
326 payment_id: PaymentId,
329 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
330 impl core::hash::Hash for HTLCSource {
331 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
333 HTLCSource::PreviousHopData(prev_hop_data) => {
335 prev_hop_data.hash(hasher);
337 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
340 session_priv[..].hash(hasher);
341 payment_id.hash(hasher);
342 first_hop_htlc_msat.hash(hasher);
348 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
350 pub fn dummy() -> Self {
351 HTLCSource::OutboundRoute {
352 path: Path { hops: Vec::new(), blinded_tail: None },
353 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
354 first_hop_htlc_msat: 0,
355 payment_id: PaymentId([2; 32]),
359 #[cfg(debug_assertions)]
360 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
361 /// transaction. Useful to ensure different datastructures match up.
362 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
363 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
364 *first_hop_htlc_msat == htlc.amount_msat
366 // There's nothing we can check for forwarded HTLCs
372 struct InboundOnionErr {
378 /// This enum is used to specify which error data to send to peers when failing back an HTLC
379 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
381 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
382 #[derive(Clone, Copy)]
383 pub enum FailureCode {
384 /// We had a temporary error processing the payment. Useful if no other error codes fit
385 /// and you want to indicate that the payer may want to retry.
386 TemporaryNodeFailure,
387 /// We have a required feature which was not in this onion. For example, you may require
388 /// some additional metadata that was not provided with this payment.
389 RequiredNodeFeatureMissing,
390 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
391 /// the HTLC is too close to the current block height for safe handling.
392 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
393 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
394 IncorrectOrUnknownPaymentDetails,
395 /// We failed to process the payload after the onion was decrypted. You may wish to
396 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
398 /// If available, the tuple data may include the type number and byte offset in the
399 /// decrypted byte stream where the failure occurred.
400 InvalidOnionPayload(Option<(u64, u16)>),
403 impl Into<u16> for FailureCode {
404 fn into(self) -> u16 {
406 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
407 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
408 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
409 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
414 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
415 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
416 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
417 /// peer_state lock. We then return the set of things that need to be done outside the lock in
418 /// this struct and call handle_error!() on it.
420 struct MsgHandleErrInternal {
421 err: msgs::LightningError,
422 chan_id: Option<(ChannelId, u128)>, // If Some a channel of ours has been closed
423 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
424 channel_capacity: Option<u64>,
426 impl MsgHandleErrInternal {
428 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
430 err: LightningError {
432 action: msgs::ErrorAction::SendErrorMessage {
433 msg: msgs::ErrorMessage {
440 shutdown_finish: None,
441 channel_capacity: None,
445 fn from_no_close(err: msgs::LightningError) -> Self {
446 Self { err, chan_id: None, shutdown_finish: None, channel_capacity: None }
449 fn from_finish_shutdown(err: String, channel_id: ChannelId, user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>, channel_capacity: u64) -> Self {
450 let err_msg = msgs::ErrorMessage { channel_id, data: err.clone() };
451 let action = if let (Some(_), ..) = &shutdown_res {
452 // We have a closing `ChannelMonitorUpdate`, which means the channel was funded and we
453 // should disconnect our peer such that we force them to broadcast their latest
454 // commitment upon reconnecting.
455 msgs::ErrorAction::DisconnectPeer { msg: Some(err_msg) }
457 msgs::ErrorAction::SendErrorMessage { msg: err_msg }
460 err: LightningError { err, action },
461 chan_id: Some((channel_id, user_channel_id)),
462 shutdown_finish: Some((shutdown_res, channel_update)),
463 channel_capacity: Some(channel_capacity)
467 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
470 ChannelError::Warn(msg) => LightningError {
472 action: msgs::ErrorAction::SendWarningMessage {
473 msg: msgs::WarningMessage {
477 log_level: Level::Warn,
480 ChannelError::Ignore(msg) => LightningError {
482 action: msgs::ErrorAction::IgnoreError,
484 ChannelError::Close(msg) => LightningError {
486 action: msgs::ErrorAction::SendErrorMessage {
487 msg: msgs::ErrorMessage {
495 shutdown_finish: None,
496 channel_capacity: None,
500 fn closes_channel(&self) -> bool {
501 self.chan_id.is_some()
505 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
506 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
507 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
508 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
509 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
511 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
512 /// be sent in the order they appear in the return value, however sometimes the order needs to be
513 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
514 /// they were originally sent). In those cases, this enum is also returned.
515 #[derive(Clone, PartialEq)]
516 pub(super) enum RAACommitmentOrder {
517 /// Send the CommitmentUpdate messages first
519 /// Send the RevokeAndACK message first
523 /// Information about a payment which is currently being claimed.
524 struct ClaimingPayment {
526 payment_purpose: events::PaymentPurpose,
527 receiver_node_id: PublicKey,
528 htlcs: Vec<events::ClaimedHTLC>,
529 sender_intended_value: Option<u64>,
531 impl_writeable_tlv_based!(ClaimingPayment, {
532 (0, amount_msat, required),
533 (2, payment_purpose, required),
534 (4, receiver_node_id, required),
535 (5, htlcs, optional_vec),
536 (7, sender_intended_value, option),
539 struct ClaimablePayment {
540 purpose: events::PaymentPurpose,
541 onion_fields: Option<RecipientOnionFields>,
542 htlcs: Vec<ClaimableHTLC>,
545 /// Information about claimable or being-claimed payments
546 struct ClaimablePayments {
547 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
548 /// failed/claimed by the user.
550 /// Note that, no consistency guarantees are made about the channels given here actually
551 /// existing anymore by the time you go to read them!
553 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
554 /// we don't get a duplicate payment.
555 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
557 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
558 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
559 /// as an [`events::Event::PaymentClaimed`].
560 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
563 /// Events which we process internally but cannot be processed immediately at the generation site
564 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
565 /// running normally, and specifically must be processed before any other non-background
566 /// [`ChannelMonitorUpdate`]s are applied.
567 enum BackgroundEvent {
568 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
569 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
570 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
571 /// channel has been force-closed we do not need the counterparty node_id.
573 /// Note that any such events are lost on shutdown, so in general they must be updates which
574 /// are regenerated on startup.
575 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
576 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
577 /// channel to continue normal operation.
579 /// In general this should be used rather than
580 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
581 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
582 /// error the other variant is acceptable.
584 /// Note that any such events are lost on shutdown, so in general they must be updates which
585 /// are regenerated on startup.
586 MonitorUpdateRegeneratedOnStartup {
587 counterparty_node_id: PublicKey,
588 funding_txo: OutPoint,
589 update: ChannelMonitorUpdate
591 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
592 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
594 MonitorUpdatesComplete {
595 counterparty_node_id: PublicKey,
596 channel_id: ChannelId,
601 pub(crate) enum MonitorUpdateCompletionAction {
602 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
603 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
604 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
605 /// event can be generated.
606 PaymentClaimed { payment_hash: PaymentHash },
607 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
608 /// operation of another channel.
610 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
611 /// from completing a monitor update which removes the payment preimage until the inbound edge
612 /// completes a monitor update containing the payment preimage. In that case, after the inbound
613 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
615 EmitEventAndFreeOtherChannel {
616 event: events::Event,
617 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
621 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
622 (0, PaymentClaimed) => { (0, payment_hash, required) },
623 (2, EmitEventAndFreeOtherChannel) => {
624 (0, event, upgradable_required),
625 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
626 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
627 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
628 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
629 // downgrades to prior versions.
630 (1, downstream_counterparty_and_funding_outpoint, option),
634 #[derive(Clone, Debug, PartialEq, Eq)]
635 pub(crate) enum EventCompletionAction {
636 ReleaseRAAChannelMonitorUpdate {
637 counterparty_node_id: PublicKey,
638 channel_funding_outpoint: OutPoint,
641 impl_writeable_tlv_based_enum!(EventCompletionAction,
642 (0, ReleaseRAAChannelMonitorUpdate) => {
643 (0, channel_funding_outpoint, required),
644 (2, counterparty_node_id, required),
648 #[derive(Clone, PartialEq, Eq, Debug)]
649 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
650 /// the blocked action here. See enum variants for more info.
651 pub(crate) enum RAAMonitorUpdateBlockingAction {
652 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
653 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
655 ForwardedPaymentInboundClaim {
656 /// The upstream channel ID (i.e. the inbound edge).
657 channel_id: ChannelId,
658 /// The HTLC ID on the inbound edge.
663 impl RAAMonitorUpdateBlockingAction {
664 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
665 Self::ForwardedPaymentInboundClaim {
666 channel_id: prev_hop.outpoint.to_channel_id(),
667 htlc_id: prev_hop.htlc_id,
672 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
673 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
677 /// State we hold per-peer.
678 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
679 /// `channel_id` -> `ChannelPhase`
681 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
682 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
683 /// `temporary_channel_id` -> `InboundChannelRequest`.
685 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
686 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
687 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
688 /// the channel is rejected, then the entry is simply removed.
689 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
690 /// The latest `InitFeatures` we heard from the peer.
691 latest_features: InitFeatures,
692 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
693 /// for broadcast messages, where ordering isn't as strict).
694 pub(super) pending_msg_events: Vec<MessageSendEvent>,
695 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
696 /// user but which have not yet completed.
698 /// Note that the channel may no longer exist. For example if the channel was closed but we
699 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
700 /// for a missing channel.
701 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
702 /// Map from a specific channel to some action(s) that should be taken when all pending
703 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
705 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
706 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
707 /// channels with a peer this will just be one allocation and will amount to a linear list of
708 /// channels to walk, avoiding the whole hashing rigmarole.
710 /// Note that the channel may no longer exist. For example, if a channel was closed but we
711 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
712 /// for a missing channel. While a malicious peer could construct a second channel with the
713 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
714 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
715 /// duplicates do not occur, so such channels should fail without a monitor update completing.
716 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
717 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
718 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
719 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
720 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
721 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
722 /// The peer is currently connected (i.e. we've seen a
723 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
724 /// [`ChannelMessageHandler::peer_disconnected`].
728 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
729 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
730 /// If true is passed for `require_disconnected`, the function will return false if we haven't
731 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
732 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
733 if require_disconnected && self.is_connected {
736 self.channel_by_id.iter().filter(|(_, phase)| matches!(phase, ChannelPhase::Funded(_))).count() == 0
737 && self.monitor_update_blocked_actions.is_empty()
738 && self.in_flight_monitor_updates.is_empty()
741 // Returns a count of all channels we have with this peer, including unfunded channels.
742 fn total_channel_count(&self) -> usize {
743 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
746 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
747 fn has_channel(&self, channel_id: &ChannelId) -> bool {
748 self.channel_by_id.contains_key(channel_id) ||
749 self.inbound_channel_request_by_id.contains_key(channel_id)
753 /// A not-yet-accepted inbound (from counterparty) channel. Once
754 /// accepted, the parameters will be used to construct a channel.
755 pub(super) struct InboundChannelRequest {
756 /// The original OpenChannel message.
757 pub open_channel_msg: msgs::OpenChannel,
758 /// The number of ticks remaining before the request expires.
759 pub ticks_remaining: i32,
762 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
763 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
764 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
766 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
767 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
769 /// For users who don't want to bother doing their own payment preimage storage, we also store that
772 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
773 /// and instead encoding it in the payment secret.
774 struct PendingInboundPayment {
775 /// The payment secret that the sender must use for us to accept this payment
776 payment_secret: PaymentSecret,
777 /// Time at which this HTLC expires - blocks with a header time above this value will result in
778 /// this payment being removed.
780 /// Arbitrary identifier the user specifies (or not)
781 user_payment_id: u64,
782 // Other required attributes of the payment, optionally enforced:
783 payment_preimage: Option<PaymentPreimage>,
784 min_value_msat: Option<u64>,
787 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
788 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
789 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
790 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
791 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
792 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
793 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
794 /// of [`KeysManager`] and [`DefaultRouter`].
796 /// This is not exported to bindings users as Arcs don't make sense in bindings
797 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
805 Arc<NetworkGraph<Arc<L>>>,
807 Arc<RwLock<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
808 ProbabilisticScoringFeeParameters,
809 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
814 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
815 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
816 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
817 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
818 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
819 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
820 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
821 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
822 /// of [`KeysManager`] and [`DefaultRouter`].
824 /// This is not exported to bindings users as Arcs don't make sense in bindings
825 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
834 &'f NetworkGraph<&'g L>,
836 &'h RwLock<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
837 ProbabilisticScoringFeeParameters,
838 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
843 /// A trivial trait which describes any [`ChannelManager`].
845 /// This is not exported to bindings users as general cover traits aren't useful in other
847 pub trait AChannelManager {
848 /// A type implementing [`chain::Watch`].
849 type Watch: chain::Watch<Self::Signer> + ?Sized;
850 /// A type that may be dereferenced to [`Self::Watch`].
851 type M: Deref<Target = Self::Watch>;
852 /// A type implementing [`BroadcasterInterface`].
853 type Broadcaster: BroadcasterInterface + ?Sized;
854 /// A type that may be dereferenced to [`Self::Broadcaster`].
855 type T: Deref<Target = Self::Broadcaster>;
856 /// A type implementing [`EntropySource`].
857 type EntropySource: EntropySource + ?Sized;
858 /// A type that may be dereferenced to [`Self::EntropySource`].
859 type ES: Deref<Target = Self::EntropySource>;
860 /// A type implementing [`NodeSigner`].
861 type NodeSigner: NodeSigner + ?Sized;
862 /// A type that may be dereferenced to [`Self::NodeSigner`].
863 type NS: Deref<Target = Self::NodeSigner>;
864 /// A type implementing [`WriteableEcdsaChannelSigner`].
865 type Signer: WriteableEcdsaChannelSigner + Sized;
866 /// A type implementing [`SignerProvider`] for [`Self::Signer`].
867 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
868 /// A type that may be dereferenced to [`Self::SignerProvider`].
869 type SP: Deref<Target = Self::SignerProvider>;
870 /// A type implementing [`FeeEstimator`].
871 type FeeEstimator: FeeEstimator + ?Sized;
872 /// A type that may be dereferenced to [`Self::FeeEstimator`].
873 type F: Deref<Target = Self::FeeEstimator>;
874 /// A type implementing [`Router`].
875 type Router: Router + ?Sized;
876 /// A type that may be dereferenced to [`Self::Router`].
877 type R: Deref<Target = Self::Router>;
878 /// A type implementing [`Logger`].
879 type Logger: Logger + ?Sized;
880 /// A type that may be dereferenced to [`Self::Logger`].
881 type L: Deref<Target = Self::Logger>;
882 /// Returns a reference to the actual [`ChannelManager`] object.
883 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
886 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
887 for ChannelManager<M, T, ES, NS, SP, F, R, L>
889 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
890 T::Target: BroadcasterInterface,
891 ES::Target: EntropySource,
892 NS::Target: NodeSigner,
893 SP::Target: SignerProvider,
894 F::Target: FeeEstimator,
898 type Watch = M::Target;
900 type Broadcaster = T::Target;
902 type EntropySource = ES::Target;
904 type NodeSigner = NS::Target;
906 type Signer = <SP::Target as SignerProvider>::Signer;
907 type SignerProvider = SP::Target;
909 type FeeEstimator = F::Target;
911 type Router = R::Target;
913 type Logger = L::Target;
915 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
918 /// Manager which keeps track of a number of channels and sends messages to the appropriate
919 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
921 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
922 /// to individual Channels.
924 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
925 /// all peers during write/read (though does not modify this instance, only the instance being
926 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
927 /// called [`funding_transaction_generated`] for outbound channels) being closed.
929 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
930 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST durably write each
931 /// [`ChannelMonitorUpdate`] before returning from
932 /// [`chain::Watch::watch_channel`]/[`update_channel`] or before completing async writes. With
933 /// `ChannelManager`s, writing updates happens out-of-band (and will prevent any other
934 /// `ChannelManager` operations from occurring during the serialization process). If the
935 /// deserialized version is out-of-date compared to the [`ChannelMonitor`] passed by reference to
936 /// [`read`], those channels will be force-closed based on the `ChannelMonitor` state and no funds
937 /// will be lost (modulo on-chain transaction fees).
939 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
940 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
941 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
943 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
944 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
945 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
946 /// offline for a full minute. In order to track this, you must call
947 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
949 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
950 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
951 /// not have a channel with being unable to connect to us or open new channels with us if we have
952 /// many peers with unfunded channels.
954 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
955 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
956 /// never limited. Please ensure you limit the count of such channels yourself.
958 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
959 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
960 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
961 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
962 /// you're using lightning-net-tokio.
964 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
965 /// [`funding_created`]: msgs::FundingCreated
966 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
967 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
968 /// [`update_channel`]: chain::Watch::update_channel
969 /// [`ChannelUpdate`]: msgs::ChannelUpdate
970 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
971 /// [`read`]: ReadableArgs::read
974 // The tree structure below illustrates the lock order requirements for the different locks of the
975 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
976 // and should then be taken in the order of the lowest to the highest level in the tree.
977 // Note that locks on different branches shall not be taken at the same time, as doing so will
978 // create a new lock order for those specific locks in the order they were taken.
982 // `total_consistency_lock`
984 // |__`forward_htlcs`
986 // | |__`pending_intercepted_htlcs`
988 // |__`per_peer_state`
990 // | |__`pending_inbound_payments`
992 // | |__`claimable_payments`
994 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
1000 // | |__`short_to_chan_info`
1002 // | |__`outbound_scid_aliases`
1004 // | |__`best_block`
1006 // | |__`pending_events`
1008 // | |__`pending_background_events`
1010 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
1012 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
1013 T::Target: BroadcasterInterface,
1014 ES::Target: EntropySource,
1015 NS::Target: NodeSigner,
1016 SP::Target: SignerProvider,
1017 F::Target: FeeEstimator,
1021 default_configuration: UserConfig,
1022 chain_hash: ChainHash,
1023 fee_estimator: LowerBoundedFeeEstimator<F>,
1029 /// See `ChannelManager` struct-level documentation for lock order requirements.
1031 pub(super) best_block: RwLock<BestBlock>,
1033 best_block: RwLock<BestBlock>,
1034 secp_ctx: Secp256k1<secp256k1::All>,
1036 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1037 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1038 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1039 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1041 /// See `ChannelManager` struct-level documentation for lock order requirements.
1042 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1044 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1045 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1046 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1047 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1048 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1049 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1050 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1051 /// after reloading from disk while replaying blocks against ChannelMonitors.
1053 /// See `PendingOutboundPayment` documentation for more info.
1055 /// See `ChannelManager` struct-level documentation for lock order requirements.
1056 pending_outbound_payments: OutboundPayments,
1058 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1060 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1061 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1062 /// and via the classic SCID.
1064 /// Note that no consistency guarantees are made about the existence of a channel with the
1065 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1067 /// See `ChannelManager` struct-level documentation for lock order requirements.
1069 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1071 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1072 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1073 /// until the user tells us what we should do with them.
1075 /// See `ChannelManager` struct-level documentation for lock order requirements.
1076 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1078 /// The sets of payments which are claimable or currently being claimed. See
1079 /// [`ClaimablePayments`]' individual field docs for more info.
1081 /// See `ChannelManager` struct-level documentation for lock order requirements.
1082 claimable_payments: Mutex<ClaimablePayments>,
1084 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1085 /// and some closed channels which reached a usable state prior to being closed. This is used
1086 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1087 /// active channel list on load.
1089 /// See `ChannelManager` struct-level documentation for lock order requirements.
1090 outbound_scid_aliases: Mutex<HashSet<u64>>,
1092 /// `channel_id` -> `counterparty_node_id`.
1094 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1095 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1096 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1098 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1099 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1100 /// the handling of the events.
1102 /// Note that no consistency guarantees are made about the existence of a peer with the
1103 /// `counterparty_node_id` in our other maps.
1106 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1107 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1108 /// would break backwards compatability.
1109 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1110 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1111 /// required to access the channel with the `counterparty_node_id`.
1113 /// See `ChannelManager` struct-level documentation for lock order requirements.
1114 id_to_peer: Mutex<HashMap<ChannelId, PublicKey>>,
1116 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1118 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1119 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1120 /// confirmation depth.
1122 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1123 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1124 /// channel with the `channel_id` in our other maps.
1126 /// See `ChannelManager` struct-level documentation for lock order requirements.
1128 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1130 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1132 our_network_pubkey: PublicKey,
1134 inbound_payment_key: inbound_payment::ExpandedKey,
1136 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1137 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1138 /// we encrypt the namespace identifier using these bytes.
1140 /// [fake scids]: crate::util::scid_utils::fake_scid
1141 fake_scid_rand_bytes: [u8; 32],
1143 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1144 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1145 /// keeping additional state.
1146 probing_cookie_secret: [u8; 32],
1148 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1149 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1150 /// very far in the past, and can only ever be up to two hours in the future.
1151 highest_seen_timestamp: AtomicUsize,
1153 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1154 /// basis, as well as the peer's latest features.
1156 /// If we are connected to a peer we always at least have an entry here, even if no channels
1157 /// are currently open with that peer.
1159 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1160 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1163 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1165 /// See `ChannelManager` struct-level documentation for lock order requirements.
1166 #[cfg(not(any(test, feature = "_test_utils")))]
1167 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1168 #[cfg(any(test, feature = "_test_utils"))]
1169 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1171 /// The set of events which we need to give to the user to handle. In some cases an event may
1172 /// require some further action after the user handles it (currently only blocking a monitor
1173 /// update from being handed to the user to ensure the included changes to the channel state
1174 /// are handled by the user before they're persisted durably to disk). In that case, the second
1175 /// element in the tuple is set to `Some` with further details of the action.
1177 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1178 /// could be in the middle of being processed without the direct mutex held.
1180 /// See `ChannelManager` struct-level documentation for lock order requirements.
1181 #[cfg(not(any(test, feature = "_test_utils")))]
1182 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1183 #[cfg(any(test, feature = "_test_utils"))]
1184 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1186 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1187 pending_events_processor: AtomicBool,
1189 /// If we are running during init (either directly during the deserialization method or in
1190 /// block connection methods which run after deserialization but before normal operation) we
1191 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1192 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1193 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1195 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1197 /// See `ChannelManager` struct-level documentation for lock order requirements.
1199 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1200 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1201 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1202 /// Essentially just when we're serializing ourselves out.
1203 /// Taken first everywhere where we are making changes before any other locks.
1204 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1205 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1206 /// Notifier the lock contains sends out a notification when the lock is released.
1207 total_consistency_lock: RwLock<()>,
1208 /// Tracks the progress of channels going through batch funding by whether funding_signed was
1209 /// received and the monitor has been persisted.
1211 /// This information does not need to be persisted as funding nodes can forget
1212 /// unfunded channels upon disconnection.
1213 funding_batch_states: Mutex<BTreeMap<Txid, Vec<(ChannelId, PublicKey, bool)>>>,
1215 background_events_processed_since_startup: AtomicBool,
1217 event_persist_notifier: Notifier,
1218 needs_persist_flag: AtomicBool,
1222 signer_provider: SP,
1227 /// Chain-related parameters used to construct a new `ChannelManager`.
1229 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1230 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1231 /// are not needed when deserializing a previously constructed `ChannelManager`.
1232 #[derive(Clone, Copy, PartialEq)]
1233 pub struct ChainParameters {
1234 /// The network for determining the `chain_hash` in Lightning messages.
1235 pub network: Network,
1237 /// The hash and height of the latest block successfully connected.
1239 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1240 pub best_block: BestBlock,
1243 #[derive(Copy, Clone, PartialEq)]
1247 SkipPersistHandleEvents,
1248 SkipPersistNoEvents,
1251 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1252 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1253 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1254 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1255 /// sending the aforementioned notification (since the lock being released indicates that the
1256 /// updates are ready for persistence).
1258 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1259 /// notify or not based on whether relevant changes have been made, providing a closure to
1260 /// `optionally_notify` which returns a `NotifyOption`.
1261 struct PersistenceNotifierGuard<'a, F: FnMut() -> NotifyOption> {
1262 event_persist_notifier: &'a Notifier,
1263 needs_persist_flag: &'a AtomicBool,
1265 // We hold onto this result so the lock doesn't get released immediately.
1266 _read_guard: RwLockReadGuard<'a, ()>,
1269 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1270 /// Notifies any waiters and indicates that we need to persist, in addition to possibly having
1271 /// events to handle.
1273 /// This must always be called if the changes included a `ChannelMonitorUpdate`, as well as in
1274 /// other cases where losing the changes on restart may result in a force-close or otherwise
1276 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1277 Self::optionally_notify(cm, || -> NotifyOption { NotifyOption::DoPersist })
1280 fn optionally_notify<F: FnMut() -> NotifyOption, C: AChannelManager>(cm: &'a C, mut persist_check: F)
1281 -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1282 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1283 let force_notify = cm.get_cm().process_background_events();
1285 PersistenceNotifierGuard {
1286 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1287 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1288 should_persist: move || {
1289 // Pick the "most" action between `persist_check` and the background events
1290 // processing and return that.
1291 let notify = persist_check();
1292 match (notify, force_notify) {
1293 (NotifyOption::DoPersist, _) => NotifyOption::DoPersist,
1294 (_, NotifyOption::DoPersist) => NotifyOption::DoPersist,
1295 (NotifyOption::SkipPersistHandleEvents, _) => NotifyOption::SkipPersistHandleEvents,
1296 (_, NotifyOption::SkipPersistHandleEvents) => NotifyOption::SkipPersistHandleEvents,
1297 _ => NotifyOption::SkipPersistNoEvents,
1300 _read_guard: read_guard,
1304 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1305 /// [`ChannelManager::process_background_events`] MUST be called first (or
1306 /// [`Self::optionally_notify`] used).
1307 fn optionally_notify_skipping_background_events<F: Fn() -> NotifyOption, C: AChannelManager>
1308 (cm: &'a C, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1309 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1311 PersistenceNotifierGuard {
1312 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1313 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1314 should_persist: persist_check,
1315 _read_guard: read_guard,
1320 impl<'a, F: FnMut() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1321 fn drop(&mut self) {
1322 match (self.should_persist)() {
1323 NotifyOption::DoPersist => {
1324 self.needs_persist_flag.store(true, Ordering::Release);
1325 self.event_persist_notifier.notify()
1327 NotifyOption::SkipPersistHandleEvents =>
1328 self.event_persist_notifier.notify(),
1329 NotifyOption::SkipPersistNoEvents => {},
1334 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1335 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1337 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1339 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1340 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1341 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1342 /// the maximum required amount in lnd as of March 2021.
1343 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1345 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1346 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1348 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1350 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1351 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1352 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1353 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1354 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1355 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1356 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1357 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1358 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1359 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1360 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1361 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1362 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1364 /// Minimum CLTV difference between the current block height and received inbound payments.
1365 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1367 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1368 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1369 // a payment was being routed, so we add an extra block to be safe.
1370 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1372 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1373 // ie that if the next-hop peer fails the HTLC within
1374 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1375 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1376 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1377 // LATENCY_GRACE_PERIOD_BLOCKS.
1380 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;
1382 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1383 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1386 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1388 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1389 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1391 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1392 /// until we mark the channel disabled and gossip the update.
1393 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1395 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1396 /// we mark the channel enabled and gossip the update.
1397 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1399 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1400 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1401 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1402 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1404 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1405 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1406 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1408 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1409 /// many peers we reject new (inbound) connections.
1410 const MAX_NO_CHANNEL_PEERS: usize = 250;
1412 /// Information needed for constructing an invoice route hint for this channel.
1413 #[derive(Clone, Debug, PartialEq)]
1414 pub struct CounterpartyForwardingInfo {
1415 /// Base routing fee in millisatoshis.
1416 pub fee_base_msat: u32,
1417 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1418 pub fee_proportional_millionths: u32,
1419 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1420 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1421 /// `cltv_expiry_delta` for more details.
1422 pub cltv_expiry_delta: u16,
1425 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1426 /// to better separate parameters.
1427 #[derive(Clone, Debug, PartialEq)]
1428 pub struct ChannelCounterparty {
1429 /// The node_id of our counterparty
1430 pub node_id: PublicKey,
1431 /// The Features the channel counterparty provided upon last connection.
1432 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1433 /// many routing-relevant features are present in the init context.
1434 pub features: InitFeatures,
1435 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1436 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1437 /// claiming at least this value on chain.
1439 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1441 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1442 pub unspendable_punishment_reserve: u64,
1443 /// Information on the fees and requirements that the counterparty requires when forwarding
1444 /// payments to us through this channel.
1445 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1446 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1447 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1448 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1449 pub outbound_htlc_minimum_msat: Option<u64>,
1450 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1451 pub outbound_htlc_maximum_msat: Option<u64>,
1454 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1455 #[derive(Clone, Debug, PartialEq)]
1456 pub struct ChannelDetails {
1457 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1458 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1459 /// Note that this means this value is *not* persistent - it can change once during the
1460 /// lifetime of the channel.
1461 pub channel_id: ChannelId,
1462 /// Parameters which apply to our counterparty. See individual fields for more information.
1463 pub counterparty: ChannelCounterparty,
1464 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1465 /// our counterparty already.
1467 /// Note that, if this has been set, `channel_id` will be equivalent to
1468 /// `funding_txo.unwrap().to_channel_id()`.
1469 pub funding_txo: Option<OutPoint>,
1470 /// The features which this channel operates with. See individual features for more info.
1472 /// `None` until negotiation completes and the channel type is finalized.
1473 pub channel_type: Option<ChannelTypeFeatures>,
1474 /// The position of the funding transaction in the chain. None if the funding transaction has
1475 /// not yet been confirmed and the channel fully opened.
1477 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1478 /// payments instead of this. See [`get_inbound_payment_scid`].
1480 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1481 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1483 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1484 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1485 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1486 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1487 /// [`confirmations_required`]: Self::confirmations_required
1488 pub short_channel_id: Option<u64>,
1489 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1490 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1491 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1494 /// This will be `None` as long as the channel is not available for routing outbound payments.
1496 /// [`short_channel_id`]: Self::short_channel_id
1497 /// [`confirmations_required`]: Self::confirmations_required
1498 pub outbound_scid_alias: Option<u64>,
1499 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1500 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1501 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1502 /// when they see a payment to be routed to us.
1504 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1505 /// previous values for inbound payment forwarding.
1507 /// [`short_channel_id`]: Self::short_channel_id
1508 pub inbound_scid_alias: Option<u64>,
1509 /// The value, in satoshis, of this channel as appears in the funding output
1510 pub channel_value_satoshis: u64,
1511 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1512 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1513 /// this value on chain.
1515 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1517 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1519 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1520 pub unspendable_punishment_reserve: Option<u64>,
1521 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1522 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1523 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1524 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1525 /// serialized with LDK versions prior to 0.0.113.
1527 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1528 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1529 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1530 pub user_channel_id: u128,
1531 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1532 /// which is applied to commitment and HTLC transactions.
1534 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1535 pub feerate_sat_per_1000_weight: Option<u32>,
1536 /// Our total balance. This is the amount we would get if we close the channel.
1537 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1538 /// amount is not likely to be recoverable on close.
1540 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1541 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1542 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1543 /// This does not consider any on-chain fees.
1545 /// See also [`ChannelDetails::outbound_capacity_msat`]
1546 pub balance_msat: u64,
1547 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1548 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1549 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1550 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1552 /// See also [`ChannelDetails::balance_msat`]
1554 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1555 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1556 /// should be able to spend nearly this amount.
1557 pub outbound_capacity_msat: u64,
1558 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1559 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1560 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1561 /// to use a limit as close as possible to the HTLC limit we can currently send.
1563 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1564 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1565 pub next_outbound_htlc_limit_msat: u64,
1566 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1567 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1568 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1569 /// route which is valid.
1570 pub next_outbound_htlc_minimum_msat: u64,
1571 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1572 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1573 /// available for inclusion in new inbound HTLCs).
1574 /// Note that there are some corner cases not fully handled here, so the actual available
1575 /// inbound capacity may be slightly higher than this.
1577 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1578 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1579 /// However, our counterparty should be able to spend nearly this amount.
1580 pub inbound_capacity_msat: u64,
1581 /// The number of required confirmations on the funding transaction before the funding will be
1582 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1583 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1584 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1585 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1587 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1589 /// [`is_outbound`]: ChannelDetails::is_outbound
1590 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1591 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1592 pub confirmations_required: Option<u32>,
1593 /// The current number of confirmations on the funding transaction.
1595 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1596 pub confirmations: Option<u32>,
1597 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1598 /// until we can claim our funds after we force-close the channel. During this time our
1599 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1600 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1601 /// time to claim our non-HTLC-encumbered funds.
1603 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1604 pub force_close_spend_delay: Option<u16>,
1605 /// True if the channel was initiated (and thus funded) by us.
1606 pub is_outbound: bool,
1607 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1608 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1609 /// required confirmation count has been reached (and we were connected to the peer at some
1610 /// point after the funding transaction received enough confirmations). The required
1611 /// confirmation count is provided in [`confirmations_required`].
1613 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1614 pub is_channel_ready: bool,
1615 /// The stage of the channel's shutdown.
1616 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1617 pub channel_shutdown_state: Option<ChannelShutdownState>,
1618 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1619 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1621 /// This is a strict superset of `is_channel_ready`.
1622 pub is_usable: bool,
1623 /// True if this channel is (or will be) publicly-announced.
1624 pub is_public: bool,
1625 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1626 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1627 pub inbound_htlc_minimum_msat: Option<u64>,
1628 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1629 pub inbound_htlc_maximum_msat: Option<u64>,
1630 /// Set of configurable parameters that affect channel operation.
1632 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1633 pub config: Option<ChannelConfig>,
1636 impl ChannelDetails {
1637 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1638 /// This should be used for providing invoice hints or in any other context where our
1639 /// counterparty will forward a payment to us.
1641 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1642 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1643 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1644 self.inbound_scid_alias.or(self.short_channel_id)
1647 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1648 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1649 /// we're sending or forwarding a payment outbound over this channel.
1651 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1652 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1653 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1654 self.short_channel_id.or(self.outbound_scid_alias)
1657 fn from_channel_context<SP: Deref, F: Deref>(
1658 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1659 fee_estimator: &LowerBoundedFeeEstimator<F>
1662 SP::Target: SignerProvider,
1663 F::Target: FeeEstimator
1665 let balance = context.get_available_balances(fee_estimator);
1666 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1667 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1669 channel_id: context.channel_id(),
1670 counterparty: ChannelCounterparty {
1671 node_id: context.get_counterparty_node_id(),
1672 features: latest_features,
1673 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1674 forwarding_info: context.counterparty_forwarding_info(),
1675 // Ensures that we have actually received the `htlc_minimum_msat` value
1676 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1677 // message (as they are always the first message from the counterparty).
1678 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1679 // default `0` value set by `Channel::new_outbound`.
1680 outbound_htlc_minimum_msat: if context.have_received_message() {
1681 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1682 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1684 funding_txo: context.get_funding_txo(),
1685 // Note that accept_channel (or open_channel) is always the first message, so
1686 // `have_received_message` indicates that type negotiation has completed.
1687 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1688 short_channel_id: context.get_short_channel_id(),
1689 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1690 inbound_scid_alias: context.latest_inbound_scid_alias(),
1691 channel_value_satoshis: context.get_value_satoshis(),
1692 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1693 unspendable_punishment_reserve: to_self_reserve_satoshis,
1694 balance_msat: balance.balance_msat,
1695 inbound_capacity_msat: balance.inbound_capacity_msat,
1696 outbound_capacity_msat: balance.outbound_capacity_msat,
1697 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1698 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1699 user_channel_id: context.get_user_id(),
1700 confirmations_required: context.minimum_depth(),
1701 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1702 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1703 is_outbound: context.is_outbound(),
1704 is_channel_ready: context.is_usable(),
1705 is_usable: context.is_live(),
1706 is_public: context.should_announce(),
1707 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1708 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1709 config: Some(context.config()),
1710 channel_shutdown_state: Some(context.shutdown_state()),
1715 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1716 /// Further information on the details of the channel shutdown.
1717 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1718 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1719 /// the channel will be removed shortly.
1720 /// Also note, that in normal operation, peers could disconnect at any of these states
1721 /// and require peer re-connection before making progress onto other states
1722 pub enum ChannelShutdownState {
1723 /// Channel has not sent or received a shutdown message.
1725 /// Local node has sent a shutdown message for this channel.
1727 /// Shutdown message exchanges have concluded and the channels are in the midst of
1728 /// resolving all existing open HTLCs before closing can continue.
1730 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1731 NegotiatingClosingFee,
1732 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1733 /// to drop the channel.
1737 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1738 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1739 #[derive(Debug, PartialEq)]
1740 pub enum RecentPaymentDetails {
1741 /// When an invoice was requested and thus a payment has not yet been sent.
1743 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1744 /// a payment and ensure idempotency in LDK.
1745 payment_id: PaymentId,
1747 /// When a payment is still being sent and awaiting successful delivery.
1749 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1750 /// a payment and ensure idempotency in LDK.
1751 payment_id: PaymentId,
1752 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1754 payment_hash: PaymentHash,
1755 /// Total amount (in msat, excluding fees) across all paths for this payment,
1756 /// not just the amount currently inflight.
1759 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1760 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1761 /// payment is removed from tracking.
1763 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1764 /// a payment and ensure idempotency in LDK.
1765 payment_id: PaymentId,
1766 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1767 /// made before LDK version 0.0.104.
1768 payment_hash: Option<PaymentHash>,
1770 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1771 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1772 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1774 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1775 /// a payment and ensure idempotency in LDK.
1776 payment_id: PaymentId,
1777 /// Hash of the payment that we have given up trying to send.
1778 payment_hash: PaymentHash,
1782 /// Route hints used in constructing invoices for [phantom node payents].
1784 /// [phantom node payments]: crate::sign::PhantomKeysManager
1786 pub struct PhantomRouteHints {
1787 /// The list of channels to be included in the invoice route hints.
1788 pub channels: Vec<ChannelDetails>,
1789 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1791 pub phantom_scid: u64,
1792 /// The pubkey of the real backing node that would ultimately receive the payment.
1793 pub real_node_pubkey: PublicKey,
1796 macro_rules! handle_error {
1797 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1798 // In testing, ensure there are no deadlocks where the lock is already held upon
1799 // entering the macro.
1800 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1801 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1805 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish, channel_capacity }) => {
1806 let mut msg_events = Vec::with_capacity(2);
1808 if let Some((shutdown_res, update_option)) = shutdown_finish {
1809 $self.finish_close_channel(shutdown_res);
1810 if let Some(update) = update_option {
1811 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1815 if let Some((channel_id, user_channel_id)) = chan_id {
1816 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1817 channel_id, user_channel_id,
1818 reason: ClosureReason::ProcessingError { err: err.err.clone() },
1819 counterparty_node_id: Some($counterparty_node_id),
1820 channel_capacity_sats: channel_capacity,
1825 log_error!($self.logger, "{}", err.err);
1826 if let msgs::ErrorAction::IgnoreError = err.action {
1828 msg_events.push(events::MessageSendEvent::HandleError {
1829 node_id: $counterparty_node_id,
1830 action: err.action.clone()
1834 if !msg_events.is_empty() {
1835 let per_peer_state = $self.per_peer_state.read().unwrap();
1836 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1837 let mut peer_state = peer_state_mutex.lock().unwrap();
1838 peer_state.pending_msg_events.append(&mut msg_events);
1842 // Return error in case higher-API need one
1847 ($self: ident, $internal: expr) => {
1850 Err((chan, msg_handle_err)) => {
1851 let counterparty_node_id = chan.get_counterparty_node_id();
1852 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1858 macro_rules! update_maps_on_chan_removal {
1859 ($self: expr, $channel_context: expr) => {{
1860 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1861 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1862 if let Some(short_id) = $channel_context.get_short_channel_id() {
1863 short_to_chan_info.remove(&short_id);
1865 // If the channel was never confirmed on-chain prior to its closure, remove the
1866 // outbound SCID alias we used for it from the collision-prevention set. While we
1867 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1868 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1869 // opening a million channels with us which are closed before we ever reach the funding
1871 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1872 debug_assert!(alias_removed);
1874 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1878 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1879 macro_rules! convert_chan_phase_err {
1880 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
1882 ChannelError::Warn(msg) => {
1883 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
1885 ChannelError::Ignore(msg) => {
1886 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
1888 ChannelError::Close(msg) => {
1889 log_error!($self.logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
1890 update_maps_on_chan_removal!($self, $channel.context);
1891 let shutdown_res = $channel.context.force_shutdown(true);
1892 let user_id = $channel.context.get_user_id();
1893 let channel_capacity_satoshis = $channel.context.get_value_satoshis();
1895 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, user_id,
1896 shutdown_res, $channel_update, channel_capacity_satoshis))
1900 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
1901 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
1903 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
1904 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
1906 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
1907 match $channel_phase {
1908 ChannelPhase::Funded(channel) => {
1909 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
1911 ChannelPhase::UnfundedOutboundV1(channel) => {
1912 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1914 ChannelPhase::UnfundedInboundV1(channel) => {
1915 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1921 macro_rules! break_chan_phase_entry {
1922 ($self: ident, $res: expr, $entry: expr) => {
1926 let key = *$entry.key();
1927 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1929 $entry.remove_entry();
1937 macro_rules! try_chan_phase_entry {
1938 ($self: ident, $res: expr, $entry: expr) => {
1942 let key = *$entry.key();
1943 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1945 $entry.remove_entry();
1953 macro_rules! remove_channel_phase {
1954 ($self: expr, $entry: expr) => {
1956 let channel = $entry.remove_entry().1;
1957 update_maps_on_chan_removal!($self, &channel.context());
1963 macro_rules! send_channel_ready {
1964 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1965 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1966 node_id: $channel.context.get_counterparty_node_id(),
1967 msg: $channel_ready_msg,
1969 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1970 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1971 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1972 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1973 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1974 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1975 if let Some(real_scid) = $channel.context.get_short_channel_id() {
1976 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1977 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1978 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1983 macro_rules! emit_channel_pending_event {
1984 ($locked_events: expr, $channel: expr) => {
1985 if $channel.context.should_emit_channel_pending_event() {
1986 $locked_events.push_back((events::Event::ChannelPending {
1987 channel_id: $channel.context.channel_id(),
1988 former_temporary_channel_id: $channel.context.temporary_channel_id(),
1989 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1990 user_channel_id: $channel.context.get_user_id(),
1991 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1993 $channel.context.set_channel_pending_event_emitted();
1998 macro_rules! emit_channel_ready_event {
1999 ($locked_events: expr, $channel: expr) => {
2000 if $channel.context.should_emit_channel_ready_event() {
2001 debug_assert!($channel.context.channel_pending_event_emitted());
2002 $locked_events.push_back((events::Event::ChannelReady {
2003 channel_id: $channel.context.channel_id(),
2004 user_channel_id: $channel.context.get_user_id(),
2005 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2006 channel_type: $channel.context.get_channel_type().clone(),
2008 $channel.context.set_channel_ready_event_emitted();
2013 macro_rules! handle_monitor_update_completion {
2014 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2015 let mut updates = $chan.monitor_updating_restored(&$self.logger,
2016 &$self.node_signer, $self.chain_hash, &$self.default_configuration,
2017 $self.best_block.read().unwrap().height());
2018 let counterparty_node_id = $chan.context.get_counterparty_node_id();
2019 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
2020 // We only send a channel_update in the case where we are just now sending a
2021 // channel_ready and the channel is in a usable state. We may re-send a
2022 // channel_update later through the announcement_signatures process for public
2023 // channels, but there's no reason not to just inform our counterparty of our fees
2025 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
2026 Some(events::MessageSendEvent::SendChannelUpdate {
2027 node_id: counterparty_node_id,
2033 let update_actions = $peer_state.monitor_update_blocked_actions
2034 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
2036 let htlc_forwards = $self.handle_channel_resumption(
2037 &mut $peer_state.pending_msg_events, $chan, updates.raa,
2038 updates.commitment_update, updates.order, updates.accepted_htlcs,
2039 updates.funding_broadcastable, updates.channel_ready,
2040 updates.announcement_sigs);
2041 if let Some(upd) = channel_update {
2042 $peer_state.pending_msg_events.push(upd);
2045 let channel_id = $chan.context.channel_id();
2046 let unbroadcasted_batch_funding_txid = $chan.context.unbroadcasted_batch_funding_txid();
2047 core::mem::drop($peer_state_lock);
2048 core::mem::drop($per_peer_state_lock);
2050 // If the channel belongs to a batch funding transaction, the progress of the batch
2051 // should be updated as we have received funding_signed and persisted the monitor.
2052 if let Some(txid) = unbroadcasted_batch_funding_txid {
2053 let mut funding_batch_states = $self.funding_batch_states.lock().unwrap();
2054 let mut batch_completed = false;
2055 if let Some(batch_state) = funding_batch_states.get_mut(&txid) {
2056 let channel_state = batch_state.iter_mut().find(|(chan_id, pubkey, _)| (
2057 *chan_id == channel_id &&
2058 *pubkey == counterparty_node_id
2060 if let Some(channel_state) = channel_state {
2061 channel_state.2 = true;
2063 debug_assert!(false, "Missing channel batch state for channel which completed initial monitor update");
2065 batch_completed = batch_state.iter().all(|(_, _, completed)| *completed);
2067 debug_assert!(false, "Missing batch state for channel which completed initial monitor update");
2070 // When all channels in a batched funding transaction have become ready, it is not necessary
2071 // to track the progress of the batch anymore and the state of the channels can be updated.
2072 if batch_completed {
2073 let removed_batch_state = funding_batch_states.remove(&txid).into_iter().flatten();
2074 let per_peer_state = $self.per_peer_state.read().unwrap();
2075 let mut batch_funding_tx = None;
2076 for (channel_id, counterparty_node_id, _) in removed_batch_state {
2077 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2078 let mut peer_state = peer_state_mutex.lock().unwrap();
2079 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
2080 batch_funding_tx = batch_funding_tx.or_else(|| chan.context.unbroadcasted_funding());
2081 chan.set_batch_ready();
2082 let mut pending_events = $self.pending_events.lock().unwrap();
2083 emit_channel_pending_event!(pending_events, chan);
2087 if let Some(tx) = batch_funding_tx {
2088 log_info!($self.logger, "Broadcasting batch funding transaction with txid {}", tx.txid());
2089 $self.tx_broadcaster.broadcast_transactions(&[&tx]);
2094 $self.handle_monitor_update_completion_actions(update_actions);
2096 if let Some(forwards) = htlc_forwards {
2097 $self.forward_htlcs(&mut [forwards][..]);
2099 $self.finalize_claims(updates.finalized_claimed_htlcs);
2100 for failure in updates.failed_htlcs.drain(..) {
2101 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2102 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2107 macro_rules! handle_new_monitor_update {
2108 ($self: ident, $update_res: expr, $chan: expr, _internal, $completed: expr) => { {
2109 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2111 ChannelMonitorUpdateStatus::UnrecoverableError => {
2112 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
2113 log_error!($self.logger, "{}", err_str);
2114 panic!("{}", err_str);
2116 ChannelMonitorUpdateStatus::InProgress => {
2117 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2118 &$chan.context.channel_id());
2121 ChannelMonitorUpdateStatus::Completed => {
2127 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, INITIAL_MONITOR) => {
2128 handle_new_monitor_update!($self, $update_res, $chan, _internal,
2129 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2131 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2132 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2133 .or_insert_with(Vec::new);
2134 // During startup, we push monitor updates as background events through to here in
2135 // order to replay updates that were in-flight when we shut down. Thus, we have to
2136 // filter for uniqueness here.
2137 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2138 .unwrap_or_else(|| {
2139 in_flight_updates.push($update);
2140 in_flight_updates.len() - 1
2142 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2143 handle_new_monitor_update!($self, update_res, $chan, _internal,
2145 let _ = in_flight_updates.remove(idx);
2146 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2147 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2153 macro_rules! process_events_body {
2154 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2155 let mut processed_all_events = false;
2156 while !processed_all_events {
2157 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2164 // We'll acquire our total consistency lock so that we can be sure no other
2165 // persists happen while processing monitor events.
2166 let _read_guard = $self.total_consistency_lock.read().unwrap();
2168 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2169 // ensure any startup-generated background events are handled first.
2170 result = $self.process_background_events();
2172 // TODO: This behavior should be documented. It's unintuitive that we query
2173 // ChannelMonitors when clearing other events.
2174 if $self.process_pending_monitor_events() {
2175 result = NotifyOption::DoPersist;
2179 let pending_events = $self.pending_events.lock().unwrap().clone();
2180 let num_events = pending_events.len();
2181 if !pending_events.is_empty() {
2182 result = NotifyOption::DoPersist;
2185 let mut post_event_actions = Vec::new();
2187 for (event, action_opt) in pending_events {
2188 $event_to_handle = event;
2190 if let Some(action) = action_opt {
2191 post_event_actions.push(action);
2196 let mut pending_events = $self.pending_events.lock().unwrap();
2197 pending_events.drain(..num_events);
2198 processed_all_events = pending_events.is_empty();
2199 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2200 // updated here with the `pending_events` lock acquired.
2201 $self.pending_events_processor.store(false, Ordering::Release);
2204 if !post_event_actions.is_empty() {
2205 $self.handle_post_event_actions(post_event_actions);
2206 // If we had some actions, go around again as we may have more events now
2207 processed_all_events = false;
2211 NotifyOption::DoPersist => {
2212 $self.needs_persist_flag.store(true, Ordering::Release);
2213 $self.event_persist_notifier.notify();
2215 NotifyOption::SkipPersistHandleEvents =>
2216 $self.event_persist_notifier.notify(),
2217 NotifyOption::SkipPersistNoEvents => {},
2223 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>
2225 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2226 T::Target: BroadcasterInterface,
2227 ES::Target: EntropySource,
2228 NS::Target: NodeSigner,
2229 SP::Target: SignerProvider,
2230 F::Target: FeeEstimator,
2234 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2236 /// The current time or latest block header time can be provided as the `current_timestamp`.
2238 /// This is the main "logic hub" for all channel-related actions, and implements
2239 /// [`ChannelMessageHandler`].
2241 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2243 /// Users need to notify the new `ChannelManager` when a new block is connected or
2244 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2245 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2248 /// [`block_connected`]: chain::Listen::block_connected
2249 /// [`block_disconnected`]: chain::Listen::block_disconnected
2250 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2252 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2253 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2254 current_timestamp: u32,
2256 let mut secp_ctx = Secp256k1::new();
2257 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2258 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2259 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2261 default_configuration: config.clone(),
2262 chain_hash: ChainHash::using_genesis_block(params.network),
2263 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2268 best_block: RwLock::new(params.best_block),
2270 outbound_scid_aliases: Mutex::new(HashSet::new()),
2271 pending_inbound_payments: Mutex::new(HashMap::new()),
2272 pending_outbound_payments: OutboundPayments::new(),
2273 forward_htlcs: Mutex::new(HashMap::new()),
2274 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2275 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2276 id_to_peer: Mutex::new(HashMap::new()),
2277 short_to_chan_info: FairRwLock::new(HashMap::new()),
2279 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2282 inbound_payment_key: expanded_inbound_key,
2283 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2285 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2287 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2289 per_peer_state: FairRwLock::new(HashMap::new()),
2291 pending_events: Mutex::new(VecDeque::new()),
2292 pending_events_processor: AtomicBool::new(false),
2293 pending_background_events: Mutex::new(Vec::new()),
2294 total_consistency_lock: RwLock::new(()),
2295 background_events_processed_since_startup: AtomicBool::new(false),
2296 event_persist_notifier: Notifier::new(),
2297 needs_persist_flag: AtomicBool::new(false),
2298 funding_batch_states: Mutex::new(BTreeMap::new()),
2308 /// Gets the current configuration applied to all new channels.
2309 pub fn get_current_default_configuration(&self) -> &UserConfig {
2310 &self.default_configuration
2313 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2314 let height = self.best_block.read().unwrap().height();
2315 let mut outbound_scid_alias = 0;
2318 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2319 outbound_scid_alias += 1;
2321 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2323 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2327 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"); }
2332 /// Creates a new outbound channel to the given remote node and with the given value.
2334 /// `user_channel_id` will be provided back as in
2335 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2336 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2337 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2338 /// is simply copied to events and otherwise ignored.
2340 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2341 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2343 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2344 /// generate a shutdown scriptpubkey or destination script set by
2345 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2347 /// Note that we do not check if you are currently connected to the given peer. If no
2348 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2349 /// the channel eventually being silently forgotten (dropped on reload).
2351 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2352 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2353 /// [`ChannelDetails::channel_id`] until after
2354 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2355 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2356 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2358 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2359 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2360 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2361 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<ChannelId, APIError> {
2362 if channel_value_satoshis < 1000 {
2363 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2366 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2367 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2368 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2370 let per_peer_state = self.per_peer_state.read().unwrap();
2372 let peer_state_mutex = per_peer_state.get(&their_network_key)
2373 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2375 let mut peer_state = peer_state_mutex.lock().unwrap();
2377 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2378 let their_features = &peer_state.latest_features;
2379 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2380 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2381 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2382 self.best_block.read().unwrap().height(), outbound_scid_alias)
2386 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2391 let res = channel.get_open_channel(self.chain_hash);
2393 let temporary_channel_id = channel.context.channel_id();
2394 match peer_state.channel_by_id.entry(temporary_channel_id) {
2395 hash_map::Entry::Occupied(_) => {
2397 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2399 panic!("RNG is bad???");
2402 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2405 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2406 node_id: their_network_key,
2409 Ok(temporary_channel_id)
2412 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2413 // Allocate our best estimate of the number of channels we have in the `res`
2414 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2415 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2416 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2417 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2418 // the same channel.
2419 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2421 let best_block_height = self.best_block.read().unwrap().height();
2422 let per_peer_state = self.per_peer_state.read().unwrap();
2423 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2424 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2425 let peer_state = &mut *peer_state_lock;
2426 res.extend(peer_state.channel_by_id.iter()
2427 .filter_map(|(chan_id, phase)| match phase {
2428 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2429 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2433 .map(|(_channel_id, channel)| {
2434 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2435 peer_state.latest_features.clone(), &self.fee_estimator)
2443 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2444 /// more information.
2445 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2446 // Allocate our best estimate of the number of channels we have in the `res`
2447 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2448 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2449 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2450 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2451 // the same channel.
2452 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2454 let best_block_height = self.best_block.read().unwrap().height();
2455 let per_peer_state = self.per_peer_state.read().unwrap();
2456 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2457 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2458 let peer_state = &mut *peer_state_lock;
2459 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2460 let details = ChannelDetails::from_channel_context(context, best_block_height,
2461 peer_state.latest_features.clone(), &self.fee_estimator);
2469 /// Gets the list of usable channels, in random order. Useful as an argument to
2470 /// [`Router::find_route`] to ensure non-announced channels are used.
2472 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2473 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2475 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2476 // Note we use is_live here instead of usable which leads to somewhat confused
2477 // internal/external nomenclature, but that's ok cause that's probably what the user
2478 // really wanted anyway.
2479 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2482 /// Gets the list of channels we have with a given counterparty, in random order.
2483 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2484 let best_block_height = self.best_block.read().unwrap().height();
2485 let per_peer_state = self.per_peer_state.read().unwrap();
2487 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2488 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2489 let peer_state = &mut *peer_state_lock;
2490 let features = &peer_state.latest_features;
2491 let context_to_details = |context| {
2492 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2494 return peer_state.channel_by_id
2496 .map(|(_, phase)| phase.context())
2497 .map(context_to_details)
2503 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2504 /// successful path, or have unresolved HTLCs.
2506 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2507 /// result of a crash. If such a payment exists, is not listed here, and an
2508 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2510 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2511 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2512 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2513 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2514 PendingOutboundPayment::AwaitingInvoice { .. } => {
2515 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2517 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2518 PendingOutboundPayment::InvoiceReceived { .. } => {
2519 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2521 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2522 Some(RecentPaymentDetails::Pending {
2523 payment_id: *payment_id,
2524 payment_hash: *payment_hash,
2525 total_msat: *total_msat,
2528 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2529 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2531 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2532 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2534 PendingOutboundPayment::Legacy { .. } => None
2539 /// Helper function that issues the channel close events
2540 fn issue_channel_close_events(&self, context: &ChannelContext<SP>, closure_reason: ClosureReason) {
2541 let mut pending_events_lock = self.pending_events.lock().unwrap();
2542 match context.unbroadcasted_funding() {
2543 Some(transaction) => {
2544 pending_events_lock.push_back((events::Event::DiscardFunding {
2545 channel_id: context.channel_id(), transaction
2550 pending_events_lock.push_back((events::Event::ChannelClosed {
2551 channel_id: context.channel_id(),
2552 user_channel_id: context.get_user_id(),
2553 reason: closure_reason,
2554 counterparty_node_id: Some(context.get_counterparty_node_id()),
2555 channel_capacity_sats: Some(context.get_value_satoshis()),
2559 fn close_channel_internal(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, override_shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2560 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2562 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2563 let mut shutdown_result = None;
2565 let per_peer_state = self.per_peer_state.read().unwrap();
2567 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2568 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2570 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2571 let peer_state = &mut *peer_state_lock;
2573 match peer_state.channel_by_id.entry(channel_id.clone()) {
2574 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2575 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2576 let funding_txo_opt = chan.context.get_funding_txo();
2577 let their_features = &peer_state.latest_features;
2578 let unbroadcasted_batch_funding_txid = chan.context.unbroadcasted_batch_funding_txid();
2579 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2580 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2581 failed_htlcs = htlcs;
2583 // We can send the `shutdown` message before updating the `ChannelMonitor`
2584 // here as we don't need the monitor update to complete until we send a
2585 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2586 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2587 node_id: *counterparty_node_id,
2591 debug_assert!(monitor_update_opt.is_none() || !chan.is_shutdown(),
2592 "We can't both complete shutdown and generate a monitor update");
2594 // Update the monitor with the shutdown script if necessary.
2595 if let Some(monitor_update) = monitor_update_opt.take() {
2596 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2597 peer_state_lock, peer_state, per_peer_state, chan);
2601 if chan.is_shutdown() {
2602 if let ChannelPhase::Funded(chan) = remove_channel_phase!(self, chan_phase_entry) {
2603 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&chan) {
2604 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2608 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
2609 shutdown_result = Some((None, Vec::new(), unbroadcasted_batch_funding_txid));
2615 hash_map::Entry::Vacant(_) => {
2616 // If we reach this point, it means that the channel_id either refers to an unfunded channel or
2617 // it does not exist for this peer. Either way, we can attempt to force-close it.
2619 // An appropriate error will be returned for non-existence of the channel if that's the case.
2620 mem::drop(peer_state_lock);
2621 mem::drop(per_peer_state);
2622 return self.force_close_channel_with_peer(&channel_id, counterparty_node_id, None, false).map(|_| ())
2627 for htlc_source in failed_htlcs.drain(..) {
2628 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2629 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2630 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2633 if let Some(shutdown_result) = shutdown_result {
2634 self.finish_close_channel(shutdown_result);
2640 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2641 /// will be accepted on the given channel, and after additional timeout/the closing of all
2642 /// pending HTLCs, the channel will be closed on chain.
2644 /// * If we are the channel initiator, we will pay between our [`Background`] and
2645 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2647 /// * If our counterparty is the channel initiator, we will require a channel closing
2648 /// transaction feerate of at least our [`Background`] feerate or the feerate which
2649 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2650 /// counterparty to pay as much fee as they'd like, however.
2652 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2654 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2655 /// generate a shutdown scriptpubkey or destination script set by
2656 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2659 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2660 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2661 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2662 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2663 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2664 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2667 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2668 /// will be accepted on the given channel, and after additional timeout/the closing of all
2669 /// pending HTLCs, the channel will be closed on chain.
2671 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2672 /// the channel being closed or not:
2673 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2674 /// transaction. The upper-bound is set by
2675 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2676 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2677 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2678 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2679 /// will appear on a force-closure transaction, whichever is lower).
2681 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2682 /// Will fail if a shutdown script has already been set for this channel by
2683 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2684 /// also be compatible with our and the counterparty's features.
2686 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2688 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2689 /// generate a shutdown scriptpubkey or destination script set by
2690 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2693 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2694 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2695 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2696 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2697 pub fn close_channel_with_feerate_and_script(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2698 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2701 fn finish_close_channel(&self, shutdown_res: ShutdownResult) {
2702 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
2703 #[cfg(debug_assertions)]
2704 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
2705 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
2708 let (monitor_update_option, mut failed_htlcs, unbroadcasted_batch_funding_txid) = shutdown_res;
2709 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2710 for htlc_source in failed_htlcs.drain(..) {
2711 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2712 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2713 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2714 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2716 if let Some((_, funding_txo, monitor_update)) = monitor_update_option {
2717 // There isn't anything we can do if we get an update failure - we're already
2718 // force-closing. The monitor update on the required in-memory copy should broadcast
2719 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2720 // ignore the result here.
2721 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2723 let mut shutdown_results = Vec::new();
2724 if let Some(txid) = unbroadcasted_batch_funding_txid {
2725 let mut funding_batch_states = self.funding_batch_states.lock().unwrap();
2726 let affected_channels = funding_batch_states.remove(&txid).into_iter().flatten();
2727 let per_peer_state = self.per_peer_state.read().unwrap();
2728 let mut has_uncompleted_channel = None;
2729 for (channel_id, counterparty_node_id, state) in affected_channels {
2730 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2731 let mut peer_state = peer_state_mutex.lock().unwrap();
2732 if let Some(mut chan) = peer_state.channel_by_id.remove(&channel_id) {
2733 update_maps_on_chan_removal!(self, &chan.context());
2734 self.issue_channel_close_events(&chan.context(), ClosureReason::FundingBatchClosure);
2735 shutdown_results.push(chan.context_mut().force_shutdown(false));
2738 has_uncompleted_channel = Some(has_uncompleted_channel.map_or(!state, |v| v || !state));
2741 has_uncompleted_channel.unwrap_or(true),
2742 "Closing a batch where all channels have completed initial monitor update",
2745 for shutdown_result in shutdown_results.drain(..) {
2746 self.finish_close_channel(shutdown_result);
2750 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2751 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2752 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2753 -> Result<PublicKey, APIError> {
2754 let per_peer_state = self.per_peer_state.read().unwrap();
2755 let peer_state_mutex = per_peer_state.get(peer_node_id)
2756 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2757 let (update_opt, counterparty_node_id) = {
2758 let mut peer_state = peer_state_mutex.lock().unwrap();
2759 let closure_reason = if let Some(peer_msg) = peer_msg {
2760 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2762 ClosureReason::HolderForceClosed
2764 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2765 log_error!(self.logger, "Force-closing channel {}", channel_id);
2766 self.issue_channel_close_events(&chan_phase_entry.get().context(), closure_reason);
2767 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2768 mem::drop(peer_state);
2769 mem::drop(per_peer_state);
2771 ChannelPhase::Funded(mut chan) => {
2772 self.finish_close_channel(chan.context.force_shutdown(broadcast));
2773 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2775 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2776 self.finish_close_channel(chan_phase.context_mut().force_shutdown(false));
2777 // Unfunded channel has no update
2778 (None, chan_phase.context().get_counterparty_node_id())
2781 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2782 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2783 // N.B. that we don't send any channel close event here: we
2784 // don't have a user_channel_id, and we never sent any opening
2786 (None, *peer_node_id)
2788 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2791 if let Some(update) = update_opt {
2792 // Try to send the `BroadcastChannelUpdate` to the peer we just force-closed on, but if
2793 // not try to broadcast it via whatever peer we have.
2794 let per_peer_state = self.per_peer_state.read().unwrap();
2795 let a_peer_state_opt = per_peer_state.get(peer_node_id)
2796 .ok_or(per_peer_state.values().next());
2797 if let Ok(a_peer_state_mutex) = a_peer_state_opt {
2798 let mut a_peer_state = a_peer_state_mutex.lock().unwrap();
2799 a_peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2805 Ok(counterparty_node_id)
2808 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2809 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2810 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2811 Ok(counterparty_node_id) => {
2812 let per_peer_state = self.per_peer_state.read().unwrap();
2813 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2814 let mut peer_state = peer_state_mutex.lock().unwrap();
2815 peer_state.pending_msg_events.push(
2816 events::MessageSendEvent::HandleError {
2817 node_id: counterparty_node_id,
2818 action: msgs::ErrorAction::DisconnectPeer {
2819 msg: Some(msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() })
2830 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2831 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2832 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2834 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2835 -> Result<(), APIError> {
2836 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2839 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2840 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2841 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2843 /// You can always get the latest local transaction(s) to broadcast from
2844 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2845 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2846 -> Result<(), APIError> {
2847 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2850 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2851 /// for each to the chain and rejecting new HTLCs on each.
2852 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2853 for chan in self.list_channels() {
2854 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2858 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2859 /// local transaction(s).
2860 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2861 for chan in self.list_channels() {
2862 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2866 fn construct_fwd_pending_htlc_info(
2867 &self, msg: &msgs::UpdateAddHTLC, hop_data: msgs::InboundOnionPayload, hop_hmac: [u8; 32],
2868 new_packet_bytes: [u8; onion_utils::ONION_DATA_LEN], shared_secret: [u8; 32],
2869 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2870 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2871 debug_assert!(next_packet_pubkey_opt.is_some());
2872 let outgoing_packet = msgs::OnionPacket {
2874 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2875 hop_data: new_packet_bytes,
2879 let (short_channel_id, amt_to_forward, outgoing_cltv_value) = match hop_data {
2880 msgs::InboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } =>
2881 (short_channel_id, amt_to_forward, outgoing_cltv_value),
2882 msgs::InboundOnionPayload::Receive { .. } | msgs::InboundOnionPayload::BlindedReceive { .. } =>
2883 return Err(InboundOnionErr {
2884 msg: "Final Node OnionHopData provided for us as an intermediary node",
2885 err_code: 0x4000 | 22,
2886 err_data: Vec::new(),
2890 Ok(PendingHTLCInfo {
2891 routing: PendingHTLCRouting::Forward {
2892 onion_packet: outgoing_packet,
2895 payment_hash: msg.payment_hash,
2896 incoming_shared_secret: shared_secret,
2897 incoming_amt_msat: Some(msg.amount_msat),
2898 outgoing_amt_msat: amt_to_forward,
2899 outgoing_cltv_value,
2900 skimmed_fee_msat: None,
2904 fn construct_recv_pending_htlc_info(
2905 &self, hop_data: msgs::InboundOnionPayload, shared_secret: [u8; 32], payment_hash: PaymentHash,
2906 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2907 counterparty_skimmed_fee_msat: Option<u64>,
2908 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2909 let (payment_data, keysend_preimage, custom_tlvs, onion_amt_msat, outgoing_cltv_value, payment_metadata) = match hop_data {
2910 msgs::InboundOnionPayload::Receive {
2911 payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata, ..
2913 (payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata),
2914 msgs::InboundOnionPayload::BlindedReceive {
2915 amt_msat, total_msat, outgoing_cltv_value, payment_secret, ..
2917 let payment_data = msgs::FinalOnionHopData { payment_secret, total_msat };
2918 (Some(payment_data), None, Vec::new(), amt_msat, outgoing_cltv_value, None)
2920 msgs::InboundOnionPayload::Forward { .. } => {
2921 return Err(InboundOnionErr {
2922 err_code: 0x4000|22,
2923 err_data: Vec::new(),
2924 msg: "Got non final data with an HMAC of 0",
2928 // final_incorrect_cltv_expiry
2929 if outgoing_cltv_value > cltv_expiry {
2930 return Err(InboundOnionErr {
2931 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2933 err_data: cltv_expiry.to_be_bytes().to_vec()
2936 // final_expiry_too_soon
2937 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2938 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2940 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2941 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2942 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2943 let current_height: u32 = self.best_block.read().unwrap().height();
2944 if cltv_expiry <= current_height + HTLC_FAIL_BACK_BUFFER + 1 {
2945 let mut err_data = Vec::with_capacity(12);
2946 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2947 err_data.extend_from_slice(¤t_height.to_be_bytes());
2948 return Err(InboundOnionErr {
2949 err_code: 0x4000 | 15, err_data,
2950 msg: "The final CLTV expiry is too soon to handle",
2953 if (!allow_underpay && onion_amt_msat > amt_msat) ||
2954 (allow_underpay && onion_amt_msat >
2955 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
2957 return Err(InboundOnionErr {
2959 err_data: amt_msat.to_be_bytes().to_vec(),
2960 msg: "Upstream node sent less than we were supposed to receive in payment",
2964 let routing = if let Some(payment_preimage) = keysend_preimage {
2965 // We need to check that the sender knows the keysend preimage before processing this
2966 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2967 // could discover the final destination of X, by probing the adjacent nodes on the route
2968 // with a keysend payment of identical payment hash to X and observing the processing
2969 // time discrepancies due to a hash collision with X.
2970 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2971 if hashed_preimage != payment_hash {
2972 return Err(InboundOnionErr {
2973 err_code: 0x4000|22,
2974 err_data: Vec::new(),
2975 msg: "Payment preimage didn't match payment hash",
2978 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
2979 return Err(InboundOnionErr {
2980 err_code: 0x4000|22,
2981 err_data: Vec::new(),
2982 msg: "We don't support MPP keysend payments",
2985 PendingHTLCRouting::ReceiveKeysend {
2989 incoming_cltv_expiry: outgoing_cltv_value,
2992 } else if let Some(data) = payment_data {
2993 PendingHTLCRouting::Receive {
2996 incoming_cltv_expiry: outgoing_cltv_value,
2997 phantom_shared_secret,
3001 return Err(InboundOnionErr {
3002 err_code: 0x4000|0x2000|3,
3003 err_data: Vec::new(),
3004 msg: "We require payment_secrets",
3007 Ok(PendingHTLCInfo {
3010 incoming_shared_secret: shared_secret,
3011 incoming_amt_msat: Some(amt_msat),
3012 outgoing_amt_msat: onion_amt_msat,
3013 outgoing_cltv_value,
3014 skimmed_fee_msat: counterparty_skimmed_fee_msat,
3018 fn decode_update_add_htlc_onion(
3019 &self, msg: &msgs::UpdateAddHTLC
3020 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
3021 macro_rules! return_malformed_err {
3022 ($msg: expr, $err_code: expr) => {
3024 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3025 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
3026 channel_id: msg.channel_id,
3027 htlc_id: msg.htlc_id,
3028 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
3029 failure_code: $err_code,
3035 if let Err(_) = msg.onion_routing_packet.public_key {
3036 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
3039 let shared_secret = self.node_signer.ecdh(
3040 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
3041 ).unwrap().secret_bytes();
3043 if msg.onion_routing_packet.version != 0 {
3044 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
3045 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
3046 //the hash doesn't really serve any purpose - in the case of hashing all data, the
3047 //receiving node would have to brute force to figure out which version was put in the
3048 //packet by the node that send us the message, in the case of hashing the hop_data, the
3049 //node knows the HMAC matched, so they already know what is there...
3050 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
3052 macro_rules! return_err {
3053 ($msg: expr, $err_code: expr, $data: expr) => {
3055 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3056 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3057 channel_id: msg.channel_id,
3058 htlc_id: msg.htlc_id,
3059 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3060 .get_encrypted_failure_packet(&shared_secret, &None),
3066 let next_hop = match onion_utils::decode_next_payment_hop(
3067 shared_secret, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac,
3068 msg.payment_hash, &self.node_signer
3071 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3072 return_malformed_err!(err_msg, err_code);
3074 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3075 return_err!(err_msg, err_code, &[0; 0]);
3078 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
3079 onion_utils::Hop::Forward {
3080 next_hop_data: msgs::InboundOnionPayload::Forward {
3081 short_channel_id, amt_to_forward, outgoing_cltv_value
3084 let next_packet_pk = onion_utils::next_hop_pubkey(&self.secp_ctx,
3085 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
3086 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_packet_pk))
3088 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
3089 // inbound channel's state.
3090 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
3091 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::Receive { .. }, .. } |
3092 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::BlindedReceive { .. }, .. } =>
3094 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
3098 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
3099 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
3100 if let Some((err, mut code, chan_update)) = loop {
3101 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
3102 let forwarding_chan_info_opt = match id_option {
3103 None => { // unknown_next_peer
3104 // Note that this is likely a timing oracle for detecting whether an scid is a
3105 // phantom or an intercept.
3106 if (self.default_configuration.accept_intercept_htlcs &&
3107 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)) ||
3108 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)
3112 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3115 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
3117 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
3118 let per_peer_state = self.per_peer_state.read().unwrap();
3119 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3120 if peer_state_mutex_opt.is_none() {
3121 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3123 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3124 let peer_state = &mut *peer_state_lock;
3125 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
3126 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
3129 // Channel was removed. The short_to_chan_info and channel_by_id maps
3130 // have no consistency guarantees.
3131 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3135 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3136 // Note that the behavior here should be identical to the above block - we
3137 // should NOT reveal the existence or non-existence of a private channel if
3138 // we don't allow forwards outbound over them.
3139 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3141 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3142 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3143 // "refuse to forward unless the SCID alias was used", so we pretend
3144 // we don't have the channel here.
3145 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3147 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3149 // Note that we could technically not return an error yet here and just hope
3150 // that the connection is reestablished or monitor updated by the time we get
3151 // around to doing the actual forward, but better to fail early if we can and
3152 // hopefully an attacker trying to path-trace payments cannot make this occur
3153 // on a small/per-node/per-channel scale.
3154 if !chan.context.is_live() { // channel_disabled
3155 // If the channel_update we're going to return is disabled (i.e. the
3156 // peer has been disabled for some time), return `channel_disabled`,
3157 // otherwise return `temporary_channel_failure`.
3158 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3159 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3161 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3164 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3165 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3167 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3168 break Some((err, code, chan_update_opt));
3172 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
3173 // We really should set `incorrect_cltv_expiry` here but as we're not
3174 // forwarding over a real channel we can't generate a channel_update
3175 // for it. Instead we just return a generic temporary_node_failure.
3177 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
3184 let cur_height = self.best_block.read().unwrap().height() + 1;
3185 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
3186 // but we want to be robust wrt to counterparty packet sanitization (see
3187 // HTLC_FAIL_BACK_BUFFER rationale).
3188 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
3189 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
3191 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
3192 break Some(("CLTV expiry is too far in the future", 21, None));
3194 // If the HTLC expires ~now, don't bother trying to forward it to our
3195 // counterparty. They should fail it anyway, but we don't want to bother with
3196 // the round-trips or risk them deciding they definitely want the HTLC and
3197 // force-closing to ensure they get it if we're offline.
3198 // We previously had a much more aggressive check here which tried to ensure
3199 // our counterparty receives an HTLC which has *our* risk threshold met on it,
3200 // but there is no need to do that, and since we're a bit conservative with our
3201 // risk threshold it just results in failing to forward payments.
3202 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
3203 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
3209 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3210 if let Some(chan_update) = chan_update {
3211 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3212 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3214 else if code == 0x1000 | 13 {
3215 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3217 else if code == 0x1000 | 20 {
3218 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3219 0u16.write(&mut res).expect("Writes cannot fail");
3221 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3222 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3223 chan_update.write(&mut res).expect("Writes cannot fail");
3224 } else if code & 0x1000 == 0x1000 {
3225 // If we're trying to return an error that requires a `channel_update` but
3226 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3227 // generate an update), just use the generic "temporary_node_failure"
3231 return_err!(err, code, &res.0[..]);
3233 Ok((next_hop, shared_secret, next_packet_pk_opt))
3236 fn construct_pending_htlc_status<'a>(
3237 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
3238 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
3239 ) -> PendingHTLCStatus {
3240 macro_rules! return_err {
3241 ($msg: expr, $err_code: expr, $data: expr) => {
3243 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3244 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3245 channel_id: msg.channel_id,
3246 htlc_id: msg.htlc_id,
3247 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3248 .get_encrypted_failure_packet(&shared_secret, &None),
3254 onion_utils::Hop::Receive(next_hop_data) => {
3256 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3257 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
3260 // Note that we could obviously respond immediately with an update_fulfill_htlc
3261 // message, however that would leak that we are the recipient of this payment, so
3262 // instead we stay symmetric with the forwarding case, only responding (after a
3263 // delay) once they've send us a commitment_signed!
3264 PendingHTLCStatus::Forward(info)
3266 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3269 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3270 match self.construct_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3271 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3272 Ok(info) => PendingHTLCStatus::Forward(info),
3273 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3279 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3280 /// public, and thus should be called whenever the result is going to be passed out in a
3281 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3283 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3284 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3285 /// storage and the `peer_state` lock has been dropped.
3287 /// [`channel_update`]: msgs::ChannelUpdate
3288 /// [`internal_closing_signed`]: Self::internal_closing_signed
3289 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3290 if !chan.context.should_announce() {
3291 return Err(LightningError {
3292 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3293 action: msgs::ErrorAction::IgnoreError
3296 if chan.context.get_short_channel_id().is_none() {
3297 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3299 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3300 self.get_channel_update_for_unicast(chan)
3303 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3304 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3305 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3306 /// provided evidence that they know about the existence of the channel.
3308 /// Note that through [`internal_closing_signed`], this function is called without the
3309 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3310 /// removed from the storage and the `peer_state` lock has been dropped.
3312 /// [`channel_update`]: msgs::ChannelUpdate
3313 /// [`internal_closing_signed`]: Self::internal_closing_signed
3314 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3315 log_trace!(self.logger, "Attempting to generate channel update for channel {}", &chan.context.channel_id());
3316 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3317 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3321 self.get_channel_update_for_onion(short_channel_id, chan)
3324 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3325 log_trace!(self.logger, "Generating channel update for channel {}", &chan.context.channel_id());
3326 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3328 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3329 ChannelUpdateStatus::Enabled => true,
3330 ChannelUpdateStatus::DisabledStaged(_) => true,
3331 ChannelUpdateStatus::Disabled => false,
3332 ChannelUpdateStatus::EnabledStaged(_) => false,
3335 let unsigned = msgs::UnsignedChannelUpdate {
3336 chain_hash: self.chain_hash,
3338 timestamp: chan.context.get_update_time_counter(),
3339 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3340 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3341 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3342 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3343 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3344 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3345 excess_data: Vec::new(),
3347 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3348 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3349 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3351 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3353 Ok(msgs::ChannelUpdate {
3360 pub(crate) fn test_send_payment_along_path(&self, path: &Path, payment_hash: &PaymentHash, recipient_onion: RecipientOnionFields, total_value: u64, cur_height: u32, payment_id: PaymentId, keysend_preimage: &Option<PaymentPreimage>, session_priv_bytes: [u8; 32]) -> Result<(), APIError> {
3361 let _lck = self.total_consistency_lock.read().unwrap();
3362 self.send_payment_along_path(SendAlongPathArgs {
3363 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3368 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3369 let SendAlongPathArgs {
3370 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3373 // The top-level caller should hold the total_consistency_lock read lock.
3374 debug_assert!(self.total_consistency_lock.try_write().is_err());
3376 log_trace!(self.logger,
3377 "Attempting to send payment with payment hash {} along path with next hop {}",
3378 payment_hash, path.hops.first().unwrap().short_channel_id);
3379 let prng_seed = self.entropy_source.get_secure_random_bytes();
3380 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3382 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
3383 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
3384 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, recipient_onion, cur_height, keysend_preimage)?;
3386 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
3387 .map_err(|_| APIError::InvalidRoute { err: "Route size too large considering onion data".to_owned()})?;
3389 let err: Result<(), _> = loop {
3390 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3391 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3392 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3395 let per_peer_state = self.per_peer_state.read().unwrap();
3396 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3397 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3398 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3399 let peer_state = &mut *peer_state_lock;
3400 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3401 match chan_phase_entry.get_mut() {
3402 ChannelPhase::Funded(chan) => {
3403 if !chan.context.is_live() {
3404 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3406 let funding_txo = chan.context.get_funding_txo().unwrap();
3407 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3408 htlc_cltv, HTLCSource::OutboundRoute {
3410 session_priv: session_priv.clone(),
3411 first_hop_htlc_msat: htlc_msat,
3413 }, onion_packet, None, &self.fee_estimator, &self.logger);
3414 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3415 Some(monitor_update) => {
3416 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3418 // Note that MonitorUpdateInProgress here indicates (per function
3419 // docs) that we will resend the commitment update once monitor
3420 // updating completes. Therefore, we must return an error
3421 // indicating that it is unsafe to retry the payment wholesale,
3422 // which we do in the send_payment check for
3423 // MonitorUpdateInProgress, below.
3424 return Err(APIError::MonitorUpdateInProgress);
3432 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3435 // The channel was likely removed after we fetched the id from the
3436 // `short_to_chan_info` map, but before we successfully locked the
3437 // `channel_by_id` map.
3438 // This can occur as no consistency guarantees exists between the two maps.
3439 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3444 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3445 Ok(_) => unreachable!(),
3447 Err(APIError::ChannelUnavailable { err: e.err })
3452 /// Sends a payment along a given route.
3454 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3455 /// fields for more info.
3457 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3458 /// [`PeerManager::process_events`]).
3460 /// # Avoiding Duplicate Payments
3462 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3463 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3464 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3465 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3466 /// second payment with the same [`PaymentId`].
3468 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3469 /// tracking of payments, including state to indicate once a payment has completed. Because you
3470 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3471 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3472 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3474 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3475 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3476 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3477 /// [`ChannelManager::list_recent_payments`] for more information.
3479 /// # Possible Error States on [`PaymentSendFailure`]
3481 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3482 /// each entry matching the corresponding-index entry in the route paths, see
3483 /// [`PaymentSendFailure`] for more info.
3485 /// In general, a path may raise:
3486 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3487 /// node public key) is specified.
3488 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3489 /// closed, doesn't exist, or the peer is currently disconnected.
3490 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3491 /// relevant updates.
3493 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3494 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3495 /// different route unless you intend to pay twice!
3497 /// [`RouteHop`]: crate::routing::router::RouteHop
3498 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3499 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3500 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3501 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3502 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3503 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3504 let best_block_height = self.best_block.read().unwrap().height();
3505 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3506 self.pending_outbound_payments
3507 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3508 &self.entropy_source, &self.node_signer, best_block_height,
3509 |args| self.send_payment_along_path(args))
3512 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3513 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3514 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3515 let best_block_height = self.best_block.read().unwrap().height();
3516 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3517 self.pending_outbound_payments
3518 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3519 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3520 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3521 &self.pending_events, |args| self.send_payment_along_path(args))
3525 pub(super) fn test_send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
3526 let best_block_height = self.best_block.read().unwrap().height();
3527 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3528 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3529 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3530 best_block_height, |args| self.send_payment_along_path(args))
3534 pub(crate) fn test_add_new_pending_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
3535 let best_block_height = self.best_block.read().unwrap().height();
3536 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3540 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3541 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3545 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3546 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3547 /// retries are exhausted.
3549 /// # Event Generation
3551 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3552 /// as there are no remaining pending HTLCs for this payment.
3554 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3555 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3556 /// determine the ultimate status of a payment.
3558 /// # Restart Behavior
3560 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3561 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated.
3562 pub fn abandon_payment(&self, payment_id: PaymentId) {
3563 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3564 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3567 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3568 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3569 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3570 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3571 /// never reach the recipient.
3573 /// See [`send_payment`] documentation for more details on the return value of this function
3574 /// and idempotency guarantees provided by the [`PaymentId`] key.
3576 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3577 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3579 /// [`send_payment`]: Self::send_payment
3580 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3581 let best_block_height = self.best_block.read().unwrap().height();
3582 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3583 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3584 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3585 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3588 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3589 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3591 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3594 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3595 pub fn send_spontaneous_payment_with_retry(&self, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<PaymentHash, RetryableSendFailure> {
3596 let best_block_height = self.best_block.read().unwrap().height();
3597 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3598 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3599 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3600 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3601 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3604 /// Send a payment that is probing the given route for liquidity. We calculate the
3605 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3606 /// us to easily discern them from real payments.
3607 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3608 let best_block_height = self.best_block.read().unwrap().height();
3609 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3610 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3611 &self.entropy_source, &self.node_signer, best_block_height,
3612 |args| self.send_payment_along_path(args))
3615 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3618 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3619 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3622 /// Sends payment probes over all paths of a route that would be used to pay the given
3623 /// amount to the given `node_id`.
3625 /// See [`ChannelManager::send_preflight_probes`] for more information.
3626 pub fn send_spontaneous_preflight_probes(
3627 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3628 liquidity_limit_multiplier: Option<u64>,
3629 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3630 let payment_params =
3631 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3633 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
3635 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3638 /// Sends payment probes over all paths of a route that would be used to pay a route found
3639 /// according to the given [`RouteParameters`].
3641 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3642 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3643 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3644 /// confirmation in a wallet UI.
3646 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3647 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3648 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3649 /// payment. To mitigate this issue, channels with available liquidity less than the required
3650 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3651 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3652 pub fn send_preflight_probes(
3653 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3654 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3655 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3657 let payer = self.get_our_node_id();
3658 let usable_channels = self.list_usable_channels();
3659 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3660 let inflight_htlcs = self.compute_inflight_htlcs();
3664 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3666 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3667 ProbeSendFailure::RouteNotFound
3670 let mut used_liquidity_map = HashMap::with_capacity(first_hops.len());
3672 let mut res = Vec::new();
3674 for mut path in route.paths {
3675 // If the last hop is probably an unannounced channel we refrain from probing all the
3676 // way through to the end and instead probe up to the second-to-last channel.
3677 while let Some(last_path_hop) = path.hops.last() {
3678 if last_path_hop.maybe_announced_channel {
3679 // We found a potentially announced last hop.
3682 // Drop the last hop, as it's likely unannounced.
3685 "Avoided sending payment probe all the way to last hop {} as it is likely unannounced.",
3686 last_path_hop.short_channel_id
3688 let final_value_msat = path.final_value_msat();
3690 if let Some(new_last) = path.hops.last_mut() {
3691 new_last.fee_msat += final_value_msat;
3696 if path.hops.len() < 2 {
3699 "Skipped sending payment probe over path with less than two hops."
3704 if let Some(first_path_hop) = path.hops.first() {
3705 if let Some(first_hop) = first_hops.iter().find(|h| {
3706 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3708 let path_value = path.final_value_msat() + path.fee_msat();
3709 let used_liquidity =
3710 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3712 if first_hop.next_outbound_htlc_limit_msat
3713 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3715 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3718 *used_liquidity += path_value;
3723 res.push(self.send_probe(path).map_err(|e| {
3724 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3725 ProbeSendFailure::SendingFailed(e)
3732 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3733 /// which checks the correctness of the funding transaction given the associated channel.
3734 fn funding_transaction_generated_intern<FundingOutput: FnMut(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3735 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, is_batch_funding: bool,
3736 mut find_funding_output: FundingOutput,
3737 ) -> Result<(), APIError> {
3738 let per_peer_state = self.per_peer_state.read().unwrap();
3739 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3740 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3742 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3743 let peer_state = &mut *peer_state_lock;
3744 let (chan, msg) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3745 Some(ChannelPhase::UnfundedOutboundV1(chan)) => {
3746 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3748 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, is_batch_funding, &self.logger)
3749 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3750 let channel_id = chan.context.channel_id();
3751 let user_id = chan.context.get_user_id();
3752 let shutdown_res = chan.context.force_shutdown(false);
3753 let channel_capacity = chan.context.get_value_satoshis();
3754 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3755 } else { unreachable!(); });
3757 Ok((chan, funding_msg)) => (chan, funding_msg),
3758 Err((chan, err)) => {
3759 mem::drop(peer_state_lock);
3760 mem::drop(per_peer_state);
3762 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3763 return Err(APIError::ChannelUnavailable {
3764 err: "Signer refused to sign the initial commitment transaction".to_owned()
3770 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3771 return Err(APIError::APIMisuseError {
3773 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3774 temporary_channel_id, counterparty_node_id),
3777 None => return Err(APIError::ChannelUnavailable {err: format!(
3778 "Channel with id {} not found for the passed counterparty node_id {}",
3779 temporary_channel_id, counterparty_node_id),
3783 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3784 node_id: chan.context.get_counterparty_node_id(),
3787 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3788 hash_map::Entry::Occupied(_) => {
3789 panic!("Generated duplicate funding txid?");
3791 hash_map::Entry::Vacant(e) => {
3792 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3793 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3794 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3796 e.insert(ChannelPhase::Funded(chan));
3803 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3804 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, false, |_, tx| {
3805 Ok(OutPoint { txid: tx.txid(), index: output_index })
3809 /// Call this upon creation of a funding transaction for the given channel.
3811 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3812 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3814 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3815 /// across the p2p network.
3817 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3818 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3820 /// May panic if the output found in the funding transaction is duplicative with some other
3821 /// channel (note that this should be trivially prevented by using unique funding transaction
3822 /// keys per-channel).
3824 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3825 /// counterparty's signature the funding transaction will automatically be broadcast via the
3826 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3828 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3829 /// not currently support replacing a funding transaction on an existing channel. Instead,
3830 /// create a new channel with a conflicting funding transaction.
3832 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3833 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3834 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3835 /// for more details.
3837 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3838 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3839 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3840 self.batch_funding_transaction_generated(&[(temporary_channel_id, counterparty_node_id)], funding_transaction)
3843 /// Call this upon creation of a batch funding transaction for the given channels.
3845 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
3846 /// each individual channel and transaction output.
3848 /// Do NOT broadcast the funding transaction yourself. This batch funding transcaction
3849 /// will only be broadcast when we have safely received and persisted the counterparty's
3850 /// signature for each channel.
3852 /// If there is an error, all channels in the batch are to be considered closed.
3853 pub fn batch_funding_transaction_generated(&self, temporary_channels: &[(&ChannelId, &PublicKey)], funding_transaction: Transaction) -> Result<(), APIError> {
3854 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3855 let mut result = Ok(());
3857 if !funding_transaction.is_coin_base() {
3858 for inp in funding_transaction.input.iter() {
3859 if inp.witness.is_empty() {
3860 result = result.and(Err(APIError::APIMisuseError {
3861 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3866 if funding_transaction.output.len() > u16::max_value() as usize {
3867 result = result.and(Err(APIError::APIMisuseError {
3868 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3872 let height = self.best_block.read().unwrap().height();
3873 // Transactions are evaluated as final by network mempools if their locktime is strictly
3874 // lower than the next block height. However, the modules constituting our Lightning
3875 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3876 // module is ahead of LDK, only allow one more block of headroom.
3877 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 + 1 {
3878 result = result.and(Err(APIError::APIMisuseError {
3879 err: "Funding transaction absolute timelock is non-final".to_owned()
3884 let txid = funding_transaction.txid();
3885 let is_batch_funding = temporary_channels.len() > 1;
3886 let mut funding_batch_states = if is_batch_funding {
3887 Some(self.funding_batch_states.lock().unwrap())
3891 let mut funding_batch_state = funding_batch_states.as_mut().and_then(|states| {
3892 match states.entry(txid) {
3893 btree_map::Entry::Occupied(_) => {
3894 result = result.clone().and(Err(APIError::APIMisuseError {
3895 err: "Batch funding transaction with the same txid already exists".to_owned()
3899 btree_map::Entry::Vacant(vacant) => Some(vacant.insert(Vec::new())),
3902 for &(temporary_channel_id, counterparty_node_id) in temporary_channels.iter() {
3903 result = result.and_then(|_| self.funding_transaction_generated_intern(
3904 temporary_channel_id,
3905 counterparty_node_id,
3906 funding_transaction.clone(),
3909 let mut output_index = None;
3910 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3911 for (idx, outp) in tx.output.iter().enumerate() {
3912 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3913 if output_index.is_some() {
3914 return Err(APIError::APIMisuseError {
3915 err: "Multiple outputs matched the expected script and value".to_owned()
3918 output_index = Some(idx as u16);
3921 if output_index.is_none() {
3922 return Err(APIError::APIMisuseError {
3923 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3926 let outpoint = OutPoint { txid: tx.txid(), index: output_index.unwrap() };
3927 if let Some(funding_batch_state) = funding_batch_state.as_mut() {
3928 funding_batch_state.push((outpoint.to_channel_id(), *counterparty_node_id, false));
3934 if let Err(ref e) = result {
3935 // Remaining channels need to be removed on any error.
3936 let e = format!("Error in transaction funding: {:?}", e);
3937 let mut channels_to_remove = Vec::new();
3938 channels_to_remove.extend(funding_batch_states.as_mut()
3939 .and_then(|states| states.remove(&txid))
3940 .into_iter().flatten()
3941 .map(|(chan_id, node_id, _state)| (chan_id, node_id))
3943 channels_to_remove.extend(temporary_channels.iter()
3944 .map(|(&chan_id, &node_id)| (chan_id, node_id))
3946 let mut shutdown_results = Vec::new();
3948 let per_peer_state = self.per_peer_state.read().unwrap();
3949 for (channel_id, counterparty_node_id) in channels_to_remove {
3950 per_peer_state.get(&counterparty_node_id)
3951 .map(|peer_state_mutex| peer_state_mutex.lock().unwrap())
3952 .and_then(|mut peer_state| peer_state.channel_by_id.remove(&channel_id))
3954 update_maps_on_chan_removal!(self, &chan.context());
3955 self.issue_channel_close_events(&chan.context(), ClosureReason::ProcessingError { err: e.clone() });
3956 shutdown_results.push(chan.context_mut().force_shutdown(false));
3960 for shutdown_result in shutdown_results.drain(..) {
3961 self.finish_close_channel(shutdown_result);
3967 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3969 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3970 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3971 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3972 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3974 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3975 /// `counterparty_node_id` is provided.
3977 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3978 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3980 /// If an error is returned, none of the updates should be considered applied.
3982 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3983 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3984 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3985 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3986 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3987 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3988 /// [`APIMisuseError`]: APIError::APIMisuseError
3989 pub fn update_partial_channel_config(
3990 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
3991 ) -> Result<(), APIError> {
3992 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3993 return Err(APIError::APIMisuseError {
3994 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3998 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3999 let per_peer_state = self.per_peer_state.read().unwrap();
4000 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4001 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4002 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4003 let peer_state = &mut *peer_state_lock;
4004 for channel_id in channel_ids {
4005 if !peer_state.has_channel(channel_id) {
4006 return Err(APIError::ChannelUnavailable {
4007 err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, counterparty_node_id),
4011 for channel_id in channel_ids {
4012 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
4013 let mut config = channel_phase.context().config();
4014 config.apply(config_update);
4015 if !channel_phase.context_mut().update_config(&config) {
4018 if let ChannelPhase::Funded(channel) = channel_phase {
4019 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
4020 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
4021 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
4022 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4023 node_id: channel.context.get_counterparty_node_id(),
4030 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
4031 debug_assert!(false);
4032 return Err(APIError::ChannelUnavailable {
4034 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
4035 channel_id, counterparty_node_id),
4042 /// Atomically updates the [`ChannelConfig`] for the given channels.
4044 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4045 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4046 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4047 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4049 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4050 /// `counterparty_node_id` is provided.
4052 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4053 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4055 /// If an error is returned, none of the updates should be considered applied.
4057 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4058 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4059 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4060 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4061 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4062 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4063 /// [`APIMisuseError`]: APIError::APIMisuseError
4064 pub fn update_channel_config(
4065 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
4066 ) -> Result<(), APIError> {
4067 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
4070 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
4071 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
4073 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
4074 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
4076 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
4077 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
4078 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
4079 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
4080 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
4082 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
4083 /// you from forwarding more than you received. See
4084 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
4087 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4090 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
4091 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4092 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
4093 // TODO: when we move to deciding the best outbound channel at forward time, only take
4094 // `next_node_id` and not `next_hop_channel_id`
4095 pub fn forward_intercepted_htlc(&self, intercept_id: InterceptId, next_hop_channel_id: &ChannelId, next_node_id: PublicKey, amt_to_forward_msat: u64) -> Result<(), APIError> {
4096 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4098 let next_hop_scid = {
4099 let peer_state_lock = self.per_peer_state.read().unwrap();
4100 let peer_state_mutex = peer_state_lock.get(&next_node_id)
4101 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
4102 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4103 let peer_state = &mut *peer_state_lock;
4104 match peer_state.channel_by_id.get(next_hop_channel_id) {
4105 Some(ChannelPhase::Funded(chan)) => {
4106 if !chan.context.is_usable() {
4107 return Err(APIError::ChannelUnavailable {
4108 err: format!("Channel with id {} not fully established", next_hop_channel_id)
4111 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
4113 Some(_) => return Err(APIError::ChannelUnavailable {
4114 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
4115 next_hop_channel_id, next_node_id)
4117 None => return Err(APIError::ChannelUnavailable {
4118 err: format!("Channel with id {} not found for the passed counterparty node_id {}",
4119 next_hop_channel_id, next_node_id)
4124 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4125 .ok_or_else(|| APIError::APIMisuseError {
4126 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4129 let routing = match payment.forward_info.routing {
4130 PendingHTLCRouting::Forward { onion_packet, .. } => {
4131 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
4133 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
4135 let skimmed_fee_msat =
4136 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
4137 let pending_htlc_info = PendingHTLCInfo {
4138 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
4139 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
4142 let mut per_source_pending_forward = [(
4143 payment.prev_short_channel_id,
4144 payment.prev_funding_outpoint,
4145 payment.prev_user_channel_id,
4146 vec![(pending_htlc_info, payment.prev_htlc_id)]
4148 self.forward_htlcs(&mut per_source_pending_forward);
4152 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
4153 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
4155 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4158 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4159 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
4160 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4162 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4163 .ok_or_else(|| APIError::APIMisuseError {
4164 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4167 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
4168 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4169 short_channel_id: payment.prev_short_channel_id,
4170 user_channel_id: Some(payment.prev_user_channel_id),
4171 outpoint: payment.prev_funding_outpoint,
4172 htlc_id: payment.prev_htlc_id,
4173 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
4174 phantom_shared_secret: None,
4177 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
4178 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
4179 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
4180 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
4185 /// Processes HTLCs which are pending waiting on random forward delay.
4187 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
4188 /// Will likely generate further events.
4189 pub fn process_pending_htlc_forwards(&self) {
4190 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4192 let mut new_events = VecDeque::new();
4193 let mut failed_forwards = Vec::new();
4194 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
4196 let mut forward_htlcs = HashMap::new();
4197 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
4199 for (short_chan_id, mut pending_forwards) in forward_htlcs {
4200 if short_chan_id != 0 {
4201 macro_rules! forwarding_channel_not_found {
4203 for forward_info in pending_forwards.drain(..) {
4204 match forward_info {
4205 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4206 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4207 forward_info: PendingHTLCInfo {
4208 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
4209 outgoing_cltv_value, ..
4212 macro_rules! failure_handler {
4213 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
4214 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
4216 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4217 short_channel_id: prev_short_channel_id,
4218 user_channel_id: Some(prev_user_channel_id),
4219 outpoint: prev_funding_outpoint,
4220 htlc_id: prev_htlc_id,
4221 incoming_packet_shared_secret: incoming_shared_secret,
4222 phantom_shared_secret: $phantom_ss,
4225 let reason = if $next_hop_unknown {
4226 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
4228 HTLCDestination::FailedPayment{ payment_hash }
4231 failed_forwards.push((htlc_source, payment_hash,
4232 HTLCFailReason::reason($err_code, $err_data),
4238 macro_rules! fail_forward {
4239 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4241 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4245 macro_rules! failed_payment {
4246 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4248 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4252 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
4253 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4254 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.chain_hash) {
4255 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4256 let next_hop = match onion_utils::decode_next_payment_hop(
4257 phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac,
4258 payment_hash, &self.node_signer
4261 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4262 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
4263 // In this scenario, the phantom would have sent us an
4264 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4265 // if it came from us (the second-to-last hop) but contains the sha256
4267 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4269 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4270 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4274 onion_utils::Hop::Receive(hop_data) => {
4275 match self.construct_recv_pending_htlc_info(hop_data,
4276 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4277 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
4279 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4280 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4286 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4289 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4292 HTLCForwardInfo::FailHTLC { .. } => {
4293 // Channel went away before we could fail it. This implies
4294 // the channel is now on chain and our counterparty is
4295 // trying to broadcast the HTLC-Timeout, but that's their
4296 // problem, not ours.
4302 let chan_info_opt = self.short_to_chan_info.read().unwrap().get(&short_chan_id).cloned();
4303 let (counterparty_node_id, forward_chan_id) = match chan_info_opt {
4304 Some((cp_id, chan_id)) => (cp_id, chan_id),
4306 forwarding_channel_not_found!();
4310 let per_peer_state = self.per_peer_state.read().unwrap();
4311 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4312 if peer_state_mutex_opt.is_none() {
4313 forwarding_channel_not_found!();
4316 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4317 let peer_state = &mut *peer_state_lock;
4318 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4319 for forward_info in pending_forwards.drain(..) {
4320 match forward_info {
4321 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4322 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4323 forward_info: PendingHTLCInfo {
4324 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4325 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
4328 log_trace!(self.logger, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", prev_short_channel_id, &payment_hash, short_chan_id);
4329 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4330 short_channel_id: prev_short_channel_id,
4331 user_channel_id: Some(prev_user_channel_id),
4332 outpoint: prev_funding_outpoint,
4333 htlc_id: prev_htlc_id,
4334 incoming_packet_shared_secret: incoming_shared_secret,
4335 // Phantom payments are only PendingHTLCRouting::Receive.
4336 phantom_shared_secret: None,
4338 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4339 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4340 onion_packet, skimmed_fee_msat, &self.fee_estimator,
4343 if let ChannelError::Ignore(msg) = e {
4344 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4346 panic!("Stated return value requirements in send_htlc() were not met");
4348 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4349 failed_forwards.push((htlc_source, payment_hash,
4350 HTLCFailReason::reason(failure_code, data),
4351 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4356 HTLCForwardInfo::AddHTLC { .. } => {
4357 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4359 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4360 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4361 if let Err(e) = chan.queue_fail_htlc(
4362 htlc_id, err_packet, &self.logger
4364 if let ChannelError::Ignore(msg) = e {
4365 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4367 panic!("Stated return value requirements in queue_fail_htlc() were not met");
4369 // fail-backs are best-effort, we probably already have one
4370 // pending, and if not that's OK, if not, the channel is on
4371 // the chain and sending the HTLC-Timeout is their problem.
4378 forwarding_channel_not_found!();
4382 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4383 match forward_info {
4384 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4385 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4386 forward_info: PendingHTLCInfo {
4387 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4388 skimmed_fee_msat, ..
4391 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4392 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret, custom_tlvs } => {
4393 let _legacy_hop_data = Some(payment_data.clone());
4394 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4395 payment_metadata, custom_tlvs };
4396 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4397 Some(payment_data), phantom_shared_secret, onion_fields)
4399 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4400 let onion_fields = RecipientOnionFields {
4401 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4405 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4406 payment_data, None, onion_fields)
4409 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4412 let claimable_htlc = ClaimableHTLC {
4413 prev_hop: HTLCPreviousHopData {
4414 short_channel_id: prev_short_channel_id,
4415 user_channel_id: Some(prev_user_channel_id),
4416 outpoint: prev_funding_outpoint,
4417 htlc_id: prev_htlc_id,
4418 incoming_packet_shared_secret: incoming_shared_secret,
4419 phantom_shared_secret,
4421 // We differentiate the received value from the sender intended value
4422 // if possible so that we don't prematurely mark MPP payments complete
4423 // if routing nodes overpay
4424 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4425 sender_intended_value: outgoing_amt_msat,
4427 total_value_received: None,
4428 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4431 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4434 let mut committed_to_claimable = false;
4436 macro_rules! fail_htlc {
4437 ($htlc: expr, $payment_hash: expr) => {
4438 debug_assert!(!committed_to_claimable);
4439 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4440 htlc_msat_height_data.extend_from_slice(
4441 &self.best_block.read().unwrap().height().to_be_bytes(),
4443 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4444 short_channel_id: $htlc.prev_hop.short_channel_id,
4445 user_channel_id: $htlc.prev_hop.user_channel_id,
4446 outpoint: prev_funding_outpoint,
4447 htlc_id: $htlc.prev_hop.htlc_id,
4448 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4449 phantom_shared_secret,
4451 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4452 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4454 continue 'next_forwardable_htlc;
4457 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4458 let mut receiver_node_id = self.our_network_pubkey;
4459 if phantom_shared_secret.is_some() {
4460 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4461 .expect("Failed to get node_id for phantom node recipient");
4464 macro_rules! check_total_value {
4465 ($purpose: expr) => {{
4466 let mut payment_claimable_generated = false;
4467 let is_keysend = match $purpose {
4468 events::PaymentPurpose::SpontaneousPayment(_) => true,
4469 events::PaymentPurpose::InvoicePayment { .. } => false,
4471 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4472 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4473 fail_htlc!(claimable_htlc, payment_hash);
4475 let ref mut claimable_payment = claimable_payments.claimable_payments
4476 .entry(payment_hash)
4477 // Note that if we insert here we MUST NOT fail_htlc!()
4478 .or_insert_with(|| {
4479 committed_to_claimable = true;
4481 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4484 if $purpose != claimable_payment.purpose {
4485 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4486 log_trace!(self.logger, "Failing new {} HTLC with payment_hash {} as we already had an existing {} HTLC with the same payment hash", log_keysend(is_keysend), &payment_hash, log_keysend(!is_keysend));
4487 fail_htlc!(claimable_htlc, payment_hash);
4489 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4490 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} as we already had an existing keysend HTLC with the same payment hash and our config states we don't accept MPP keysend", &payment_hash);
4491 fail_htlc!(claimable_htlc, payment_hash);
4493 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4494 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4495 fail_htlc!(claimable_htlc, payment_hash);
4498 claimable_payment.onion_fields = Some(onion_fields);
4500 let ref mut htlcs = &mut claimable_payment.htlcs;
4501 let mut total_value = claimable_htlc.sender_intended_value;
4502 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4503 for htlc in htlcs.iter() {
4504 total_value += htlc.sender_intended_value;
4505 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4506 if htlc.total_msat != claimable_htlc.total_msat {
4507 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4508 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4509 total_value = msgs::MAX_VALUE_MSAT;
4511 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4513 // The condition determining whether an MPP is complete must
4514 // match exactly the condition used in `timer_tick_occurred`
4515 if total_value >= msgs::MAX_VALUE_MSAT {
4516 fail_htlc!(claimable_htlc, payment_hash);
4517 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4518 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4520 fail_htlc!(claimable_htlc, payment_hash);
4521 } else if total_value >= claimable_htlc.total_msat {
4522 #[allow(unused_assignments)] {
4523 committed_to_claimable = true;
4525 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4526 htlcs.push(claimable_htlc);
4527 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4528 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4529 let counterparty_skimmed_fee_msat = htlcs.iter()
4530 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4531 debug_assert!(total_value.saturating_sub(amount_msat) <=
4532 counterparty_skimmed_fee_msat);
4533 new_events.push_back((events::Event::PaymentClaimable {
4534 receiver_node_id: Some(receiver_node_id),
4538 counterparty_skimmed_fee_msat,
4539 via_channel_id: Some(prev_channel_id),
4540 via_user_channel_id: Some(prev_user_channel_id),
4541 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4542 onion_fields: claimable_payment.onion_fields.clone(),
4544 payment_claimable_generated = true;
4546 // Nothing to do - we haven't reached the total
4547 // payment value yet, wait until we receive more
4549 htlcs.push(claimable_htlc);
4550 #[allow(unused_assignments)] {
4551 committed_to_claimable = true;
4554 payment_claimable_generated
4558 // Check that the payment hash and secret are known. Note that we
4559 // MUST take care to handle the "unknown payment hash" and
4560 // "incorrect payment secret" cases here identically or we'd expose
4561 // that we are the ultimate recipient of the given payment hash.
4562 // Further, we must not expose whether we have any other HTLCs
4563 // associated with the same payment_hash pending or not.
4564 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4565 match payment_secrets.entry(payment_hash) {
4566 hash_map::Entry::Vacant(_) => {
4567 match claimable_htlc.onion_payload {
4568 OnionPayload::Invoice { .. } => {
4569 let payment_data = payment_data.unwrap();
4570 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) {
4571 Ok(result) => result,
4573 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4574 fail_htlc!(claimable_htlc, payment_hash);
4577 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4578 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4579 if (cltv_expiry as u64) < expected_min_expiry_height {
4580 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4581 &payment_hash, cltv_expiry, expected_min_expiry_height);
4582 fail_htlc!(claimable_htlc, payment_hash);
4585 let purpose = events::PaymentPurpose::InvoicePayment {
4586 payment_preimage: payment_preimage.clone(),
4587 payment_secret: payment_data.payment_secret,
4589 check_total_value!(purpose);
4591 OnionPayload::Spontaneous(preimage) => {
4592 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4593 check_total_value!(purpose);
4597 hash_map::Entry::Occupied(inbound_payment) => {
4598 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4599 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} because we already have an inbound payment with the same payment hash", &payment_hash);
4600 fail_htlc!(claimable_htlc, payment_hash);
4602 let payment_data = payment_data.unwrap();
4603 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4604 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4605 fail_htlc!(claimable_htlc, payment_hash);
4606 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4607 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4608 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4609 fail_htlc!(claimable_htlc, payment_hash);
4611 let purpose = events::PaymentPurpose::InvoicePayment {
4612 payment_preimage: inbound_payment.get().payment_preimage,
4613 payment_secret: payment_data.payment_secret,
4615 let payment_claimable_generated = check_total_value!(purpose);
4616 if payment_claimable_generated {
4617 inbound_payment.remove_entry();
4623 HTLCForwardInfo::FailHTLC { .. } => {
4624 panic!("Got pending fail of our own HTLC");
4632 let best_block_height = self.best_block.read().unwrap().height();
4633 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4634 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4635 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4637 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4638 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4640 self.forward_htlcs(&mut phantom_receives);
4642 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4643 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4644 // nice to do the work now if we can rather than while we're trying to get messages in the
4646 self.check_free_holding_cells();
4648 if new_events.is_empty() { return }
4649 let mut events = self.pending_events.lock().unwrap();
4650 events.append(&mut new_events);
4653 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4655 /// Expects the caller to have a total_consistency_lock read lock.
4656 fn process_background_events(&self) -> NotifyOption {
4657 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4659 self.background_events_processed_since_startup.store(true, Ordering::Release);
4661 let mut background_events = Vec::new();
4662 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4663 if background_events.is_empty() {
4664 return NotifyOption::SkipPersistNoEvents;
4667 for event in background_events.drain(..) {
4669 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4670 // The channel has already been closed, so no use bothering to care about the
4671 // monitor updating completing.
4672 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4674 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4675 let mut updated_chan = false;
4677 let per_peer_state = self.per_peer_state.read().unwrap();
4678 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4679 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4680 let peer_state = &mut *peer_state_lock;
4681 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4682 hash_map::Entry::Occupied(mut chan_phase) => {
4683 if let ChannelPhase::Funded(chan) = chan_phase.get_mut() {
4684 updated_chan = true;
4685 handle_new_monitor_update!(self, funding_txo, update.clone(),
4686 peer_state_lock, peer_state, per_peer_state, chan);
4688 debug_assert!(false, "We shouldn't have an update for a non-funded channel");
4691 hash_map::Entry::Vacant(_) => {},
4696 // TODO: Track this as in-flight even though the channel is closed.
4697 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4700 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4701 let per_peer_state = self.per_peer_state.read().unwrap();
4702 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4703 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4704 let peer_state = &mut *peer_state_lock;
4705 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4706 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4708 let update_actions = peer_state.monitor_update_blocked_actions
4709 .remove(&channel_id).unwrap_or(Vec::new());
4710 mem::drop(peer_state_lock);
4711 mem::drop(per_peer_state);
4712 self.handle_monitor_update_completion_actions(update_actions);
4718 NotifyOption::DoPersist
4721 #[cfg(any(test, feature = "_test_utils"))]
4722 /// Process background events, for functional testing
4723 pub fn test_process_background_events(&self) {
4724 let _lck = self.total_consistency_lock.read().unwrap();
4725 let _ = self.process_background_events();
4728 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4729 if !chan.context.is_outbound() { return NotifyOption::SkipPersistNoEvents; }
4730 // If the feerate has decreased by less than half, don't bother
4731 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4732 if new_feerate != chan.context.get_feerate_sat_per_1000_weight() {
4733 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4734 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4736 return NotifyOption::SkipPersistNoEvents;
4738 if !chan.context.is_live() {
4739 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).",
4740 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4741 return NotifyOption::SkipPersistNoEvents;
4743 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4744 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4746 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4747 NotifyOption::DoPersist
4751 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4752 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4753 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4754 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4755 pub fn maybe_update_chan_fees(&self) {
4756 PersistenceNotifierGuard::optionally_notify(self, || {
4757 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4759 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4760 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4762 let per_peer_state = self.per_peer_state.read().unwrap();
4763 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4764 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4765 let peer_state = &mut *peer_state_lock;
4766 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4767 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4769 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4774 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4775 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4783 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4785 /// This currently includes:
4786 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4787 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4788 /// than a minute, informing the network that they should no longer attempt to route over
4790 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4791 /// with the current [`ChannelConfig`].
4792 /// * Removing peers which have disconnected but and no longer have any channels.
4793 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4794 /// * Forgetting about stale outbound payments, either those that have already been fulfilled
4795 /// or those awaiting an invoice that hasn't been delivered in the necessary amount of time.
4796 /// The latter is determined using the system clock in `std` and the block time minus two
4797 /// hours in `no-std`.
4799 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4800 /// estimate fetches.
4802 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4803 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4804 pub fn timer_tick_occurred(&self) {
4805 PersistenceNotifierGuard::optionally_notify(self, || {
4806 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4808 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4809 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4811 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4812 let mut timed_out_mpp_htlcs = Vec::new();
4813 let mut pending_peers_awaiting_removal = Vec::new();
4814 let mut shutdown_channels = Vec::new();
4816 let mut process_unfunded_channel_tick = |
4817 chan_id: &ChannelId,
4818 context: &mut ChannelContext<SP>,
4819 unfunded_context: &mut UnfundedChannelContext,
4820 pending_msg_events: &mut Vec<MessageSendEvent>,
4821 counterparty_node_id: PublicKey,
4823 context.maybe_expire_prev_config();
4824 if unfunded_context.should_expire_unfunded_channel() {
4825 log_error!(self.logger,
4826 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4827 update_maps_on_chan_removal!(self, &context);
4828 self.issue_channel_close_events(&context, ClosureReason::HolderForceClosed);
4829 shutdown_channels.push(context.force_shutdown(false));
4830 pending_msg_events.push(MessageSendEvent::HandleError {
4831 node_id: counterparty_node_id,
4832 action: msgs::ErrorAction::SendErrorMessage {
4833 msg: msgs::ErrorMessage {
4834 channel_id: *chan_id,
4835 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4846 let per_peer_state = self.per_peer_state.read().unwrap();
4847 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4848 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4849 let peer_state = &mut *peer_state_lock;
4850 let pending_msg_events = &mut peer_state.pending_msg_events;
4851 let counterparty_node_id = *counterparty_node_id;
4852 peer_state.channel_by_id.retain(|chan_id, phase| {
4854 ChannelPhase::Funded(chan) => {
4855 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4860 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4861 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4863 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4864 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4865 handle_errors.push((Err(err), counterparty_node_id));
4866 if needs_close { return false; }
4869 match chan.channel_update_status() {
4870 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4871 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4872 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4873 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4874 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4875 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4876 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4878 if n >= DISABLE_GOSSIP_TICKS {
4879 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4880 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4881 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4885 should_persist = NotifyOption::DoPersist;
4887 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4890 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4892 if n >= ENABLE_GOSSIP_TICKS {
4893 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4894 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4895 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4899 should_persist = NotifyOption::DoPersist;
4901 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4907 chan.context.maybe_expire_prev_config();
4909 if chan.should_disconnect_peer_awaiting_response() {
4910 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4911 counterparty_node_id, chan_id);
4912 pending_msg_events.push(MessageSendEvent::HandleError {
4913 node_id: counterparty_node_id,
4914 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4915 msg: msgs::WarningMessage {
4916 channel_id: *chan_id,
4917 data: "Disconnecting due to timeout awaiting response".to_owned(),
4925 ChannelPhase::UnfundedInboundV1(chan) => {
4926 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4927 pending_msg_events, counterparty_node_id)
4929 ChannelPhase::UnfundedOutboundV1(chan) => {
4930 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4931 pending_msg_events, counterparty_node_id)
4936 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
4937 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
4938 log_error!(self.logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
4939 peer_state.pending_msg_events.push(
4940 events::MessageSendEvent::HandleError {
4941 node_id: counterparty_node_id,
4942 action: msgs::ErrorAction::SendErrorMessage {
4943 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
4949 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
4951 if peer_state.ok_to_remove(true) {
4952 pending_peers_awaiting_removal.push(counterparty_node_id);
4957 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4958 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4959 // of to that peer is later closed while still being disconnected (i.e. force closed),
4960 // we therefore need to remove the peer from `peer_state` separately.
4961 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4962 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4963 // negative effects on parallelism as much as possible.
4964 if pending_peers_awaiting_removal.len() > 0 {
4965 let mut per_peer_state = self.per_peer_state.write().unwrap();
4966 for counterparty_node_id in pending_peers_awaiting_removal {
4967 match per_peer_state.entry(counterparty_node_id) {
4968 hash_map::Entry::Occupied(entry) => {
4969 // Remove the entry if the peer is still disconnected and we still
4970 // have no channels to the peer.
4971 let remove_entry = {
4972 let peer_state = entry.get().lock().unwrap();
4973 peer_state.ok_to_remove(true)
4976 entry.remove_entry();
4979 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4984 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4985 if payment.htlcs.is_empty() {
4986 // This should be unreachable
4987 debug_assert!(false);
4990 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4991 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4992 // In this case we're not going to handle any timeouts of the parts here.
4993 // This condition determining whether the MPP is complete here must match
4994 // exactly the condition used in `process_pending_htlc_forwards`.
4995 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4996 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4999 } else if payment.htlcs.iter_mut().any(|htlc| {
5000 htlc.timer_ticks += 1;
5001 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
5003 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
5004 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
5011 for htlc_source in timed_out_mpp_htlcs.drain(..) {
5012 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
5013 let reason = HTLCFailReason::from_failure_code(23);
5014 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
5015 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
5018 for (err, counterparty_node_id) in handle_errors.drain(..) {
5019 let _ = handle_error!(self, err, counterparty_node_id);
5022 for shutdown_res in shutdown_channels {
5023 self.finish_close_channel(shutdown_res);
5026 #[cfg(feature = "std")]
5027 let duration_since_epoch = std::time::SystemTime::now()
5028 .duration_since(std::time::SystemTime::UNIX_EPOCH)
5029 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
5030 #[cfg(not(feature = "std"))]
5031 let duration_since_epoch = Duration::from_secs(
5032 self.highest_seen_timestamp.load(Ordering::Acquire).saturating_sub(7200) as u64
5035 self.pending_outbound_payments.remove_stale_payments(
5036 duration_since_epoch, &self.pending_events
5039 // Technically we don't need to do this here, but if we have holding cell entries in a
5040 // channel that need freeing, it's better to do that here and block a background task
5041 // than block the message queueing pipeline.
5042 if self.check_free_holding_cells() {
5043 should_persist = NotifyOption::DoPersist;
5050 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
5051 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
5052 /// along the path (including in our own channel on which we received it).
5054 /// Note that in some cases around unclean shutdown, it is possible the payment may have
5055 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
5056 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
5057 /// may have already been failed automatically by LDK if it was nearing its expiration time.
5059 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
5060 /// [`ChannelManager::claim_funds`]), you should still monitor for
5061 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
5062 /// startup during which time claims that were in-progress at shutdown may be replayed.
5063 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
5064 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
5067 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
5068 /// reason for the failure.
5070 /// See [`FailureCode`] for valid failure codes.
5071 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
5072 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5074 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
5075 if let Some(payment) = removed_source {
5076 for htlc in payment.htlcs {
5077 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
5078 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5079 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
5080 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5085 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
5086 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
5087 match failure_code {
5088 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
5089 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
5090 FailureCode::IncorrectOrUnknownPaymentDetails => {
5091 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5092 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5093 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
5095 FailureCode::InvalidOnionPayload(data) => {
5096 let fail_data = match data {
5097 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
5100 HTLCFailReason::reason(failure_code.into(), fail_data)
5105 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5106 /// that we want to return and a channel.
5108 /// This is for failures on the channel on which the HTLC was *received*, not failures
5110 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5111 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
5112 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
5113 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
5114 // an inbound SCID alias before the real SCID.
5115 let scid_pref = if chan.context.should_announce() {
5116 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
5118 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
5120 if let Some(scid) = scid_pref {
5121 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
5123 (0x4000|10, Vec::new())
5128 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5129 /// that we want to return and a channel.
5130 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5131 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
5132 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
5133 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
5134 if desired_err_code == 0x1000 | 20 {
5135 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
5136 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
5137 0u16.write(&mut enc).expect("Writes cannot fail");
5139 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
5140 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
5141 upd.write(&mut enc).expect("Writes cannot fail");
5142 (desired_err_code, enc.0)
5144 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
5145 // which means we really shouldn't have gotten a payment to be forwarded over this
5146 // channel yet, or if we did it's from a route hint. Either way, returning an error of
5147 // PERM|no_such_channel should be fine.
5148 (0x4000|10, Vec::new())
5152 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
5153 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
5154 // be surfaced to the user.
5155 fn fail_holding_cell_htlcs(
5156 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
5157 counterparty_node_id: &PublicKey
5159 let (failure_code, onion_failure_data) = {
5160 let per_peer_state = self.per_peer_state.read().unwrap();
5161 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5162 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5163 let peer_state = &mut *peer_state_lock;
5164 match peer_state.channel_by_id.entry(channel_id) {
5165 hash_map::Entry::Occupied(chan_phase_entry) => {
5166 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
5167 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
5169 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
5170 debug_assert!(false);
5171 (0x4000|10, Vec::new())
5174 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
5176 } else { (0x4000|10, Vec::new()) }
5179 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
5180 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
5181 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
5182 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
5186 /// Fails an HTLC backwards to the sender of it to us.
5187 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
5188 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
5189 // Ensure that no peer state channel storage lock is held when calling this function.
5190 // This ensures that future code doesn't introduce a lock-order requirement for
5191 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
5192 // this function with any `per_peer_state` peer lock acquired would.
5193 #[cfg(debug_assertions)]
5194 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
5195 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
5198 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
5199 //identify whether we sent it or not based on the (I presume) very different runtime
5200 //between the branches here. We should make this async and move it into the forward HTLCs
5203 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5204 // from block_connected which may run during initialization prior to the chain_monitor
5205 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
5207 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
5208 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
5209 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
5210 &self.pending_events, &self.logger)
5211 { self.push_pending_forwards_ev(); }
5213 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint, .. }) => {
5214 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", &payment_hash, onion_error);
5215 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
5217 let mut push_forward_ev = false;
5218 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5219 if forward_htlcs.is_empty() {
5220 push_forward_ev = true;
5222 match forward_htlcs.entry(*short_channel_id) {
5223 hash_map::Entry::Occupied(mut entry) => {
5224 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
5226 hash_map::Entry::Vacant(entry) => {
5227 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
5230 mem::drop(forward_htlcs);
5231 if push_forward_ev { self.push_pending_forwards_ev(); }
5232 let mut pending_events = self.pending_events.lock().unwrap();
5233 pending_events.push_back((events::Event::HTLCHandlingFailed {
5234 prev_channel_id: outpoint.to_channel_id(),
5235 failed_next_destination: destination,
5241 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
5242 /// [`MessageSendEvent`]s needed to claim the payment.
5244 /// This method is guaranteed to ensure the payment has been claimed but only if the current
5245 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
5246 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
5247 /// successful. It will generally be available in the next [`process_pending_events`] call.
5249 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
5250 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
5251 /// event matches your expectation. If you fail to do so and call this method, you may provide
5252 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5254 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5255 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5256 /// [`claim_funds_with_known_custom_tlvs`].
5258 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5259 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5260 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5261 /// [`process_pending_events`]: EventsProvider::process_pending_events
5262 /// [`create_inbound_payment`]: Self::create_inbound_payment
5263 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5264 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5265 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5266 self.claim_payment_internal(payment_preimage, false);
5269 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5270 /// even type numbers.
5274 /// You MUST check you've understood all even TLVs before using this to
5275 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5277 /// [`claim_funds`]: Self::claim_funds
5278 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5279 self.claim_payment_internal(payment_preimage, true);
5282 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5283 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5285 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5288 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5289 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5290 let mut receiver_node_id = self.our_network_pubkey;
5291 for htlc in payment.htlcs.iter() {
5292 if htlc.prev_hop.phantom_shared_secret.is_some() {
5293 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5294 .expect("Failed to get node_id for phantom node recipient");
5295 receiver_node_id = phantom_pubkey;
5300 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5301 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5302 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5303 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5304 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5306 if dup_purpose.is_some() {
5307 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5308 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5312 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5313 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5314 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5315 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5316 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5317 mem::drop(claimable_payments);
5318 for htlc in payment.htlcs {
5319 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5320 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5321 let receiver = HTLCDestination::FailedPayment { payment_hash };
5322 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5331 debug_assert!(!sources.is_empty());
5333 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5334 // and when we got here we need to check that the amount we're about to claim matches the
5335 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5336 // the MPP parts all have the same `total_msat`.
5337 let mut claimable_amt_msat = 0;
5338 let mut prev_total_msat = None;
5339 let mut expected_amt_msat = None;
5340 let mut valid_mpp = true;
5341 let mut errs = Vec::new();
5342 let per_peer_state = self.per_peer_state.read().unwrap();
5343 for htlc in sources.iter() {
5344 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5345 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5346 debug_assert!(false);
5350 prev_total_msat = Some(htlc.total_msat);
5352 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5353 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5354 debug_assert!(false);
5358 expected_amt_msat = htlc.total_value_received;
5359 claimable_amt_msat += htlc.value;
5361 mem::drop(per_peer_state);
5362 if sources.is_empty() || expected_amt_msat.is_none() {
5363 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5364 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5367 if claimable_amt_msat != expected_amt_msat.unwrap() {
5368 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5369 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5370 expected_amt_msat.unwrap(), claimable_amt_msat);
5374 for htlc in sources.drain(..) {
5375 if let Err((pk, err)) = self.claim_funds_from_hop(
5376 htlc.prev_hop, payment_preimage,
5377 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
5379 if let msgs::ErrorAction::IgnoreError = err.err.action {
5380 // We got a temporary failure updating monitor, but will claim the
5381 // HTLC when the monitor updating is restored (or on chain).
5382 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5383 } else { errs.push((pk, err)); }
5388 for htlc in sources.drain(..) {
5389 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5390 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5391 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5392 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5393 let receiver = HTLCDestination::FailedPayment { payment_hash };
5394 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5396 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5399 // Now we can handle any errors which were generated.
5400 for (counterparty_node_id, err) in errs.drain(..) {
5401 let res: Result<(), _> = Err(err);
5402 let _ = handle_error!(self, res, counterparty_node_id);
5406 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
5407 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5408 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5409 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5411 // If we haven't yet run background events assume we're still deserializing and shouldn't
5412 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5413 // `BackgroundEvent`s.
5414 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5417 let per_peer_state = self.per_peer_state.read().unwrap();
5418 let chan_id = prev_hop.outpoint.to_channel_id();
5419 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5420 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5424 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5425 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5426 .map(|peer_mutex| peer_mutex.lock().unwrap())
5429 if peer_state_opt.is_some() {
5430 let mut peer_state_lock = peer_state_opt.unwrap();
5431 let peer_state = &mut *peer_state_lock;
5432 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5433 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5434 let counterparty_node_id = chan.context.get_counterparty_node_id();
5435 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
5437 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
5438 if let Some(action) = completion_action(Some(htlc_value_msat)) {
5439 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
5441 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5444 handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5445 peer_state, per_peer_state, chan);
5447 // If we're running during init we cannot update a monitor directly -
5448 // they probably haven't actually been loaded yet. Instead, push the
5449 // monitor update as a background event.
5450 self.pending_background_events.lock().unwrap().push(
5451 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5452 counterparty_node_id,
5453 funding_txo: prev_hop.outpoint,
5454 update: monitor_update.clone(),
5463 let preimage_update = ChannelMonitorUpdate {
5464 update_id: CLOSED_CHANNEL_UPDATE_ID,
5465 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5471 // We update the ChannelMonitor on the backward link, after
5472 // receiving an `update_fulfill_htlc` from the forward link.
5473 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5474 if update_res != ChannelMonitorUpdateStatus::Completed {
5475 // TODO: This needs to be handled somehow - if we receive a monitor update
5476 // with a preimage we *must* somehow manage to propagate it to the upstream
5477 // channel, or we must have an ability to receive the same event and try
5478 // again on restart.
5479 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5480 payment_preimage, update_res);
5483 // If we're running during init we cannot update a monitor directly - they probably
5484 // haven't actually been loaded yet. Instead, push the monitor update as a background
5486 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5487 // channel is already closed) we need to ultimately handle the monitor update
5488 // completion action only after we've completed the monitor update. This is the only
5489 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5490 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5491 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5492 // complete the monitor update completion action from `completion_action`.
5493 self.pending_background_events.lock().unwrap().push(
5494 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5495 prev_hop.outpoint, preimage_update,
5498 // Note that we do process the completion action here. This totally could be a
5499 // duplicate claim, but we have no way of knowing without interrogating the
5500 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5501 // generally always allowed to be duplicative (and it's specifically noted in
5502 // `PaymentForwarded`).
5503 self.handle_monitor_update_completion_actions(completion_action(None));
5507 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5508 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5511 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5512 forwarded_htlc_value_msat: Option<u64>, from_onchain: bool,
5513 next_channel_counterparty_node_id: Option<PublicKey>, next_channel_outpoint: OutPoint
5516 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5517 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5518 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5519 if let Some(pubkey) = next_channel_counterparty_node_id {
5520 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5522 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5523 channel_funding_outpoint: next_channel_outpoint,
5524 counterparty_node_id: path.hops[0].pubkey,
5526 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5527 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5530 HTLCSource::PreviousHopData(hop_data) => {
5531 let prev_outpoint = hop_data.outpoint;
5532 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5533 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5534 |htlc_claim_value_msat| {
5535 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5536 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5537 Some(claimed_htlc_value - forwarded_htlc_value)
5540 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5541 event: events::Event::PaymentForwarded {
5543 claim_from_onchain_tx: from_onchain,
5544 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5545 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5546 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5548 downstream_counterparty_and_funding_outpoint:
5549 if let Some(node_id) = next_channel_counterparty_node_id {
5550 Some((node_id, next_channel_outpoint, completed_blocker))
5552 // We can only get `None` here if we are processing a
5553 // `ChannelMonitor`-originated event, in which case we
5554 // don't care about ensuring we wake the downstream
5555 // channel's monitor updating - the channel is already
5562 if let Err((pk, err)) = res {
5563 let result: Result<(), _> = Err(err);
5564 let _ = handle_error!(self, result, pk);
5570 /// Gets the node_id held by this ChannelManager
5571 pub fn get_our_node_id(&self) -> PublicKey {
5572 self.our_network_pubkey.clone()
5575 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5576 for action in actions.into_iter() {
5578 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5579 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5580 if let Some(ClaimingPayment {
5582 payment_purpose: purpose,
5585 sender_intended_value: sender_intended_total_msat,
5587 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5591 receiver_node_id: Some(receiver_node_id),
5593 sender_intended_total_msat,
5597 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5598 event, downstream_counterparty_and_funding_outpoint
5600 self.pending_events.lock().unwrap().push_back((event, None));
5601 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5602 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5609 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5610 /// update completion.
5611 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5612 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5613 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5614 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5615 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5616 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5617 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5618 &channel.context.channel_id(),
5619 if raa.is_some() { "an" } else { "no" },
5620 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5621 if funding_broadcastable.is_some() { "" } else { "not " },
5622 if channel_ready.is_some() { "sending" } else { "without" },
5623 if announcement_sigs.is_some() { "sending" } else { "without" });
5625 let mut htlc_forwards = None;
5627 let counterparty_node_id = channel.context.get_counterparty_node_id();
5628 if !pending_forwards.is_empty() {
5629 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5630 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5633 if let Some(msg) = channel_ready {
5634 send_channel_ready!(self, pending_msg_events, channel, msg);
5636 if let Some(msg) = announcement_sigs {
5637 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5638 node_id: counterparty_node_id,
5643 macro_rules! handle_cs { () => {
5644 if let Some(update) = commitment_update {
5645 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5646 node_id: counterparty_node_id,
5651 macro_rules! handle_raa { () => {
5652 if let Some(revoke_and_ack) = raa {
5653 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5654 node_id: counterparty_node_id,
5655 msg: revoke_and_ack,
5660 RAACommitmentOrder::CommitmentFirst => {
5664 RAACommitmentOrder::RevokeAndACKFirst => {
5670 if let Some(tx) = funding_broadcastable {
5671 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5672 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5676 let mut pending_events = self.pending_events.lock().unwrap();
5677 emit_channel_pending_event!(pending_events, channel);
5678 emit_channel_ready_event!(pending_events, channel);
5684 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5685 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5687 let counterparty_node_id = match counterparty_node_id {
5688 Some(cp_id) => cp_id.clone(),
5690 // TODO: Once we can rely on the counterparty_node_id from the
5691 // monitor event, this and the id_to_peer map should be removed.
5692 let id_to_peer = self.id_to_peer.lock().unwrap();
5693 match id_to_peer.get(&funding_txo.to_channel_id()) {
5694 Some(cp_id) => cp_id.clone(),
5699 let per_peer_state = self.per_peer_state.read().unwrap();
5700 let mut peer_state_lock;
5701 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5702 if peer_state_mutex_opt.is_none() { return }
5703 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5704 let peer_state = &mut *peer_state_lock;
5706 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5709 let update_actions = peer_state.monitor_update_blocked_actions
5710 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5711 mem::drop(peer_state_lock);
5712 mem::drop(per_peer_state);
5713 self.handle_monitor_update_completion_actions(update_actions);
5716 let remaining_in_flight =
5717 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5718 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5721 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5722 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5723 remaining_in_flight);
5724 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5727 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5730 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5732 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5733 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5736 /// The `user_channel_id` parameter will be provided back in
5737 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5738 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5740 /// Note that this method will return an error and reject the channel, if it requires support
5741 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5742 /// used to accept such channels.
5744 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5745 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5746 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5747 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5750 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5751 /// it as confirmed immediately.
5753 /// The `user_channel_id` parameter will be provided back in
5754 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5755 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5757 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5758 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5760 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5761 /// transaction and blindly assumes that it will eventually confirm.
5763 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5764 /// does not pay to the correct script the correct amount, *you will lose funds*.
5766 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5767 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5768 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5769 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5772 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5773 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5775 let peers_without_funded_channels =
5776 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5777 let per_peer_state = self.per_peer_state.read().unwrap();
5778 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5779 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5780 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5781 let peer_state = &mut *peer_state_lock;
5782 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5784 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
5785 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
5786 // that we can delay allocating the SCID until after we're sure that the checks below will
5788 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
5789 Some(unaccepted_channel) => {
5790 let best_block_height = self.best_block.read().unwrap().height();
5791 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5792 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
5793 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
5794 &self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
5796 _ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
5800 // This should have been correctly configured by the call to InboundV1Channel::new.
5801 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
5802 } else if channel.context.get_channel_type().requires_zero_conf() {
5803 let send_msg_err_event = events::MessageSendEvent::HandleError {
5804 node_id: channel.context.get_counterparty_node_id(),
5805 action: msgs::ErrorAction::SendErrorMessage{
5806 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5809 peer_state.pending_msg_events.push(send_msg_err_event);
5810 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5812 // If this peer already has some channels, a new channel won't increase our number of peers
5813 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5814 // channels per-peer we can accept channels from a peer with existing ones.
5815 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5816 let send_msg_err_event = events::MessageSendEvent::HandleError {
5817 node_id: channel.context.get_counterparty_node_id(),
5818 action: msgs::ErrorAction::SendErrorMessage{
5819 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5822 peer_state.pending_msg_events.push(send_msg_err_event);
5823 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5827 // Now that we know we have a channel, assign an outbound SCID alias.
5828 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5829 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5831 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5832 node_id: channel.context.get_counterparty_node_id(),
5833 msg: channel.accept_inbound_channel(),
5836 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
5841 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5842 /// or 0-conf channels.
5844 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5845 /// non-0-conf channels we have with the peer.
5846 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5847 where Filter: Fn(&PeerState<SP>) -> bool {
5848 let mut peers_without_funded_channels = 0;
5849 let best_block_height = self.best_block.read().unwrap().height();
5851 let peer_state_lock = self.per_peer_state.read().unwrap();
5852 for (_, peer_mtx) in peer_state_lock.iter() {
5853 let peer = peer_mtx.lock().unwrap();
5854 if !maybe_count_peer(&*peer) { continue; }
5855 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5856 if num_unfunded_channels == peer.total_channel_count() {
5857 peers_without_funded_channels += 1;
5861 return peers_without_funded_channels;
5864 fn unfunded_channel_count(
5865 peer: &PeerState<SP>, best_block_height: u32
5867 let mut num_unfunded_channels = 0;
5868 for (_, phase) in peer.channel_by_id.iter() {
5870 ChannelPhase::Funded(chan) => {
5871 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5872 // which have not yet had any confirmations on-chain.
5873 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5874 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5876 num_unfunded_channels += 1;
5879 ChannelPhase::UnfundedInboundV1(chan) => {
5880 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5881 num_unfunded_channels += 1;
5884 ChannelPhase::UnfundedOutboundV1(_) => {
5885 // Outbound channels don't contribute to the unfunded count in the DoS context.
5890 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
5893 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5894 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
5895 // likely to be lost on restart!
5896 if msg.chain_hash != self.chain_hash {
5897 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5900 if !self.default_configuration.accept_inbound_channels {
5901 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5904 // Get the number of peers with channels, but without funded ones. We don't care too much
5905 // about peers that never open a channel, so we filter by peers that have at least one
5906 // channel, and then limit the number of those with unfunded channels.
5907 let channeled_peers_without_funding =
5908 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5910 let per_peer_state = self.per_peer_state.read().unwrap();
5911 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5913 debug_assert!(false);
5914 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())
5916 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5917 let peer_state = &mut *peer_state_lock;
5919 // If this peer already has some channels, a new channel won't increase our number of peers
5920 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5921 // channels per-peer we can accept channels from a peer with existing ones.
5922 if peer_state.total_channel_count() == 0 &&
5923 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5924 !self.default_configuration.manually_accept_inbound_channels
5926 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5927 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5928 msg.temporary_channel_id.clone()));
5931 let best_block_height = self.best_block.read().unwrap().height();
5932 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5933 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5934 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5935 msg.temporary_channel_id.clone()));
5938 let channel_id = msg.temporary_channel_id;
5939 let channel_exists = peer_state.has_channel(&channel_id);
5941 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
5944 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
5945 if self.default_configuration.manually_accept_inbound_channels {
5946 let mut pending_events = self.pending_events.lock().unwrap();
5947 pending_events.push_back((events::Event::OpenChannelRequest {
5948 temporary_channel_id: msg.temporary_channel_id.clone(),
5949 counterparty_node_id: counterparty_node_id.clone(),
5950 funding_satoshis: msg.funding_satoshis,
5951 push_msat: msg.push_msat,
5952 channel_type: msg.channel_type.clone().unwrap(),
5954 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
5955 open_channel_msg: msg.clone(),
5956 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
5961 // Otherwise create the channel right now.
5962 let mut random_bytes = [0u8; 16];
5963 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5964 let user_channel_id = u128::from_be_bytes(random_bytes);
5965 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5966 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5967 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
5970 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5975 let channel_type = channel.context.get_channel_type();
5976 if channel_type.requires_zero_conf() {
5977 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5979 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5980 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5983 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5984 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5986 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5987 node_id: counterparty_node_id.clone(),
5988 msg: channel.accept_inbound_channel(),
5990 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
5994 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5995 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
5996 // likely to be lost on restart!
5997 let (value, output_script, user_id) = {
5998 let per_peer_state = self.per_peer_state.read().unwrap();
5999 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6001 debug_assert!(false);
6002 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)
6004 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6005 let peer_state = &mut *peer_state_lock;
6006 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
6007 hash_map::Entry::Occupied(mut phase) => {
6008 match phase.get_mut() {
6009 ChannelPhase::UnfundedOutboundV1(chan) => {
6010 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
6011 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
6014 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected accept_channel message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
6018 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))
6021 let mut pending_events = self.pending_events.lock().unwrap();
6022 pending_events.push_back((events::Event::FundingGenerationReady {
6023 temporary_channel_id: msg.temporary_channel_id,
6024 counterparty_node_id: *counterparty_node_id,
6025 channel_value_satoshis: value,
6027 user_channel_id: user_id,
6032 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
6033 let best_block = *self.best_block.read().unwrap();
6035 let per_peer_state = self.per_peer_state.read().unwrap();
6036 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6038 debug_assert!(false);
6039 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)
6042 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6043 let peer_state = &mut *peer_state_lock;
6044 let (chan, funding_msg, monitor) =
6045 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
6046 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
6047 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
6049 Err((mut inbound_chan, err)) => {
6050 // We've already removed this inbound channel from the map in `PeerState`
6051 // above so at this point we just need to clean up any lingering entries
6052 // concerning this channel as it is safe to do so.
6053 update_maps_on_chan_removal!(self, &inbound_chan.context);
6054 let user_id = inbound_chan.context.get_user_id();
6055 let shutdown_res = inbound_chan.context.force_shutdown(false);
6056 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
6057 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
6061 Some(ChannelPhase::Funded(_)) | Some(ChannelPhase::UnfundedOutboundV1(_)) => {
6062 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
6064 None => 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))
6067 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
6068 hash_map::Entry::Occupied(_) => {
6069 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
6071 hash_map::Entry::Vacant(e) => {
6072 let mut id_to_peer_lock = self.id_to_peer.lock().unwrap();
6073 match id_to_peer_lock.entry(chan.context.channel_id()) {
6074 hash_map::Entry::Occupied(_) => {
6075 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6076 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
6077 funding_msg.channel_id))
6079 hash_map::Entry::Vacant(i_e) => {
6080 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
6081 if let Ok(persist_state) = monitor_res {
6082 i_e.insert(chan.context.get_counterparty_node_id());
6083 mem::drop(id_to_peer_lock);
6085 // There's no problem signing a counterparty's funding transaction if our monitor
6086 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
6087 // accepted payment from yet. We do, however, need to wait to send our channel_ready
6088 // until we have persisted our monitor.
6089 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6090 node_id: counterparty_node_id.clone(),
6094 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
6095 handle_new_monitor_update!(self, persist_state, peer_state_lock, peer_state,
6096 per_peer_state, chan, INITIAL_MONITOR);
6098 unreachable!("This must be a funded channel as we just inserted it.");
6102 log_error!(self.logger, "Persisting initial ChannelMonitor failed, implying the funding outpoint was duplicated");
6103 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6104 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
6105 funding_msg.channel_id));
6113 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
6114 let best_block = *self.best_block.read().unwrap();
6115 let per_peer_state = self.per_peer_state.read().unwrap();
6116 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6118 debug_assert!(false);
6119 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6122 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6123 let peer_state = &mut *peer_state_lock;
6124 match peer_state.channel_by_id.entry(msg.channel_id) {
6125 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6126 match chan_phase_entry.get_mut() {
6127 ChannelPhase::Funded(ref mut chan) => {
6128 let monitor = try_chan_phase_entry!(self,
6129 chan.funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan_phase_entry);
6130 if let Ok(persist_status) = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor) {
6131 handle_new_monitor_update!(self, persist_status, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
6134 try_chan_phase_entry!(self, Err(ChannelError::Close("Channel funding outpoint was a duplicate".to_owned())), chan_phase_entry)
6138 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
6142 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
6146 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
6147 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6148 // closing a channel), so any changes are likely to be lost on restart!
6149 let per_peer_state = self.per_peer_state.read().unwrap();
6150 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6152 debug_assert!(false);
6153 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6155 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6156 let peer_state = &mut *peer_state_lock;
6157 match peer_state.channel_by_id.entry(msg.channel_id) {
6158 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6159 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6160 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
6161 self.chain_hash, &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan_phase_entry);
6162 if let Some(announcement_sigs) = announcement_sigs_opt {
6163 log_trace!(self.logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
6164 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6165 node_id: counterparty_node_id.clone(),
6166 msg: announcement_sigs,
6168 } else if chan.context.is_usable() {
6169 // If we're sending an announcement_signatures, we'll send the (public)
6170 // channel_update after sending a channel_announcement when we receive our
6171 // counterparty's announcement_signatures. Thus, we only bother to send a
6172 // channel_update here if the channel is not public, i.e. we're not sending an
6173 // announcement_signatures.
6174 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
6175 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6176 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6177 node_id: counterparty_node_id.clone(),
6184 let mut pending_events = self.pending_events.lock().unwrap();
6185 emit_channel_ready_event!(pending_events, chan);
6190 try_chan_phase_entry!(self, Err(ChannelError::Close(
6191 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
6194 hash_map::Entry::Vacant(_) => {
6195 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))
6200 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
6201 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
6202 let mut finish_shutdown = None;
6204 let per_peer_state = self.per_peer_state.read().unwrap();
6205 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6207 debug_assert!(false);
6208 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6210 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6211 let peer_state = &mut *peer_state_lock;
6212 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6213 let phase = chan_phase_entry.get_mut();
6215 ChannelPhase::Funded(chan) => {
6216 if !chan.received_shutdown() {
6217 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
6219 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
6222 let funding_txo_opt = chan.context.get_funding_txo();
6223 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
6224 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
6225 dropped_htlcs = htlcs;
6227 if let Some(msg) = shutdown {
6228 // We can send the `shutdown` message before updating the `ChannelMonitor`
6229 // here as we don't need the monitor update to complete until we send a
6230 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
6231 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6232 node_id: *counterparty_node_id,
6236 // Update the monitor with the shutdown script if necessary.
6237 if let Some(monitor_update) = monitor_update_opt {
6238 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
6239 peer_state_lock, peer_state, per_peer_state, chan);
6242 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6243 let context = phase.context_mut();
6244 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6245 self.issue_channel_close_events(&context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
6246 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6247 finish_shutdown = Some(chan.context_mut().force_shutdown(false));
6251 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))
6254 for htlc_source in dropped_htlcs.drain(..) {
6255 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6256 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6257 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6259 if let Some(shutdown_res) = finish_shutdown {
6260 self.finish_close_channel(shutdown_res);
6266 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6267 let mut shutdown_result = None;
6268 let unbroadcasted_batch_funding_txid;
6269 let per_peer_state = self.per_peer_state.read().unwrap();
6270 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6272 debug_assert!(false);
6273 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6275 let (tx, chan_option) = {
6276 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6277 let peer_state = &mut *peer_state_lock;
6278 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6279 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6280 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6281 unbroadcasted_batch_funding_txid = chan.context.unbroadcasted_batch_funding_txid();
6282 let (closing_signed, tx) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6283 if let Some(msg) = closing_signed {
6284 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6285 node_id: counterparty_node_id.clone(),
6290 // We're done with this channel, we've got a signed closing transaction and
6291 // will send the closing_signed back to the remote peer upon return. This
6292 // also implies there are no pending HTLCs left on the channel, so we can
6293 // fully delete it from tracking (the channel monitor is still around to
6294 // watch for old state broadcasts)!
6295 (tx, Some(remove_channel_phase!(self, chan_phase_entry)))
6296 } else { (tx, None) }
6298 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6299 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6302 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))
6305 if let Some(broadcast_tx) = tx {
6306 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
6307 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6309 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6310 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6311 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6312 let peer_state = &mut *peer_state_lock;
6313 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6317 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6318 shutdown_result = Some((None, Vec::new(), unbroadcasted_batch_funding_txid));
6320 mem::drop(per_peer_state);
6321 if let Some(shutdown_result) = shutdown_result {
6322 self.finish_close_channel(shutdown_result);
6327 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6328 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6329 //determine the state of the payment based on our response/if we forward anything/the time
6330 //we take to respond. We should take care to avoid allowing such an attack.
6332 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6333 //us repeatedly garbled in different ways, and compare our error messages, which are
6334 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6335 //but we should prevent it anyway.
6337 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6338 // closing a channel), so any changes are likely to be lost on restart!
6340 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
6341 let per_peer_state = self.per_peer_state.read().unwrap();
6342 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6344 debug_assert!(false);
6345 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6347 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6348 let peer_state = &mut *peer_state_lock;
6349 match peer_state.channel_by_id.entry(msg.channel_id) {
6350 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6351 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6352 let pending_forward_info = match decoded_hop_res {
6353 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6354 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
6355 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
6356 Err(e) => PendingHTLCStatus::Fail(e)
6358 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6359 // If the update_add is completely bogus, the call will Err and we will close,
6360 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6361 // want to reject the new HTLC and fail it backwards instead of forwarding.
6362 match pending_forward_info {
6363 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
6364 let reason = if (error_code & 0x1000) != 0 {
6365 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6366 HTLCFailReason::reason(real_code, error_data)
6368 HTLCFailReason::from_failure_code(error_code)
6369 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6370 let msg = msgs::UpdateFailHTLC {
6371 channel_id: msg.channel_id,
6372 htlc_id: msg.htlc_id,
6375 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6377 _ => pending_forward_info
6380 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan_phase_entry);
6382 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6383 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6386 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))
6391 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6393 let (htlc_source, forwarded_htlc_value) = {
6394 let per_peer_state = self.per_peer_state.read().unwrap();
6395 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6397 debug_assert!(false);
6398 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6400 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6401 let peer_state = &mut *peer_state_lock;
6402 match peer_state.channel_by_id.entry(msg.channel_id) {
6403 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6404 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6405 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6406 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6407 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6408 .or_insert_with(Vec::new)
6409 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6411 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6412 // entry here, even though we *do* need to block the next RAA monitor update.
6413 // We do this instead in the `claim_funds_internal` by attaching a
6414 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6415 // outbound HTLC is claimed. This is guaranteed to all complete before we
6416 // process the RAA as messages are processed from single peers serially.
6417 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6420 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6421 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6424 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))
6427 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, Some(*counterparty_node_id), funding_txo);
6431 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6432 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6433 // closing a channel), so any changes are likely to be lost on restart!
6434 let per_peer_state = self.per_peer_state.read().unwrap();
6435 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6437 debug_assert!(false);
6438 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6440 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6441 let peer_state = &mut *peer_state_lock;
6442 match peer_state.channel_by_id.entry(msg.channel_id) {
6443 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6444 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6445 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6447 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6448 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6451 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))
6456 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6457 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6458 // closing a channel), so any changes are likely to be lost on restart!
6459 let per_peer_state = self.per_peer_state.read().unwrap();
6460 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6462 debug_assert!(false);
6463 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6465 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6466 let peer_state = &mut *peer_state_lock;
6467 match peer_state.channel_by_id.entry(msg.channel_id) {
6468 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6469 if (msg.failure_code & 0x8000) == 0 {
6470 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6471 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6473 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6474 try_chan_phase_entry!(self, chan.update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan_phase_entry);
6476 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6477 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6481 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))
6485 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6486 let per_peer_state = self.per_peer_state.read().unwrap();
6487 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6489 debug_assert!(false);
6490 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6492 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6493 let peer_state = &mut *peer_state_lock;
6494 match peer_state.channel_by_id.entry(msg.channel_id) {
6495 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6496 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6497 let funding_txo = chan.context.get_funding_txo();
6498 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &self.logger), chan_phase_entry);
6499 if let Some(monitor_update) = monitor_update_opt {
6500 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6501 peer_state, per_peer_state, chan);
6505 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6506 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6509 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))
6514 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6515 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6516 let mut push_forward_event = false;
6517 let mut new_intercept_events = VecDeque::new();
6518 let mut failed_intercept_forwards = Vec::new();
6519 if !pending_forwards.is_empty() {
6520 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6521 let scid = match forward_info.routing {
6522 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6523 PendingHTLCRouting::Receive { .. } => 0,
6524 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6526 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6527 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6529 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6530 let forward_htlcs_empty = forward_htlcs.is_empty();
6531 match forward_htlcs.entry(scid) {
6532 hash_map::Entry::Occupied(mut entry) => {
6533 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6534 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6536 hash_map::Entry::Vacant(entry) => {
6537 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6538 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.chain_hash)
6540 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
6541 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6542 match pending_intercepts.entry(intercept_id) {
6543 hash_map::Entry::Vacant(entry) => {
6544 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6545 requested_next_hop_scid: scid,
6546 payment_hash: forward_info.payment_hash,
6547 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6548 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6551 entry.insert(PendingAddHTLCInfo {
6552 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6554 hash_map::Entry::Occupied(_) => {
6555 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6556 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6557 short_channel_id: prev_short_channel_id,
6558 user_channel_id: Some(prev_user_channel_id),
6559 outpoint: prev_funding_outpoint,
6560 htlc_id: prev_htlc_id,
6561 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6562 phantom_shared_secret: None,
6565 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6566 HTLCFailReason::from_failure_code(0x4000 | 10),
6567 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6572 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6573 // payments are being processed.
6574 if forward_htlcs_empty {
6575 push_forward_event = true;
6577 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6578 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6585 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6586 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6589 if !new_intercept_events.is_empty() {
6590 let mut events = self.pending_events.lock().unwrap();
6591 events.append(&mut new_intercept_events);
6593 if push_forward_event { self.push_pending_forwards_ev() }
6597 fn push_pending_forwards_ev(&self) {
6598 let mut pending_events = self.pending_events.lock().unwrap();
6599 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6600 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6601 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6603 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6604 // events is done in batches and they are not removed until we're done processing each
6605 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6606 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6607 // payments will need an additional forwarding event before being claimed to make them look
6608 // real by taking more time.
6609 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6610 pending_events.push_back((Event::PendingHTLCsForwardable {
6611 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6616 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6617 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6618 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6619 /// the [`ChannelMonitorUpdate`] in question.
6620 fn raa_monitor_updates_held(&self,
6621 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6622 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6624 actions_blocking_raa_monitor_updates
6625 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6626 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6627 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6628 channel_funding_outpoint,
6629 counterparty_node_id,
6634 #[cfg(any(test, feature = "_test_utils"))]
6635 pub(crate) fn test_raa_monitor_updates_held(&self,
6636 counterparty_node_id: PublicKey, channel_id: ChannelId
6638 let per_peer_state = self.per_peer_state.read().unwrap();
6639 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6640 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6641 let peer_state = &mut *peer_state_lck;
6643 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
6644 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6645 chan.context().get_funding_txo().unwrap(), counterparty_node_id);
6651 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6652 let htlcs_to_fail = {
6653 let per_peer_state = self.per_peer_state.read().unwrap();
6654 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6656 debug_assert!(false);
6657 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6658 }).map(|mtx| mtx.lock().unwrap())?;
6659 let peer_state = &mut *peer_state_lock;
6660 match peer_state.channel_by_id.entry(msg.channel_id) {
6661 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6662 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6663 let funding_txo_opt = chan.context.get_funding_txo();
6664 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6665 self.raa_monitor_updates_held(
6666 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6667 *counterparty_node_id)
6669 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
6670 chan.revoke_and_ack(&msg, &self.fee_estimator, &self.logger, mon_update_blocked), chan_phase_entry);
6671 if let Some(monitor_update) = monitor_update_opt {
6672 let funding_txo = funding_txo_opt
6673 .expect("Funding outpoint must have been set for RAA handling to succeed");
6674 handle_new_monitor_update!(self, funding_txo, monitor_update,
6675 peer_state_lock, peer_state, per_peer_state, chan);
6679 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6680 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
6683 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))
6686 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6690 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6691 let per_peer_state = self.per_peer_state.read().unwrap();
6692 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6694 debug_assert!(false);
6695 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6697 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6698 let peer_state = &mut *peer_state_lock;
6699 match peer_state.channel_by_id.entry(msg.channel_id) {
6700 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6701 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6702 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &self.logger), chan_phase_entry);
6704 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6705 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
6708 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))
6713 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6714 let per_peer_state = self.per_peer_state.read().unwrap();
6715 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6717 debug_assert!(false);
6718 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6720 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6721 let peer_state = &mut *peer_state_lock;
6722 match peer_state.channel_by_id.entry(msg.channel_id) {
6723 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6724 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6725 if !chan.context.is_usable() {
6726 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6729 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6730 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
6731 &self.node_signer, self.chain_hash, self.best_block.read().unwrap().height(),
6732 msg, &self.default_configuration
6733 ), chan_phase_entry),
6734 // Note that announcement_signatures fails if the channel cannot be announced,
6735 // so get_channel_update_for_broadcast will never fail by the time we get here.
6736 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
6739 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6740 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
6743 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))
6748 /// Returns DoPersist if anything changed, otherwise either SkipPersistNoEvents or an Err.
6749 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6750 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6751 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6753 // It's not a local channel
6754 return Ok(NotifyOption::SkipPersistNoEvents)
6757 let per_peer_state = self.per_peer_state.read().unwrap();
6758 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6759 if peer_state_mutex_opt.is_none() {
6760 return Ok(NotifyOption::SkipPersistNoEvents)
6762 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6763 let peer_state = &mut *peer_state_lock;
6764 match peer_state.channel_by_id.entry(chan_id) {
6765 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6766 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6767 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
6768 if chan.context.should_announce() {
6769 // If the announcement is about a channel of ours which is public, some
6770 // other peer may simply be forwarding all its gossip to us. Don't provide
6771 // a scary-looking error message and return Ok instead.
6772 return Ok(NotifyOption::SkipPersistNoEvents);
6774 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));
6776 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
6777 let msg_from_node_one = msg.contents.flags & 1 == 0;
6778 if were_node_one == msg_from_node_one {
6779 return Ok(NotifyOption::SkipPersistNoEvents);
6781 log_debug!(self.logger, "Received channel_update {:?} for channel {}.", msg, chan_id);
6782 let did_change = try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
6783 // If nothing changed after applying their update, we don't need to bother
6786 return Ok(NotifyOption::SkipPersistNoEvents);
6790 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6791 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
6794 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersistNoEvents)
6796 Ok(NotifyOption::DoPersist)
6799 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<NotifyOption, MsgHandleErrInternal> {
6801 let need_lnd_workaround = {
6802 let per_peer_state = self.per_peer_state.read().unwrap();
6804 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6806 debug_assert!(false);
6807 MsgHandleErrInternal::send_err_msg_no_close(
6808 format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id),
6812 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6813 let peer_state = &mut *peer_state_lock;
6814 match peer_state.channel_by_id.entry(msg.channel_id) {
6815 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6816 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6817 // Currently, we expect all holding cell update_adds to be dropped on peer
6818 // disconnect, so Channel's reestablish will never hand us any holding cell
6819 // freed HTLCs to fail backwards. If in the future we no longer drop pending
6820 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
6821 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
6822 msg, &self.logger, &self.node_signer, self.chain_hash,
6823 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
6824 let mut channel_update = None;
6825 if let Some(msg) = responses.shutdown_msg {
6826 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6827 node_id: counterparty_node_id.clone(),
6830 } else if chan.context.is_usable() {
6831 // If the channel is in a usable state (ie the channel is not being shut
6832 // down), send a unicast channel_update to our counterparty to make sure
6833 // they have the latest channel parameters.
6834 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6835 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
6836 node_id: chan.context.get_counterparty_node_id(),
6841 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
6842 htlc_forwards = self.handle_channel_resumption(
6843 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
6844 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
6845 if let Some(upd) = channel_update {
6846 peer_state.pending_msg_events.push(upd);
6850 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6851 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
6854 hash_map::Entry::Vacant(_) => {
6855 log_debug!(self.logger, "Sending bogus ChannelReestablish for unknown channel {} to force channel closure",
6856 log_bytes!(msg.channel_id.0));
6857 // Unfortunately, lnd doesn't force close on errors
6858 // (https://github.com/lightningnetwork/lnd/blob/abb1e3463f3a83bbb843d5c399869dbe930ad94f/htlcswitch/link.go#L2119).
6859 // One of the few ways to get an lnd counterparty to force close is by
6860 // replicating what they do when restoring static channel backups (SCBs). They
6861 // send an invalid `ChannelReestablish` with `0` commitment numbers and an
6862 // invalid `your_last_per_commitment_secret`.
6864 // Since we received a `ChannelReestablish` for a channel that doesn't exist, we
6865 // can assume it's likely the channel closed from our point of view, but it
6866 // remains open on the counterparty's side. By sending this bogus
6867 // `ChannelReestablish` message now as a response to theirs, we trigger them to
6868 // force close broadcasting their latest state. If the closing transaction from
6869 // our point of view remains unconfirmed, it'll enter a race with the
6870 // counterparty's to-be-broadcast latest commitment transaction.
6871 peer_state.pending_msg_events.push(MessageSendEvent::SendChannelReestablish {
6872 node_id: *counterparty_node_id,
6873 msg: msgs::ChannelReestablish {
6874 channel_id: msg.channel_id,
6875 next_local_commitment_number: 0,
6876 next_remote_commitment_number: 0,
6877 your_last_per_commitment_secret: [1u8; 32],
6878 my_current_per_commitment_point: PublicKey::from_slice(&[2u8; 33]).unwrap(),
6879 next_funding_txid: None,
6882 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6883 format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
6884 counterparty_node_id), msg.channel_id)
6890 let mut persist = NotifyOption::SkipPersistHandleEvents;
6891 if let Some(forwards) = htlc_forwards {
6892 self.forward_htlcs(&mut [forwards][..]);
6893 persist = NotifyOption::DoPersist;
6896 if let Some(channel_ready_msg) = need_lnd_workaround {
6897 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
6902 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
6903 fn process_pending_monitor_events(&self) -> bool {
6904 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
6906 let mut failed_channels = Vec::new();
6907 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
6908 let has_pending_monitor_events = !pending_monitor_events.is_empty();
6909 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
6910 for monitor_event in monitor_events.drain(..) {
6911 match monitor_event {
6912 MonitorEvent::HTLCEvent(htlc_update) => {
6913 if let Some(preimage) = htlc_update.payment_preimage {
6914 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", preimage);
6915 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, counterparty_node_id, funding_outpoint);
6917 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
6918 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
6919 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6920 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
6923 MonitorEvent::HolderForceClosed(funding_outpoint) => {
6924 let counterparty_node_id_opt = match counterparty_node_id {
6925 Some(cp_id) => Some(cp_id),
6927 // TODO: Once we can rely on the counterparty_node_id from the
6928 // monitor event, this and the id_to_peer map should be removed.
6929 let id_to_peer = self.id_to_peer.lock().unwrap();
6930 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6933 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6934 let per_peer_state = self.per_peer_state.read().unwrap();
6935 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6936 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6937 let peer_state = &mut *peer_state_lock;
6938 let pending_msg_events = &mut peer_state.pending_msg_events;
6939 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6940 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
6941 failed_channels.push(chan.context.force_shutdown(false));
6942 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6943 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6947 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
6948 pending_msg_events.push(events::MessageSendEvent::HandleError {
6949 node_id: chan.context.get_counterparty_node_id(),
6950 action: msgs::ErrorAction::DisconnectPeer {
6951 msg: Some(msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() })
6959 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6960 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6966 for failure in failed_channels.drain(..) {
6967 self.finish_close_channel(failure);
6970 has_pending_monitor_events
6973 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6974 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6975 /// update events as a separate process method here.
6977 pub fn process_monitor_events(&self) {
6978 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6979 self.process_pending_monitor_events();
6982 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6983 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6984 /// update was applied.
6985 fn check_free_holding_cells(&self) -> bool {
6986 let mut has_monitor_update = false;
6987 let mut failed_htlcs = Vec::new();
6989 // Walk our list of channels and find any that need to update. Note that when we do find an
6990 // update, if it includes actions that must be taken afterwards, we have to drop the
6991 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6992 // manage to go through all our peers without finding a single channel to update.
6994 let per_peer_state = self.per_peer_state.read().unwrap();
6995 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6997 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6998 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6999 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
7000 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
7002 let counterparty_node_id = chan.context.get_counterparty_node_id();
7003 let funding_txo = chan.context.get_funding_txo();
7004 let (monitor_opt, holding_cell_failed_htlcs) =
7005 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
7006 if !holding_cell_failed_htlcs.is_empty() {
7007 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
7009 if let Some(monitor_update) = monitor_opt {
7010 has_monitor_update = true;
7012 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
7013 peer_state_lock, peer_state, per_peer_state, chan);
7014 continue 'peer_loop;
7023 let has_update = has_monitor_update || !failed_htlcs.is_empty();
7024 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
7025 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
7031 /// Check whether any channels have finished removing all pending updates after a shutdown
7032 /// exchange and can now send a closing_signed.
7033 /// Returns whether any closing_signed messages were generated.
7034 fn maybe_generate_initial_closing_signed(&self) -> bool {
7035 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
7036 let mut has_update = false;
7037 let mut shutdown_results = Vec::new();
7039 let per_peer_state = self.per_peer_state.read().unwrap();
7041 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7042 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7043 let peer_state = &mut *peer_state_lock;
7044 let pending_msg_events = &mut peer_state.pending_msg_events;
7045 peer_state.channel_by_id.retain(|channel_id, phase| {
7047 ChannelPhase::Funded(chan) => {
7048 let unbroadcasted_batch_funding_txid = chan.context.unbroadcasted_batch_funding_txid();
7049 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
7050 Ok((msg_opt, tx_opt)) => {
7051 if let Some(msg) = msg_opt {
7053 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
7054 node_id: chan.context.get_counterparty_node_id(), msg,
7057 if let Some(tx) = tx_opt {
7058 // We're done with this channel. We got a closing_signed and sent back
7059 // a closing_signed with a closing transaction to broadcast.
7060 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7061 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7066 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
7068 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
7069 self.tx_broadcaster.broadcast_transactions(&[&tx]);
7070 update_maps_on_chan_removal!(self, &chan.context);
7071 shutdown_results.push((None, Vec::new(), unbroadcasted_batch_funding_txid));
7077 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
7078 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
7083 _ => true, // Retain unfunded channels if present.
7089 for (counterparty_node_id, err) in handle_errors.drain(..) {
7090 let _ = handle_error!(self, err, counterparty_node_id);
7093 for shutdown_result in shutdown_results.drain(..) {
7094 self.finish_close_channel(shutdown_result);
7100 /// Handle a list of channel failures during a block_connected or block_disconnected call,
7101 /// pushing the channel monitor update (if any) to the background events queue and removing the
7103 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
7104 for mut failure in failed_channels.drain(..) {
7105 // Either a commitment transactions has been confirmed on-chain or
7106 // Channel::block_disconnected detected that the funding transaction has been
7107 // reorganized out of the main chain.
7108 // We cannot broadcast our latest local state via monitor update (as
7109 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
7110 // so we track the update internally and handle it when the user next calls
7111 // timer_tick_occurred, guaranteeing we're running normally.
7112 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
7113 assert_eq!(update.updates.len(), 1);
7114 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
7115 assert!(should_broadcast);
7116 } else { unreachable!(); }
7117 self.pending_background_events.lock().unwrap().push(
7118 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
7119 counterparty_node_id, funding_txo, update
7122 self.finish_close_channel(failure);
7126 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
7129 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
7130 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
7132 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
7133 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
7134 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
7135 /// passed directly to [`claim_funds`].
7137 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
7139 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7140 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7144 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7145 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7147 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7149 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7150 /// on versions of LDK prior to 0.0.114.
7152 /// [`claim_funds`]: Self::claim_funds
7153 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7154 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
7155 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
7156 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
7157 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
7158 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
7159 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
7160 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
7161 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7162 min_final_cltv_expiry_delta)
7165 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
7166 /// stored external to LDK.
7168 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
7169 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
7170 /// the `min_value_msat` provided here, if one is provided.
7172 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
7173 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
7176 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
7177 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
7178 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
7179 /// sender "proof-of-payment" unless they have paid the required amount.
7181 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
7182 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
7183 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
7184 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
7185 /// invoices when no timeout is set.
7187 /// Note that we use block header time to time-out pending inbound payments (with some margin
7188 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
7189 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
7190 /// If you need exact expiry semantics, you should enforce them upon receipt of
7191 /// [`PaymentClaimable`].
7193 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
7194 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
7196 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7197 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7201 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7202 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7204 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7206 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7207 /// on versions of LDK prior to 0.0.114.
7209 /// [`create_inbound_payment`]: Self::create_inbound_payment
7210 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7211 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
7212 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
7213 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
7214 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7215 min_final_cltv_expiry)
7218 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
7219 /// previously returned from [`create_inbound_payment`].
7221 /// [`create_inbound_payment`]: Self::create_inbound_payment
7222 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
7223 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
7226 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
7227 /// are used when constructing the phantom invoice's route hints.
7229 /// [phantom node payments]: crate::sign::PhantomKeysManager
7230 pub fn get_phantom_scid(&self) -> u64 {
7231 let best_block_height = self.best_block.read().unwrap().height();
7232 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7234 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7235 // Ensure the generated scid doesn't conflict with a real channel.
7236 match short_to_chan_info.get(&scid_candidate) {
7237 Some(_) => continue,
7238 None => return scid_candidate
7243 /// Gets route hints for use in receiving [phantom node payments].
7245 /// [phantom node payments]: crate::sign::PhantomKeysManager
7246 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
7248 channels: self.list_usable_channels(),
7249 phantom_scid: self.get_phantom_scid(),
7250 real_node_pubkey: self.get_our_node_id(),
7254 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
7255 /// used when constructing the route hints for HTLCs intended to be intercepted. See
7256 /// [`ChannelManager::forward_intercepted_htlc`].
7258 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
7259 /// times to get a unique scid.
7260 pub fn get_intercept_scid(&self) -> u64 {
7261 let best_block_height = self.best_block.read().unwrap().height();
7262 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7264 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7265 // Ensure the generated scid doesn't conflict with a real channel.
7266 if short_to_chan_info.contains_key(&scid_candidate) { continue }
7267 return scid_candidate
7271 /// Gets inflight HTLC information by processing pending outbound payments that are in
7272 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
7273 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
7274 let mut inflight_htlcs = InFlightHtlcs::new();
7276 let per_peer_state = self.per_peer_state.read().unwrap();
7277 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7278 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7279 let peer_state = &mut *peer_state_lock;
7280 for chan in peer_state.channel_by_id.values().filter_map(
7281 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
7283 for (htlc_source, _) in chan.inflight_htlc_sources() {
7284 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
7285 inflight_htlcs.process_path(path, self.get_our_node_id());
7294 #[cfg(any(test, feature = "_test_utils"))]
7295 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
7296 let events = core::cell::RefCell::new(Vec::new());
7297 let event_handler = |event: events::Event| events.borrow_mut().push(event);
7298 self.process_pending_events(&event_handler);
7302 #[cfg(feature = "_test_utils")]
7303 pub fn push_pending_event(&self, event: events::Event) {
7304 let mut events = self.pending_events.lock().unwrap();
7305 events.push_back((event, None));
7309 pub fn pop_pending_event(&self) -> Option<events::Event> {
7310 let mut events = self.pending_events.lock().unwrap();
7311 events.pop_front().map(|(e, _)| e)
7315 pub fn has_pending_payments(&self) -> bool {
7316 self.pending_outbound_payments.has_pending_payments()
7320 pub fn clear_pending_payments(&self) {
7321 self.pending_outbound_payments.clear_pending_payments()
7324 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
7325 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
7326 /// operation. It will double-check that nothing *else* is also blocking the same channel from
7327 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
7328 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
7330 let per_peer_state = self.per_peer_state.read().unwrap();
7331 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
7332 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
7333 let peer_state = &mut *peer_state_lck;
7335 if let Some(blocker) = completed_blocker.take() {
7336 // Only do this on the first iteration of the loop.
7337 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
7338 .get_mut(&channel_funding_outpoint.to_channel_id())
7340 blockers.retain(|iter| iter != &blocker);
7344 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
7345 channel_funding_outpoint, counterparty_node_id) {
7346 // Check that, while holding the peer lock, we don't have anything else
7347 // blocking monitor updates for this channel. If we do, release the monitor
7348 // update(s) when those blockers complete.
7349 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
7350 &channel_funding_outpoint.to_channel_id());
7354 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
7355 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7356 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
7357 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
7358 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
7359 channel_funding_outpoint.to_channel_id());
7360 handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
7361 peer_state_lck, peer_state, per_peer_state, chan);
7362 if further_update_exists {
7363 // If there are more `ChannelMonitorUpdate`s to process, restart at the
7368 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
7369 channel_funding_outpoint.to_channel_id());
7374 log_debug!(self.logger,
7375 "Got a release post-RAA monitor update for peer {} but the channel is gone",
7376 log_pubkey!(counterparty_node_id));
7382 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
7383 for action in actions {
7385 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
7386 channel_funding_outpoint, counterparty_node_id
7388 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
7394 /// Processes any events asynchronously in the order they were generated since the last call
7395 /// using the given event handler.
7397 /// See the trait-level documentation of [`EventsProvider`] for requirements.
7398 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
7402 process_events_body!(self, ev, { handler(ev).await });
7406 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>
7408 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7409 T::Target: BroadcasterInterface,
7410 ES::Target: EntropySource,
7411 NS::Target: NodeSigner,
7412 SP::Target: SignerProvider,
7413 F::Target: FeeEstimator,
7417 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
7418 /// The returned array will contain `MessageSendEvent`s for different peers if
7419 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
7420 /// is always placed next to each other.
7422 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
7423 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
7424 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
7425 /// will randomly be placed first or last in the returned array.
7427 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
7428 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
7429 /// the `MessageSendEvent`s to the specific peer they were generated under.
7430 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
7431 let events = RefCell::new(Vec::new());
7432 PersistenceNotifierGuard::optionally_notify(self, || {
7433 let mut result = NotifyOption::SkipPersistNoEvents;
7435 // TODO: This behavior should be documented. It's unintuitive that we query
7436 // ChannelMonitors when clearing other events.
7437 if self.process_pending_monitor_events() {
7438 result = NotifyOption::DoPersist;
7441 if self.check_free_holding_cells() {
7442 result = NotifyOption::DoPersist;
7444 if self.maybe_generate_initial_closing_signed() {
7445 result = NotifyOption::DoPersist;
7448 let mut pending_events = Vec::new();
7449 let per_peer_state = self.per_peer_state.read().unwrap();
7450 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7451 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7452 let peer_state = &mut *peer_state_lock;
7453 if peer_state.pending_msg_events.len() > 0 {
7454 pending_events.append(&mut peer_state.pending_msg_events);
7458 if !pending_events.is_empty() {
7459 events.replace(pending_events);
7468 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>
7470 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7471 T::Target: BroadcasterInterface,
7472 ES::Target: EntropySource,
7473 NS::Target: NodeSigner,
7474 SP::Target: SignerProvider,
7475 F::Target: FeeEstimator,
7479 /// Processes events that must be periodically handled.
7481 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
7482 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
7483 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
7485 process_events_body!(self, ev, handler.handle_event(ev));
7489 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>
7491 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7492 T::Target: BroadcasterInterface,
7493 ES::Target: EntropySource,
7494 NS::Target: NodeSigner,
7495 SP::Target: SignerProvider,
7496 F::Target: FeeEstimator,
7500 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7502 let best_block = self.best_block.read().unwrap();
7503 assert_eq!(best_block.block_hash(), header.prev_blockhash,
7504 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
7505 assert_eq!(best_block.height(), height - 1,
7506 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
7509 self.transactions_confirmed(header, txdata, height);
7510 self.best_block_updated(header, height);
7513 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
7514 let _persistence_guard =
7515 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7516 self, || -> NotifyOption { NotifyOption::DoPersist });
7517 let new_height = height - 1;
7519 let mut best_block = self.best_block.write().unwrap();
7520 assert_eq!(best_block.block_hash(), header.block_hash(),
7521 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
7522 assert_eq!(best_block.height(), height,
7523 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
7524 *best_block = BestBlock::new(header.prev_blockhash, new_height)
7527 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.chain_hash, &self.node_signer, &self.default_configuration, &self.logger));
7531 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>
7533 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7534 T::Target: BroadcasterInterface,
7535 ES::Target: EntropySource,
7536 NS::Target: NodeSigner,
7537 SP::Target: SignerProvider,
7538 F::Target: FeeEstimator,
7542 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7543 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7544 // during initialization prior to the chain_monitor being fully configured in some cases.
7545 // See the docs for `ChannelManagerReadArgs` for more.
7547 let block_hash = header.block_hash();
7548 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
7550 let _persistence_guard =
7551 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7552 self, || -> NotifyOption { NotifyOption::DoPersist });
7553 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.chain_hash, &self.node_signer, &self.default_configuration, &self.logger)
7554 .map(|(a, b)| (a, Vec::new(), b)));
7556 let last_best_block_height = self.best_block.read().unwrap().height();
7557 if height < last_best_block_height {
7558 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
7559 self.do_chain_event(Some(last_best_block_height), |channel| channel.best_block_updated(last_best_block_height, timestamp as u32, self.chain_hash, &self.node_signer, &self.default_configuration, &self.logger));
7563 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
7564 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7565 // during initialization prior to the chain_monitor being fully configured in some cases.
7566 // See the docs for `ChannelManagerReadArgs` for more.
7568 let block_hash = header.block_hash();
7569 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
7571 let _persistence_guard =
7572 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7573 self, || -> NotifyOption { NotifyOption::DoPersist });
7574 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
7576 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.chain_hash, &self.node_signer, &self.default_configuration, &self.logger));
7578 macro_rules! max_time {
7579 ($timestamp: expr) => {
7581 // Update $timestamp to be the max of its current value and the block
7582 // timestamp. This should keep us close to the current time without relying on
7583 // having an explicit local time source.
7584 // Just in case we end up in a race, we loop until we either successfully
7585 // update $timestamp or decide we don't need to.
7586 let old_serial = $timestamp.load(Ordering::Acquire);
7587 if old_serial >= header.time as usize { break; }
7588 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
7594 max_time!(self.highest_seen_timestamp);
7595 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
7596 payment_secrets.retain(|_, inbound_payment| {
7597 inbound_payment.expiry_time > header.time as u64
7601 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
7602 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
7603 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
7604 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7605 let peer_state = &mut *peer_state_lock;
7606 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
7607 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
7608 res.push((funding_txo.txid, Some(block_hash)));
7615 fn transaction_unconfirmed(&self, txid: &Txid) {
7616 let _persistence_guard =
7617 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7618 self, || -> NotifyOption { NotifyOption::DoPersist });
7619 self.do_chain_event(None, |channel| {
7620 if let Some(funding_txo) = channel.context.get_funding_txo() {
7621 if funding_txo.txid == *txid {
7622 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
7623 } else { Ok((None, Vec::new(), None)) }
7624 } else { Ok((None, Vec::new(), None)) }
7629 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>
7631 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7632 T::Target: BroadcasterInterface,
7633 ES::Target: EntropySource,
7634 NS::Target: NodeSigner,
7635 SP::Target: SignerProvider,
7636 F::Target: FeeEstimator,
7640 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
7641 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
7643 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
7644 (&self, height_opt: Option<u32>, f: FN) {
7645 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7646 // during initialization prior to the chain_monitor being fully configured in some cases.
7647 // See the docs for `ChannelManagerReadArgs` for more.
7649 let mut failed_channels = Vec::new();
7650 let mut timed_out_htlcs = Vec::new();
7652 let per_peer_state = self.per_peer_state.read().unwrap();
7653 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7654 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7655 let peer_state = &mut *peer_state_lock;
7656 let pending_msg_events = &mut peer_state.pending_msg_events;
7657 peer_state.channel_by_id.retain(|_, phase| {
7659 // Retain unfunded channels.
7660 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
7661 ChannelPhase::Funded(channel) => {
7662 let res = f(channel);
7663 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
7664 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
7665 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
7666 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
7667 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
7669 if let Some(channel_ready) = channel_ready_opt {
7670 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
7671 if channel.context.is_usable() {
7672 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
7673 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
7674 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
7675 node_id: channel.context.get_counterparty_node_id(),
7680 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
7685 let mut pending_events = self.pending_events.lock().unwrap();
7686 emit_channel_ready_event!(pending_events, channel);
7689 if let Some(announcement_sigs) = announcement_sigs {
7690 log_trace!(self.logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
7691 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
7692 node_id: channel.context.get_counterparty_node_id(),
7693 msg: announcement_sigs,
7695 if let Some(height) = height_opt {
7696 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.chain_hash, height, &self.default_configuration) {
7697 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7699 // Note that announcement_signatures fails if the channel cannot be announced,
7700 // so get_channel_update_for_broadcast will never fail by the time we get here.
7701 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
7706 if channel.is_our_channel_ready() {
7707 if let Some(real_scid) = channel.context.get_short_channel_id() {
7708 // If we sent a 0conf channel_ready, and now have an SCID, we add it
7709 // to the short_to_chan_info map here. Note that we check whether we
7710 // can relay using the real SCID at relay-time (i.e.
7711 // enforce option_scid_alias then), and if the funding tx is ever
7712 // un-confirmed we force-close the channel, ensuring short_to_chan_info
7713 // is always consistent.
7714 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
7715 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
7716 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
7717 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
7718 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
7721 } else if let Err(reason) = res {
7722 update_maps_on_chan_removal!(self, &channel.context);
7723 // It looks like our counterparty went on-chain or funding transaction was
7724 // reorged out of the main chain. Close the channel.
7725 failed_channels.push(channel.context.force_shutdown(true));
7726 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
7727 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7731 let reason_message = format!("{}", reason);
7732 self.issue_channel_close_events(&channel.context, reason);
7733 pending_msg_events.push(events::MessageSendEvent::HandleError {
7734 node_id: channel.context.get_counterparty_node_id(),
7735 action: msgs::ErrorAction::DisconnectPeer {
7736 msg: Some(msgs::ErrorMessage {
7737 channel_id: channel.context.channel_id(),
7738 data: reason_message,
7751 if let Some(height) = height_opt {
7752 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
7753 payment.htlcs.retain(|htlc| {
7754 // If height is approaching the number of blocks we think it takes us to get
7755 // our commitment transaction confirmed before the HTLC expires, plus the
7756 // number of blocks we generally consider it to take to do a commitment update,
7757 // just give up on it and fail the HTLC.
7758 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
7759 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
7760 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
7762 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
7763 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
7764 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
7768 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
7771 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
7772 intercepted_htlcs.retain(|_, htlc| {
7773 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
7774 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
7775 short_channel_id: htlc.prev_short_channel_id,
7776 user_channel_id: Some(htlc.prev_user_channel_id),
7777 htlc_id: htlc.prev_htlc_id,
7778 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
7779 phantom_shared_secret: None,
7780 outpoint: htlc.prev_funding_outpoint,
7783 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
7784 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
7785 _ => unreachable!(),
7787 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
7788 HTLCFailReason::from_failure_code(0x2000 | 2),
7789 HTLCDestination::InvalidForward { requested_forward_scid }));
7790 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
7796 self.handle_init_event_channel_failures(failed_channels);
7798 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
7799 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
7803 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
7804 /// may have events that need processing.
7806 /// In order to check if this [`ChannelManager`] needs persisting, call
7807 /// [`Self::get_and_clear_needs_persistence`].
7809 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
7810 /// [`ChannelManager`] and should instead register actions to be taken later.
7811 pub fn get_event_or_persistence_needed_future(&self) -> Future {
7812 self.event_persist_notifier.get_future()
7815 /// Returns true if this [`ChannelManager`] needs to be persisted.
7816 pub fn get_and_clear_needs_persistence(&self) -> bool {
7817 self.needs_persist_flag.swap(false, Ordering::AcqRel)
7820 #[cfg(any(test, feature = "_test_utils"))]
7821 pub fn get_event_or_persist_condvar_value(&self) -> bool {
7822 self.event_persist_notifier.notify_pending()
7825 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
7826 /// [`chain::Confirm`] interfaces.
7827 pub fn current_best_block(&self) -> BestBlock {
7828 self.best_block.read().unwrap().clone()
7831 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7832 /// [`ChannelManager`].
7833 pub fn node_features(&self) -> NodeFeatures {
7834 provided_node_features(&self.default_configuration)
7837 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7838 /// [`ChannelManager`].
7840 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7841 /// or not. Thus, this method is not public.
7842 #[cfg(any(feature = "_test_utils", test))]
7843 pub fn invoice_features(&self) -> Bolt11InvoiceFeatures {
7844 provided_invoice_features(&self.default_configuration)
7847 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7848 /// [`ChannelManager`].
7849 pub fn channel_features(&self) -> ChannelFeatures {
7850 provided_channel_features(&self.default_configuration)
7853 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7854 /// [`ChannelManager`].
7855 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
7856 provided_channel_type_features(&self.default_configuration)
7859 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7860 /// [`ChannelManager`].
7861 pub fn init_features(&self) -> InitFeatures {
7862 provided_init_features(&self.default_configuration)
7866 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7867 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
7869 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7870 T::Target: BroadcasterInterface,
7871 ES::Target: EntropySource,
7872 NS::Target: NodeSigner,
7873 SP::Target: SignerProvider,
7874 F::Target: FeeEstimator,
7878 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
7879 // Note that we never need to persist the updated ChannelManager for an inbound
7880 // open_channel message - pre-funded channels are never written so there should be no
7881 // change to the contents.
7882 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7883 let res = self.internal_open_channel(counterparty_node_id, msg);
7884 let persist = match &res {
7885 Err(e) if e.closes_channel() => {
7886 debug_assert!(false, "We shouldn't close a new channel");
7887 NotifyOption::DoPersist
7889 _ => NotifyOption::SkipPersistHandleEvents,
7891 let _ = handle_error!(self, res, *counterparty_node_id);
7896 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
7897 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7898 "Dual-funded channels not supported".to_owned(),
7899 msg.temporary_channel_id.clone())), *counterparty_node_id);
7902 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
7903 // Note that we never need to persist the updated ChannelManager for an inbound
7904 // accept_channel message - pre-funded channels are never written so there should be no
7905 // change to the contents.
7906 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7907 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
7908 NotifyOption::SkipPersistHandleEvents
7912 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
7913 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7914 "Dual-funded channels not supported".to_owned(),
7915 msg.temporary_channel_id.clone())), *counterparty_node_id);
7918 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
7919 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7920 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
7923 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
7924 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7925 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
7928 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
7929 // Note that we never need to persist the updated ChannelManager for an inbound
7930 // channel_ready message - while the channel's state will change, any channel_ready message
7931 // will ultimately be re-sent on startup and the `ChannelMonitor` won't be updated so we
7932 // will not force-close the channel on startup.
7933 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7934 let res = self.internal_channel_ready(counterparty_node_id, msg);
7935 let persist = match &res {
7936 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7937 _ => NotifyOption::SkipPersistHandleEvents,
7939 let _ = handle_error!(self, res, *counterparty_node_id);
7944 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
7945 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7946 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
7949 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
7950 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7951 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
7954 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
7955 // Note that we never need to persist the updated ChannelManager for an inbound
7956 // update_add_htlc message - the message itself doesn't change our channel state only the
7957 // `commitment_signed` message afterwards will.
7958 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7959 let res = self.internal_update_add_htlc(counterparty_node_id, msg);
7960 let persist = match &res {
7961 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7962 Err(_) => NotifyOption::SkipPersistHandleEvents,
7963 Ok(()) => NotifyOption::SkipPersistNoEvents,
7965 let _ = handle_error!(self, res, *counterparty_node_id);
7970 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
7971 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7972 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
7975 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
7976 // Note that we never need to persist the updated ChannelManager for an inbound
7977 // update_fail_htlc message - the message itself doesn't change our channel state only the
7978 // `commitment_signed` message afterwards will.
7979 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7980 let res = self.internal_update_fail_htlc(counterparty_node_id, msg);
7981 let persist = match &res {
7982 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7983 Err(_) => NotifyOption::SkipPersistHandleEvents,
7984 Ok(()) => NotifyOption::SkipPersistNoEvents,
7986 let _ = handle_error!(self, res, *counterparty_node_id);
7991 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
7992 // Note that we never need to persist the updated ChannelManager for an inbound
7993 // update_fail_malformed_htlc message - the message itself doesn't change our channel state
7994 // only the `commitment_signed` message afterwards will.
7995 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7996 let res = self.internal_update_fail_malformed_htlc(counterparty_node_id, msg);
7997 let persist = match &res {
7998 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7999 Err(_) => NotifyOption::SkipPersistHandleEvents,
8000 Ok(()) => NotifyOption::SkipPersistNoEvents,
8002 let _ = handle_error!(self, res, *counterparty_node_id);
8007 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
8008 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8009 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
8012 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
8013 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8014 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
8017 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
8018 // Note that we never need to persist the updated ChannelManager for an inbound
8019 // update_fee message - the message itself doesn't change our channel state only the
8020 // `commitment_signed` message afterwards will.
8021 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8022 let res = self.internal_update_fee(counterparty_node_id, msg);
8023 let persist = match &res {
8024 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8025 Err(_) => NotifyOption::SkipPersistHandleEvents,
8026 Ok(()) => NotifyOption::SkipPersistNoEvents,
8028 let _ = handle_error!(self, res, *counterparty_node_id);
8033 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
8034 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8035 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
8038 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
8039 PersistenceNotifierGuard::optionally_notify(self, || {
8040 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
8043 NotifyOption::DoPersist
8048 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
8049 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8050 let res = self.internal_channel_reestablish(counterparty_node_id, msg);
8051 let persist = match &res {
8052 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8053 Err(_) => NotifyOption::SkipPersistHandleEvents,
8054 Ok(persist) => *persist,
8056 let _ = handle_error!(self, res, *counterparty_node_id);
8061 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
8062 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(
8063 self, || NotifyOption::SkipPersistHandleEvents);
8064 let mut failed_channels = Vec::new();
8065 let mut per_peer_state = self.per_peer_state.write().unwrap();
8067 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
8068 log_pubkey!(counterparty_node_id));
8069 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8070 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8071 let peer_state = &mut *peer_state_lock;
8072 let pending_msg_events = &mut peer_state.pending_msg_events;
8073 peer_state.channel_by_id.retain(|_, phase| {
8074 let context = match phase {
8075 ChannelPhase::Funded(chan) => {
8076 if chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger).is_ok() {
8077 // We only retain funded channels that are not shutdown.
8082 // Unfunded channels will always be removed.
8083 ChannelPhase::UnfundedOutboundV1(chan) => {
8086 ChannelPhase::UnfundedInboundV1(chan) => {
8090 // Clean up for removal.
8091 update_maps_on_chan_removal!(self, &context);
8092 self.issue_channel_close_events(&context, ClosureReason::DisconnectedPeer);
8093 failed_channels.push(context.force_shutdown(false));
8096 // Note that we don't bother generating any events for pre-accept channels -
8097 // they're not considered "channels" yet from the PoV of our events interface.
8098 peer_state.inbound_channel_request_by_id.clear();
8099 pending_msg_events.retain(|msg| {
8101 // V1 Channel Establishment
8102 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
8103 &events::MessageSendEvent::SendOpenChannel { .. } => false,
8104 &events::MessageSendEvent::SendFundingCreated { .. } => false,
8105 &events::MessageSendEvent::SendFundingSigned { .. } => false,
8106 // V2 Channel Establishment
8107 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
8108 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
8109 // Common Channel Establishment
8110 &events::MessageSendEvent::SendChannelReady { .. } => false,
8111 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
8112 // Interactive Transaction Construction
8113 &events::MessageSendEvent::SendTxAddInput { .. } => false,
8114 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
8115 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
8116 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
8117 &events::MessageSendEvent::SendTxComplete { .. } => false,
8118 &events::MessageSendEvent::SendTxSignatures { .. } => false,
8119 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
8120 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
8121 &events::MessageSendEvent::SendTxAbort { .. } => false,
8122 // Channel Operations
8123 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
8124 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
8125 &events::MessageSendEvent::SendClosingSigned { .. } => false,
8126 &events::MessageSendEvent::SendShutdown { .. } => false,
8127 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
8128 &events::MessageSendEvent::HandleError { .. } => false,
8130 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
8131 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
8132 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
8133 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
8134 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
8135 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
8136 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
8137 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
8138 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
8141 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
8142 peer_state.is_connected = false;
8143 peer_state.ok_to_remove(true)
8144 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
8147 per_peer_state.remove(counterparty_node_id);
8149 mem::drop(per_peer_state);
8151 for failure in failed_channels.drain(..) {
8152 self.finish_close_channel(failure);
8156 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
8157 if !init_msg.features.supports_static_remote_key() {
8158 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
8162 let mut res = Ok(());
8164 PersistenceNotifierGuard::optionally_notify(self, || {
8165 // If we have too many peers connected which don't have funded channels, disconnect the
8166 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
8167 // unfunded channels taking up space in memory for disconnected peers, we still let new
8168 // peers connect, but we'll reject new channels from them.
8169 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
8170 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
8173 let mut peer_state_lock = self.per_peer_state.write().unwrap();
8174 match peer_state_lock.entry(counterparty_node_id.clone()) {
8175 hash_map::Entry::Vacant(e) => {
8176 if inbound_peer_limited {
8178 return NotifyOption::SkipPersistNoEvents;
8180 e.insert(Mutex::new(PeerState {
8181 channel_by_id: HashMap::new(),
8182 inbound_channel_request_by_id: HashMap::new(),
8183 latest_features: init_msg.features.clone(),
8184 pending_msg_events: Vec::new(),
8185 in_flight_monitor_updates: BTreeMap::new(),
8186 monitor_update_blocked_actions: BTreeMap::new(),
8187 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8191 hash_map::Entry::Occupied(e) => {
8192 let mut peer_state = e.get().lock().unwrap();
8193 peer_state.latest_features = init_msg.features.clone();
8195 let best_block_height = self.best_block.read().unwrap().height();
8196 if inbound_peer_limited &&
8197 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
8198 peer_state.channel_by_id.len()
8201 return NotifyOption::SkipPersistNoEvents;
8204 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
8205 peer_state.is_connected = true;
8210 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
8212 let per_peer_state = self.per_peer_state.read().unwrap();
8213 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8214 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8215 let peer_state = &mut *peer_state_lock;
8216 let pending_msg_events = &mut peer_state.pending_msg_events;
8218 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
8219 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else {
8220 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
8221 // (so won't be recovered after a crash), they shouldn't exist here and we would never need to
8222 // worry about closing and removing them.
8223 debug_assert!(false);
8227 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
8228 node_id: chan.context.get_counterparty_node_id(),
8229 msg: chan.get_channel_reestablish(&self.logger),
8234 return NotifyOption::SkipPersistHandleEvents;
8235 //TODO: Also re-broadcast announcement_signatures
8240 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
8241 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8243 match &msg.data as &str {
8244 "cannot co-op close channel w/ active htlcs"|
8245 "link failed to shutdown" =>
8247 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
8248 // send one while HTLCs are still present. The issue is tracked at
8249 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
8250 // to fix it but none so far have managed to land upstream. The issue appears to be
8251 // very low priority for the LND team despite being marked "P1".
8252 // We're not going to bother handling this in a sensible way, instead simply
8253 // repeating the Shutdown message on repeat until morale improves.
8254 if !msg.channel_id.is_zero() {
8255 let per_peer_state = self.per_peer_state.read().unwrap();
8256 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8257 if peer_state_mutex_opt.is_none() { return; }
8258 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
8259 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
8260 if let Some(msg) = chan.get_outbound_shutdown() {
8261 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
8262 node_id: *counterparty_node_id,
8266 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
8267 node_id: *counterparty_node_id,
8268 action: msgs::ErrorAction::SendWarningMessage {
8269 msg: msgs::WarningMessage {
8270 channel_id: msg.channel_id,
8271 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
8273 log_level: Level::Trace,
8283 if msg.channel_id.is_zero() {
8284 let channel_ids: Vec<ChannelId> = {
8285 let per_peer_state = self.per_peer_state.read().unwrap();
8286 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8287 if peer_state_mutex_opt.is_none() { return; }
8288 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
8289 let peer_state = &mut *peer_state_lock;
8290 // Note that we don't bother generating any events for pre-accept channels -
8291 // they're not considered "channels" yet from the PoV of our events interface.
8292 peer_state.inbound_channel_request_by_id.clear();
8293 peer_state.channel_by_id.keys().cloned().collect()
8295 for channel_id in channel_ids {
8296 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
8297 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
8301 // First check if we can advance the channel type and try again.
8302 let per_peer_state = self.per_peer_state.read().unwrap();
8303 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8304 if peer_state_mutex_opt.is_none() { return; }
8305 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
8306 let peer_state = &mut *peer_state_lock;
8307 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
8308 if let Ok(msg) = chan.maybe_handle_error_without_close(self.chain_hash, &self.fee_estimator) {
8309 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
8310 node_id: *counterparty_node_id,
8318 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
8319 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
8323 fn provided_node_features(&self) -> NodeFeatures {
8324 provided_node_features(&self.default_configuration)
8327 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
8328 provided_init_features(&self.default_configuration)
8331 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
8332 Some(vec![self.chain_hash])
8335 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
8336 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8337 "Dual-funded channels not supported".to_owned(),
8338 msg.channel_id.clone())), *counterparty_node_id);
8341 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
8342 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8343 "Dual-funded channels not supported".to_owned(),
8344 msg.channel_id.clone())), *counterparty_node_id);
8347 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
8348 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8349 "Dual-funded channels not supported".to_owned(),
8350 msg.channel_id.clone())), *counterparty_node_id);
8353 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
8354 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8355 "Dual-funded channels not supported".to_owned(),
8356 msg.channel_id.clone())), *counterparty_node_id);
8359 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
8360 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8361 "Dual-funded channels not supported".to_owned(),
8362 msg.channel_id.clone())), *counterparty_node_id);
8365 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
8366 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8367 "Dual-funded channels not supported".to_owned(),
8368 msg.channel_id.clone())), *counterparty_node_id);
8371 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
8372 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8373 "Dual-funded channels not supported".to_owned(),
8374 msg.channel_id.clone())), *counterparty_node_id);
8377 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
8378 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8379 "Dual-funded channels not supported".to_owned(),
8380 msg.channel_id.clone())), *counterparty_node_id);
8383 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
8384 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8385 "Dual-funded channels not supported".to_owned(),
8386 msg.channel_id.clone())), *counterparty_node_id);
8390 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
8391 /// [`ChannelManager`].
8392 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
8393 let mut node_features = provided_init_features(config).to_context();
8394 node_features.set_keysend_optional();
8398 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
8399 /// [`ChannelManager`].
8401 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8402 /// or not. Thus, this method is not public.
8403 #[cfg(any(feature = "_test_utils", test))]
8404 pub(crate) fn provided_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
8405 provided_init_features(config).to_context()
8408 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
8409 /// [`ChannelManager`].
8410 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
8411 provided_init_features(config).to_context()
8414 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
8415 /// [`ChannelManager`].
8416 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
8417 ChannelTypeFeatures::from_init(&provided_init_features(config))
8420 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
8421 /// [`ChannelManager`].
8422 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
8423 // Note that if new features are added here which other peers may (eventually) require, we
8424 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
8425 // [`ErroringMessageHandler`].
8426 let mut features = InitFeatures::empty();
8427 features.set_data_loss_protect_required();
8428 features.set_upfront_shutdown_script_optional();
8429 features.set_variable_length_onion_required();
8430 features.set_static_remote_key_required();
8431 features.set_payment_secret_required();
8432 features.set_basic_mpp_optional();
8433 features.set_wumbo_optional();
8434 features.set_shutdown_any_segwit_optional();
8435 features.set_channel_type_optional();
8436 features.set_scid_privacy_optional();
8437 features.set_zero_conf_optional();
8438 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
8439 features.set_anchors_zero_fee_htlc_tx_optional();
8444 const SERIALIZATION_VERSION: u8 = 1;
8445 const MIN_SERIALIZATION_VERSION: u8 = 1;
8447 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
8448 (2, fee_base_msat, required),
8449 (4, fee_proportional_millionths, required),
8450 (6, cltv_expiry_delta, required),
8453 impl_writeable_tlv_based!(ChannelCounterparty, {
8454 (2, node_id, required),
8455 (4, features, required),
8456 (6, unspendable_punishment_reserve, required),
8457 (8, forwarding_info, option),
8458 (9, outbound_htlc_minimum_msat, option),
8459 (11, outbound_htlc_maximum_msat, option),
8462 impl Writeable for ChannelDetails {
8463 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8464 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
8465 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
8466 let user_channel_id_low = self.user_channel_id as u64;
8467 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
8468 write_tlv_fields!(writer, {
8469 (1, self.inbound_scid_alias, option),
8470 (2, self.channel_id, required),
8471 (3, self.channel_type, option),
8472 (4, self.counterparty, required),
8473 (5, self.outbound_scid_alias, option),
8474 (6, self.funding_txo, option),
8475 (7, self.config, option),
8476 (8, self.short_channel_id, option),
8477 (9, self.confirmations, option),
8478 (10, self.channel_value_satoshis, required),
8479 (12, self.unspendable_punishment_reserve, option),
8480 (14, user_channel_id_low, required),
8481 (16, self.balance_msat, required),
8482 (18, self.outbound_capacity_msat, required),
8483 (19, self.next_outbound_htlc_limit_msat, required),
8484 (20, self.inbound_capacity_msat, required),
8485 (21, self.next_outbound_htlc_minimum_msat, required),
8486 (22, self.confirmations_required, option),
8487 (24, self.force_close_spend_delay, option),
8488 (26, self.is_outbound, required),
8489 (28, self.is_channel_ready, required),
8490 (30, self.is_usable, required),
8491 (32, self.is_public, required),
8492 (33, self.inbound_htlc_minimum_msat, option),
8493 (35, self.inbound_htlc_maximum_msat, option),
8494 (37, user_channel_id_high_opt, option),
8495 (39, self.feerate_sat_per_1000_weight, option),
8496 (41, self.channel_shutdown_state, option),
8502 impl Readable for ChannelDetails {
8503 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8504 _init_and_read_len_prefixed_tlv_fields!(reader, {
8505 (1, inbound_scid_alias, option),
8506 (2, channel_id, required),
8507 (3, channel_type, option),
8508 (4, counterparty, required),
8509 (5, outbound_scid_alias, option),
8510 (6, funding_txo, option),
8511 (7, config, option),
8512 (8, short_channel_id, option),
8513 (9, confirmations, option),
8514 (10, channel_value_satoshis, required),
8515 (12, unspendable_punishment_reserve, option),
8516 (14, user_channel_id_low, required),
8517 (16, balance_msat, required),
8518 (18, outbound_capacity_msat, required),
8519 // Note that by the time we get past the required read above, outbound_capacity_msat will be
8520 // filled in, so we can safely unwrap it here.
8521 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
8522 (20, inbound_capacity_msat, required),
8523 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
8524 (22, confirmations_required, option),
8525 (24, force_close_spend_delay, option),
8526 (26, is_outbound, required),
8527 (28, is_channel_ready, required),
8528 (30, is_usable, required),
8529 (32, is_public, required),
8530 (33, inbound_htlc_minimum_msat, option),
8531 (35, inbound_htlc_maximum_msat, option),
8532 (37, user_channel_id_high_opt, option),
8533 (39, feerate_sat_per_1000_weight, option),
8534 (41, channel_shutdown_state, option),
8537 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
8538 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
8539 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
8540 let user_channel_id = user_channel_id_low as u128 +
8541 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
8545 channel_id: channel_id.0.unwrap(),
8547 counterparty: counterparty.0.unwrap(),
8548 outbound_scid_alias,
8552 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
8553 unspendable_punishment_reserve,
8555 balance_msat: balance_msat.0.unwrap(),
8556 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
8557 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
8558 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
8559 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
8560 confirmations_required,
8562 force_close_spend_delay,
8563 is_outbound: is_outbound.0.unwrap(),
8564 is_channel_ready: is_channel_ready.0.unwrap(),
8565 is_usable: is_usable.0.unwrap(),
8566 is_public: is_public.0.unwrap(),
8567 inbound_htlc_minimum_msat,
8568 inbound_htlc_maximum_msat,
8569 feerate_sat_per_1000_weight,
8570 channel_shutdown_state,
8575 impl_writeable_tlv_based!(PhantomRouteHints, {
8576 (2, channels, required_vec),
8577 (4, phantom_scid, required),
8578 (6, real_node_pubkey, required),
8581 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
8583 (0, onion_packet, required),
8584 (2, short_channel_id, required),
8587 (0, payment_data, required),
8588 (1, phantom_shared_secret, option),
8589 (2, incoming_cltv_expiry, required),
8590 (3, payment_metadata, option),
8591 (5, custom_tlvs, optional_vec),
8593 (2, ReceiveKeysend) => {
8594 (0, payment_preimage, required),
8595 (2, incoming_cltv_expiry, required),
8596 (3, payment_metadata, option),
8597 (4, payment_data, option), // Added in 0.0.116
8598 (5, custom_tlvs, optional_vec),
8602 impl_writeable_tlv_based!(PendingHTLCInfo, {
8603 (0, routing, required),
8604 (2, incoming_shared_secret, required),
8605 (4, payment_hash, required),
8606 (6, outgoing_amt_msat, required),
8607 (8, outgoing_cltv_value, required),
8608 (9, incoming_amt_msat, option),
8609 (10, skimmed_fee_msat, option),
8613 impl Writeable for HTLCFailureMsg {
8614 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8616 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
8618 channel_id.write(writer)?;
8619 htlc_id.write(writer)?;
8620 reason.write(writer)?;
8622 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8623 channel_id, htlc_id, sha256_of_onion, failure_code
8626 channel_id.write(writer)?;
8627 htlc_id.write(writer)?;
8628 sha256_of_onion.write(writer)?;
8629 failure_code.write(writer)?;
8636 impl Readable for HTLCFailureMsg {
8637 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8638 let id: u8 = Readable::read(reader)?;
8641 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
8642 channel_id: Readable::read(reader)?,
8643 htlc_id: Readable::read(reader)?,
8644 reason: Readable::read(reader)?,
8648 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8649 channel_id: Readable::read(reader)?,
8650 htlc_id: Readable::read(reader)?,
8651 sha256_of_onion: Readable::read(reader)?,
8652 failure_code: Readable::read(reader)?,
8655 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
8656 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
8657 // messages contained in the variants.
8658 // In version 0.0.101, support for reading the variants with these types was added, and
8659 // we should migrate to writing these variants when UpdateFailHTLC or
8660 // UpdateFailMalformedHTLC get TLV fields.
8662 let length: BigSize = Readable::read(reader)?;
8663 let mut s = FixedLengthReader::new(reader, length.0);
8664 let res = Readable::read(&mut s)?;
8665 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8666 Ok(HTLCFailureMsg::Relay(res))
8669 let length: BigSize = Readable::read(reader)?;
8670 let mut s = FixedLengthReader::new(reader, length.0);
8671 let res = Readable::read(&mut s)?;
8672 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8673 Ok(HTLCFailureMsg::Malformed(res))
8675 _ => Err(DecodeError::UnknownRequiredFeature),
8680 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
8685 impl_writeable_tlv_based!(HTLCPreviousHopData, {
8686 (0, short_channel_id, required),
8687 (1, phantom_shared_secret, option),
8688 (2, outpoint, required),
8689 (4, htlc_id, required),
8690 (6, incoming_packet_shared_secret, required),
8691 (7, user_channel_id, option),
8694 impl Writeable for ClaimableHTLC {
8695 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8696 let (payment_data, keysend_preimage) = match &self.onion_payload {
8697 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
8698 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
8700 write_tlv_fields!(writer, {
8701 (0, self.prev_hop, required),
8702 (1, self.total_msat, required),
8703 (2, self.value, required),
8704 (3, self.sender_intended_value, required),
8705 (4, payment_data, option),
8706 (5, self.total_value_received, option),
8707 (6, self.cltv_expiry, required),
8708 (8, keysend_preimage, option),
8709 (10, self.counterparty_skimmed_fee_msat, option),
8715 impl Readable for ClaimableHTLC {
8716 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8717 _init_and_read_len_prefixed_tlv_fields!(reader, {
8718 (0, prev_hop, required),
8719 (1, total_msat, option),
8720 (2, value_ser, required),
8721 (3, sender_intended_value, option),
8722 (4, payment_data_opt, option),
8723 (5, total_value_received, option),
8724 (6, cltv_expiry, required),
8725 (8, keysend_preimage, option),
8726 (10, counterparty_skimmed_fee_msat, option),
8728 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
8729 let value = value_ser.0.unwrap();
8730 let onion_payload = match keysend_preimage {
8732 if payment_data.is_some() {
8733 return Err(DecodeError::InvalidValue)
8735 if total_msat.is_none() {
8736 total_msat = Some(value);
8738 OnionPayload::Spontaneous(p)
8741 if total_msat.is_none() {
8742 if payment_data.is_none() {
8743 return Err(DecodeError::InvalidValue)
8745 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
8747 OnionPayload::Invoice { _legacy_hop_data: payment_data }
8751 prev_hop: prev_hop.0.unwrap(),
8754 sender_intended_value: sender_intended_value.unwrap_or(value),
8755 total_value_received,
8756 total_msat: total_msat.unwrap(),
8758 cltv_expiry: cltv_expiry.0.unwrap(),
8759 counterparty_skimmed_fee_msat,
8764 impl Readable for HTLCSource {
8765 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8766 let id: u8 = Readable::read(reader)?;
8769 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
8770 let mut first_hop_htlc_msat: u64 = 0;
8771 let mut path_hops = Vec::new();
8772 let mut payment_id = None;
8773 let mut payment_params: Option<PaymentParameters> = None;
8774 let mut blinded_tail: Option<BlindedTail> = None;
8775 read_tlv_fields!(reader, {
8776 (0, session_priv, required),
8777 (1, payment_id, option),
8778 (2, first_hop_htlc_msat, required),
8779 (4, path_hops, required_vec),
8780 (5, payment_params, (option: ReadableArgs, 0)),
8781 (6, blinded_tail, option),
8783 if payment_id.is_none() {
8784 // For backwards compat, if there was no payment_id written, use the session_priv bytes
8786 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
8788 let path = Path { hops: path_hops, blinded_tail };
8789 if path.hops.len() == 0 {
8790 return Err(DecodeError::InvalidValue);
8792 if let Some(params) = payment_params.as_mut() {
8793 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
8794 if final_cltv_expiry_delta == &0 {
8795 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
8799 Ok(HTLCSource::OutboundRoute {
8800 session_priv: session_priv.0.unwrap(),
8801 first_hop_htlc_msat,
8803 payment_id: payment_id.unwrap(),
8806 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
8807 _ => Err(DecodeError::UnknownRequiredFeature),
8812 impl Writeable for HTLCSource {
8813 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
8815 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
8817 let payment_id_opt = Some(payment_id);
8818 write_tlv_fields!(writer, {
8819 (0, session_priv, required),
8820 (1, payment_id_opt, option),
8821 (2, first_hop_htlc_msat, required),
8822 // 3 was previously used to write a PaymentSecret for the payment.
8823 (4, path.hops, required_vec),
8824 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
8825 (6, path.blinded_tail, option),
8828 HTLCSource::PreviousHopData(ref field) => {
8830 field.write(writer)?;
8837 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
8838 (0, forward_info, required),
8839 (1, prev_user_channel_id, (default_value, 0)),
8840 (2, prev_short_channel_id, required),
8841 (4, prev_htlc_id, required),
8842 (6, prev_funding_outpoint, required),
8845 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
8847 (0, htlc_id, required),
8848 (2, err_packet, required),
8853 impl_writeable_tlv_based!(PendingInboundPayment, {
8854 (0, payment_secret, required),
8855 (2, expiry_time, required),
8856 (4, user_payment_id, required),
8857 (6, payment_preimage, required),
8858 (8, min_value_msat, required),
8861 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>
8863 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8864 T::Target: BroadcasterInterface,
8865 ES::Target: EntropySource,
8866 NS::Target: NodeSigner,
8867 SP::Target: SignerProvider,
8868 F::Target: FeeEstimator,
8872 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8873 let _consistency_lock = self.total_consistency_lock.write().unwrap();
8875 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
8877 self.chain_hash.write(writer)?;
8879 let best_block = self.best_block.read().unwrap();
8880 best_block.height().write(writer)?;
8881 best_block.block_hash().write(writer)?;
8884 let mut serializable_peer_count: u64 = 0;
8886 let per_peer_state = self.per_peer_state.read().unwrap();
8887 let mut number_of_funded_channels = 0;
8888 for (_, peer_state_mutex) in per_peer_state.iter() {
8889 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8890 let peer_state = &mut *peer_state_lock;
8891 if !peer_state.ok_to_remove(false) {
8892 serializable_peer_count += 1;
8895 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
8896 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_broadcast() } else { false }
8900 (number_of_funded_channels as u64).write(writer)?;
8902 for (_, peer_state_mutex) in per_peer_state.iter() {
8903 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8904 let peer_state = &mut *peer_state_lock;
8905 for channel in peer_state.channel_by_id.iter().filter_map(
8906 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
8907 if channel.context.is_funding_broadcast() { Some(channel) } else { None }
8910 channel.write(writer)?;
8916 let forward_htlcs = self.forward_htlcs.lock().unwrap();
8917 (forward_htlcs.len() as u64).write(writer)?;
8918 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
8919 short_channel_id.write(writer)?;
8920 (pending_forwards.len() as u64).write(writer)?;
8921 for forward in pending_forwards {
8922 forward.write(writer)?;
8927 let per_peer_state = self.per_peer_state.write().unwrap();
8929 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
8930 let claimable_payments = self.claimable_payments.lock().unwrap();
8931 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
8933 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
8934 let mut htlc_onion_fields: Vec<&_> = Vec::new();
8935 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
8936 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
8937 payment_hash.write(writer)?;
8938 (payment.htlcs.len() as u64).write(writer)?;
8939 for htlc in payment.htlcs.iter() {
8940 htlc.write(writer)?;
8942 htlc_purposes.push(&payment.purpose);
8943 htlc_onion_fields.push(&payment.onion_fields);
8946 let mut monitor_update_blocked_actions_per_peer = None;
8947 let mut peer_states = Vec::new();
8948 for (_, peer_state_mutex) in per_peer_state.iter() {
8949 // Because we're holding the owning `per_peer_state` write lock here there's no chance
8950 // of a lockorder violation deadlock - no other thread can be holding any
8951 // per_peer_state lock at all.
8952 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
8955 (serializable_peer_count).write(writer)?;
8956 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8957 // Peers which we have no channels to should be dropped once disconnected. As we
8958 // disconnect all peers when shutting down and serializing the ChannelManager, we
8959 // consider all peers as disconnected here. There's therefore no need write peers with
8961 if !peer_state.ok_to_remove(false) {
8962 peer_pubkey.write(writer)?;
8963 peer_state.latest_features.write(writer)?;
8964 if !peer_state.monitor_update_blocked_actions.is_empty() {
8965 monitor_update_blocked_actions_per_peer
8966 .get_or_insert_with(Vec::new)
8967 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
8972 let events = self.pending_events.lock().unwrap();
8973 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
8974 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
8975 // refuse to read the new ChannelManager.
8976 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
8977 if events_not_backwards_compatible {
8978 // If we're gonna write a even TLV that will overwrite our events anyway we might as
8979 // well save the space and not write any events here.
8980 0u64.write(writer)?;
8982 (events.len() as u64).write(writer)?;
8983 for (event, _) in events.iter() {
8984 event.write(writer)?;
8988 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
8989 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
8990 // the closing monitor updates were always effectively replayed on startup (either directly
8991 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
8992 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
8993 0u64.write(writer)?;
8995 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
8996 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
8997 // likely to be identical.
8998 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8999 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
9001 (pending_inbound_payments.len() as u64).write(writer)?;
9002 for (hash, pending_payment) in pending_inbound_payments.iter() {
9003 hash.write(writer)?;
9004 pending_payment.write(writer)?;
9007 // For backwards compat, write the session privs and their total length.
9008 let mut num_pending_outbounds_compat: u64 = 0;
9009 for (_, outbound) in pending_outbound_payments.iter() {
9010 if !outbound.is_fulfilled() && !outbound.abandoned() {
9011 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
9014 num_pending_outbounds_compat.write(writer)?;
9015 for (_, outbound) in pending_outbound_payments.iter() {
9017 PendingOutboundPayment::Legacy { session_privs } |
9018 PendingOutboundPayment::Retryable { session_privs, .. } => {
9019 for session_priv in session_privs.iter() {
9020 session_priv.write(writer)?;
9023 PendingOutboundPayment::AwaitingInvoice { .. } => {},
9024 PendingOutboundPayment::InvoiceReceived { .. } => {},
9025 PendingOutboundPayment::Fulfilled { .. } => {},
9026 PendingOutboundPayment::Abandoned { .. } => {},
9030 // Encode without retry info for 0.0.101 compatibility.
9031 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
9032 for (id, outbound) in pending_outbound_payments.iter() {
9034 PendingOutboundPayment::Legacy { session_privs } |
9035 PendingOutboundPayment::Retryable { session_privs, .. } => {
9036 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
9042 let mut pending_intercepted_htlcs = None;
9043 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
9044 if our_pending_intercepts.len() != 0 {
9045 pending_intercepted_htlcs = Some(our_pending_intercepts);
9048 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
9049 if pending_claiming_payments.as_ref().unwrap().is_empty() {
9050 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
9051 // map. Thus, if there are no entries we skip writing a TLV for it.
9052 pending_claiming_payments = None;
9055 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
9056 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9057 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
9058 if !updates.is_empty() {
9059 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
9060 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
9065 write_tlv_fields!(writer, {
9066 (1, pending_outbound_payments_no_retry, required),
9067 (2, pending_intercepted_htlcs, option),
9068 (3, pending_outbound_payments, required),
9069 (4, pending_claiming_payments, option),
9070 (5, self.our_network_pubkey, required),
9071 (6, monitor_update_blocked_actions_per_peer, option),
9072 (7, self.fake_scid_rand_bytes, required),
9073 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
9074 (9, htlc_purposes, required_vec),
9075 (10, in_flight_monitor_updates, option),
9076 (11, self.probing_cookie_secret, required),
9077 (13, htlc_onion_fields, optional_vec),
9084 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
9085 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9086 (self.len() as u64).write(w)?;
9087 for (event, action) in self.iter() {
9090 #[cfg(debug_assertions)] {
9091 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
9092 // be persisted and are regenerated on restart. However, if such an event has a
9093 // post-event-handling action we'll write nothing for the event and would have to
9094 // either forget the action or fail on deserialization (which we do below). Thus,
9095 // check that the event is sane here.
9096 let event_encoded = event.encode();
9097 let event_read: Option<Event> =
9098 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
9099 if action.is_some() { assert!(event_read.is_some()); }
9105 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
9106 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9107 let len: u64 = Readable::read(reader)?;
9108 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
9109 let mut events: Self = VecDeque::with_capacity(cmp::min(
9110 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
9113 let ev_opt = MaybeReadable::read(reader)?;
9114 let action = Readable::read(reader)?;
9115 if let Some(ev) = ev_opt {
9116 events.push_back((ev, action));
9117 } else if action.is_some() {
9118 return Err(DecodeError::InvalidValue);
9125 impl_writeable_tlv_based_enum!(ChannelShutdownState,
9126 (0, NotShuttingDown) => {},
9127 (2, ShutdownInitiated) => {},
9128 (4, ResolvingHTLCs) => {},
9129 (6, NegotiatingClosingFee) => {},
9130 (8, ShutdownComplete) => {}, ;
9133 /// Arguments for the creation of a ChannelManager that are not deserialized.
9135 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
9137 /// 1) Deserialize all stored [`ChannelMonitor`]s.
9138 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
9139 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
9140 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
9141 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
9142 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
9143 /// same way you would handle a [`chain::Filter`] call using
9144 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
9145 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
9146 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
9147 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
9148 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
9149 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
9151 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
9152 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
9154 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
9155 /// call any other methods on the newly-deserialized [`ChannelManager`].
9157 /// Note that because some channels may be closed during deserialization, it is critical that you
9158 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
9159 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
9160 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
9161 /// not force-close the same channels but consider them live), you may end up revoking a state for
9162 /// which you've already broadcasted the transaction.
9164 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
9165 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9167 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9168 T::Target: BroadcasterInterface,
9169 ES::Target: EntropySource,
9170 NS::Target: NodeSigner,
9171 SP::Target: SignerProvider,
9172 F::Target: FeeEstimator,
9176 /// A cryptographically secure source of entropy.
9177 pub entropy_source: ES,
9179 /// A signer that is able to perform node-scoped cryptographic operations.
9180 pub node_signer: NS,
9182 /// The keys provider which will give us relevant keys. Some keys will be loaded during
9183 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
9185 pub signer_provider: SP,
9187 /// The fee_estimator for use in the ChannelManager in the future.
9189 /// No calls to the FeeEstimator will be made during deserialization.
9190 pub fee_estimator: F,
9191 /// The chain::Watch for use in the ChannelManager in the future.
9193 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
9194 /// you have deserialized ChannelMonitors separately and will add them to your
9195 /// chain::Watch after deserializing this ChannelManager.
9196 pub chain_monitor: M,
9198 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
9199 /// used to broadcast the latest local commitment transactions of channels which must be
9200 /// force-closed during deserialization.
9201 pub tx_broadcaster: T,
9202 /// The router which will be used in the ChannelManager in the future for finding routes
9203 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
9205 /// No calls to the router will be made during deserialization.
9207 /// The Logger for use in the ChannelManager and which may be used to log information during
9208 /// deserialization.
9210 /// Default settings used for new channels. Any existing channels will continue to use the
9211 /// runtime settings which were stored when the ChannelManager was serialized.
9212 pub default_config: UserConfig,
9214 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
9215 /// value.context.get_funding_txo() should be the key).
9217 /// If a monitor is inconsistent with the channel state during deserialization the channel will
9218 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
9219 /// is true for missing channels as well. If there is a monitor missing for which we find
9220 /// channel data Err(DecodeError::InvalidValue) will be returned.
9222 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
9225 /// This is not exported to bindings users because we have no HashMap bindings
9226 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
9229 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9230 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
9232 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9233 T::Target: BroadcasterInterface,
9234 ES::Target: EntropySource,
9235 NS::Target: NodeSigner,
9236 SP::Target: SignerProvider,
9237 F::Target: FeeEstimator,
9241 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
9242 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
9243 /// populate a HashMap directly from C.
9244 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,
9245 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
9247 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
9248 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
9253 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
9254 // SipmleArcChannelManager type:
9255 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9256 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
9258 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9259 T::Target: BroadcasterInterface,
9260 ES::Target: EntropySource,
9261 NS::Target: NodeSigner,
9262 SP::Target: SignerProvider,
9263 F::Target: FeeEstimator,
9267 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
9268 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
9269 Ok((blockhash, Arc::new(chan_manager)))
9273 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9274 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
9276 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9277 T::Target: BroadcasterInterface,
9278 ES::Target: EntropySource,
9279 NS::Target: NodeSigner,
9280 SP::Target: SignerProvider,
9281 F::Target: FeeEstimator,
9285 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
9286 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
9288 let chain_hash: ChainHash = Readable::read(reader)?;
9289 let best_block_height: u32 = Readable::read(reader)?;
9290 let best_block_hash: BlockHash = Readable::read(reader)?;
9292 let mut failed_htlcs = Vec::new();
9294 let channel_count: u64 = Readable::read(reader)?;
9295 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
9296 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
9297 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
9298 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
9299 let mut channel_closures = VecDeque::new();
9300 let mut close_background_events = Vec::new();
9301 for _ in 0..channel_count {
9302 let mut channel: Channel<SP> = Channel::read(reader, (
9303 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
9305 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
9306 funding_txo_set.insert(funding_txo.clone());
9307 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
9308 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
9309 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
9310 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
9311 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
9312 // But if the channel is behind of the monitor, close the channel:
9313 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
9314 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
9315 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
9316 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
9317 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
9319 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
9320 log_error!(args.logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
9321 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
9323 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
9324 log_error!(args.logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
9325 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
9327 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
9328 log_error!(args.logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
9329 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
9331 let (monitor_update, mut new_failed_htlcs, batch_funding_txid) = channel.context.force_shutdown(true);
9332 if batch_funding_txid.is_some() {
9333 return Err(DecodeError::InvalidValue);
9335 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
9336 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
9337 counterparty_node_id, funding_txo, update
9340 failed_htlcs.append(&mut new_failed_htlcs);
9341 channel_closures.push_back((events::Event::ChannelClosed {
9342 channel_id: channel.context.channel_id(),
9343 user_channel_id: channel.context.get_user_id(),
9344 reason: ClosureReason::OutdatedChannelManager,
9345 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
9346 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
9348 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
9349 let mut found_htlc = false;
9350 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
9351 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
9354 // If we have some HTLCs in the channel which are not present in the newer
9355 // ChannelMonitor, they have been removed and should be failed back to
9356 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
9357 // were actually claimed we'd have generated and ensured the previous-hop
9358 // claim update ChannelMonitor updates were persisted prior to persising
9359 // the ChannelMonitor update for the forward leg, so attempting to fail the
9360 // backwards leg of the HTLC will simply be rejected.
9361 log_info!(args.logger,
9362 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
9363 &channel.context.channel_id(), &payment_hash);
9364 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
9368 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
9369 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
9370 monitor.get_latest_update_id());
9371 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
9372 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
9374 if channel.context.is_funding_broadcast() {
9375 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
9377 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
9378 hash_map::Entry::Occupied(mut entry) => {
9379 let by_id_map = entry.get_mut();
9380 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
9382 hash_map::Entry::Vacant(entry) => {
9383 let mut by_id_map = HashMap::new();
9384 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
9385 entry.insert(by_id_map);
9389 } else if channel.is_awaiting_initial_mon_persist() {
9390 // If we were persisted and shut down while the initial ChannelMonitor persistence
9391 // was in-progress, we never broadcasted the funding transaction and can still
9392 // safely discard the channel.
9393 let _ = channel.context.force_shutdown(false);
9394 channel_closures.push_back((events::Event::ChannelClosed {
9395 channel_id: channel.context.channel_id(),
9396 user_channel_id: channel.context.get_user_id(),
9397 reason: ClosureReason::DisconnectedPeer,
9398 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
9399 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
9402 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
9403 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9404 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9405 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
9406 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");
9407 return Err(DecodeError::InvalidValue);
9411 for (funding_txo, _) in args.channel_monitors.iter() {
9412 if !funding_txo_set.contains(funding_txo) {
9413 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
9414 &funding_txo.to_channel_id());
9415 let monitor_update = ChannelMonitorUpdate {
9416 update_id: CLOSED_CHANNEL_UPDATE_ID,
9417 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
9419 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
9423 const MAX_ALLOC_SIZE: usize = 1024 * 64;
9424 let forward_htlcs_count: u64 = Readable::read(reader)?;
9425 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
9426 for _ in 0..forward_htlcs_count {
9427 let short_channel_id = Readable::read(reader)?;
9428 let pending_forwards_count: u64 = Readable::read(reader)?;
9429 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
9430 for _ in 0..pending_forwards_count {
9431 pending_forwards.push(Readable::read(reader)?);
9433 forward_htlcs.insert(short_channel_id, pending_forwards);
9436 let claimable_htlcs_count: u64 = Readable::read(reader)?;
9437 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
9438 for _ in 0..claimable_htlcs_count {
9439 let payment_hash = Readable::read(reader)?;
9440 let previous_hops_len: u64 = Readable::read(reader)?;
9441 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
9442 for _ in 0..previous_hops_len {
9443 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
9445 claimable_htlcs_list.push((payment_hash, previous_hops));
9448 let peer_state_from_chans = |channel_by_id| {
9451 inbound_channel_request_by_id: HashMap::new(),
9452 latest_features: InitFeatures::empty(),
9453 pending_msg_events: Vec::new(),
9454 in_flight_monitor_updates: BTreeMap::new(),
9455 monitor_update_blocked_actions: BTreeMap::new(),
9456 actions_blocking_raa_monitor_updates: BTreeMap::new(),
9457 is_connected: false,
9461 let peer_count: u64 = Readable::read(reader)?;
9462 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
9463 for _ in 0..peer_count {
9464 let peer_pubkey = Readable::read(reader)?;
9465 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
9466 let mut peer_state = peer_state_from_chans(peer_chans);
9467 peer_state.latest_features = Readable::read(reader)?;
9468 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
9471 let event_count: u64 = Readable::read(reader)?;
9472 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
9473 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
9474 for _ in 0..event_count {
9475 match MaybeReadable::read(reader)? {
9476 Some(event) => pending_events_read.push_back((event, None)),
9481 let background_event_count: u64 = Readable::read(reader)?;
9482 for _ in 0..background_event_count {
9483 match <u8 as Readable>::read(reader)? {
9485 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
9486 // however we really don't (and never did) need them - we regenerate all
9487 // on-startup monitor updates.
9488 let _: OutPoint = Readable::read(reader)?;
9489 let _: ChannelMonitorUpdate = Readable::read(reader)?;
9491 _ => return Err(DecodeError::InvalidValue),
9495 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
9496 let highest_seen_timestamp: u32 = Readable::read(reader)?;
9498 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
9499 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
9500 for _ in 0..pending_inbound_payment_count {
9501 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
9502 return Err(DecodeError::InvalidValue);
9506 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
9507 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
9508 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
9509 for _ in 0..pending_outbound_payments_count_compat {
9510 let session_priv = Readable::read(reader)?;
9511 let payment = PendingOutboundPayment::Legacy {
9512 session_privs: [session_priv].iter().cloned().collect()
9514 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
9515 return Err(DecodeError::InvalidValue)
9519 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
9520 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
9521 let mut pending_outbound_payments = None;
9522 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
9523 let mut received_network_pubkey: Option<PublicKey> = None;
9524 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
9525 let mut probing_cookie_secret: Option<[u8; 32]> = None;
9526 let mut claimable_htlc_purposes = None;
9527 let mut claimable_htlc_onion_fields = None;
9528 let mut pending_claiming_payments = Some(HashMap::new());
9529 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
9530 let mut events_override = None;
9531 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
9532 read_tlv_fields!(reader, {
9533 (1, pending_outbound_payments_no_retry, option),
9534 (2, pending_intercepted_htlcs, option),
9535 (3, pending_outbound_payments, option),
9536 (4, pending_claiming_payments, option),
9537 (5, received_network_pubkey, option),
9538 (6, monitor_update_blocked_actions_per_peer, option),
9539 (7, fake_scid_rand_bytes, option),
9540 (8, events_override, option),
9541 (9, claimable_htlc_purposes, optional_vec),
9542 (10, in_flight_monitor_updates, option),
9543 (11, probing_cookie_secret, option),
9544 (13, claimable_htlc_onion_fields, optional_vec),
9546 if fake_scid_rand_bytes.is_none() {
9547 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
9550 if probing_cookie_secret.is_none() {
9551 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
9554 if let Some(events) = events_override {
9555 pending_events_read = events;
9558 if !channel_closures.is_empty() {
9559 pending_events_read.append(&mut channel_closures);
9562 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
9563 pending_outbound_payments = Some(pending_outbound_payments_compat);
9564 } else if pending_outbound_payments.is_none() {
9565 let mut outbounds = HashMap::new();
9566 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
9567 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
9569 pending_outbound_payments = Some(outbounds);
9571 let pending_outbounds = OutboundPayments {
9572 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
9573 retry_lock: Mutex::new(())
9576 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
9577 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
9578 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
9579 // replayed, and for each monitor update we have to replay we have to ensure there's a
9580 // `ChannelMonitor` for it.
9582 // In order to do so we first walk all of our live channels (so that we can check their
9583 // state immediately after doing the update replays, when we have the `update_id`s
9584 // available) and then walk any remaining in-flight updates.
9586 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
9587 let mut pending_background_events = Vec::new();
9588 macro_rules! handle_in_flight_updates {
9589 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
9590 $monitor: expr, $peer_state: expr, $channel_info_log: expr
9592 let mut max_in_flight_update_id = 0;
9593 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
9594 for update in $chan_in_flight_upds.iter() {
9595 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
9596 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
9597 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
9598 pending_background_events.push(
9599 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
9600 counterparty_node_id: $counterparty_node_id,
9601 funding_txo: $funding_txo,
9602 update: update.clone(),
9605 if $chan_in_flight_upds.is_empty() {
9606 // We had some updates to apply, but it turns out they had completed before we
9607 // were serialized, we just weren't notified of that. Thus, we may have to run
9608 // the completion actions for any monitor updates, but otherwise are done.
9609 pending_background_events.push(
9610 BackgroundEvent::MonitorUpdatesComplete {
9611 counterparty_node_id: $counterparty_node_id,
9612 channel_id: $funding_txo.to_channel_id(),
9615 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
9616 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
9617 return Err(DecodeError::InvalidValue);
9619 max_in_flight_update_id
9623 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
9624 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
9625 let peer_state = &mut *peer_state_lock;
9626 for phase in peer_state.channel_by_id.values() {
9627 if let ChannelPhase::Funded(chan) = phase {
9628 // Channels that were persisted have to be funded, otherwise they should have been
9630 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
9631 let monitor = args.channel_monitors.get(&funding_txo)
9632 .expect("We already checked for monitor presence when loading channels");
9633 let mut max_in_flight_update_id = monitor.get_latest_update_id();
9634 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
9635 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
9636 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
9637 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
9638 funding_txo, monitor, peer_state, ""));
9641 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
9642 // If the channel is ahead of the monitor, return InvalidValue:
9643 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
9644 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
9645 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
9646 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
9647 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9648 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9649 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9650 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");
9651 return Err(DecodeError::InvalidValue);
9654 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
9655 // created in this `channel_by_id` map.
9656 debug_assert!(false);
9657 return Err(DecodeError::InvalidValue);
9662 if let Some(in_flight_upds) = in_flight_monitor_updates {
9663 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
9664 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
9665 // Now that we've removed all the in-flight monitor updates for channels that are
9666 // still open, we need to replay any monitor updates that are for closed channels,
9667 // creating the neccessary peer_state entries as we go.
9668 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
9669 Mutex::new(peer_state_from_chans(HashMap::new()))
9671 let mut peer_state = peer_state_mutex.lock().unwrap();
9672 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
9673 funding_txo, monitor, peer_state, "closed ");
9675 log_error!(args.logger, "A ChannelMonitor is missing even though we have in-flight updates for it! This indicates a potentially-critical violation of the chain::Watch API!");
9676 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
9677 &funding_txo.to_channel_id());
9678 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9679 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9680 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9681 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");
9682 return Err(DecodeError::InvalidValue);
9687 // Note that we have to do the above replays before we push new monitor updates.
9688 pending_background_events.append(&mut close_background_events);
9690 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
9691 // should ensure we try them again on the inbound edge. We put them here and do so after we
9692 // have a fully-constructed `ChannelManager` at the end.
9693 let mut pending_claims_to_replay = Vec::new();
9696 // If we're tracking pending payments, ensure we haven't lost any by looking at the
9697 // ChannelMonitor data for any channels for which we do not have authorative state
9698 // (i.e. those for which we just force-closed above or we otherwise don't have a
9699 // corresponding `Channel` at all).
9700 // This avoids several edge-cases where we would otherwise "forget" about pending
9701 // payments which are still in-flight via their on-chain state.
9702 // We only rebuild the pending payments map if we were most recently serialized by
9704 for (_, monitor) in args.channel_monitors.iter() {
9705 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
9706 if counterparty_opt.is_none() {
9707 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
9708 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
9709 if path.hops.is_empty() {
9710 log_error!(args.logger, "Got an empty path for a pending payment");
9711 return Err(DecodeError::InvalidValue);
9714 let path_amt = path.final_value_msat();
9715 let mut session_priv_bytes = [0; 32];
9716 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
9717 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
9718 hash_map::Entry::Occupied(mut entry) => {
9719 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
9720 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
9721 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), &htlc.payment_hash);
9723 hash_map::Entry::Vacant(entry) => {
9724 let path_fee = path.fee_msat();
9725 entry.insert(PendingOutboundPayment::Retryable {
9726 retry_strategy: None,
9727 attempts: PaymentAttempts::new(),
9728 payment_params: None,
9729 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
9730 payment_hash: htlc.payment_hash,
9731 payment_secret: None, // only used for retries, and we'll never retry on startup
9732 payment_metadata: None, // only used for retries, and we'll never retry on startup
9733 keysend_preimage: None, // only used for retries, and we'll never retry on startup
9734 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
9735 pending_amt_msat: path_amt,
9736 pending_fee_msat: Some(path_fee),
9737 total_msat: path_amt,
9738 starting_block_height: best_block_height,
9739 remaining_max_total_routing_fee_msat: None, // only used for retries, and we'll never retry on startup
9741 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
9742 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
9747 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
9749 HTLCSource::PreviousHopData(prev_hop_data) => {
9750 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
9751 info.prev_funding_outpoint == prev_hop_data.outpoint &&
9752 info.prev_htlc_id == prev_hop_data.htlc_id
9754 // The ChannelMonitor is now responsible for this HTLC's
9755 // failure/success and will let us know what its outcome is. If we
9756 // still have an entry for this HTLC in `forward_htlcs` or
9757 // `pending_intercepted_htlcs`, we were apparently not persisted after
9758 // the monitor was when forwarding the payment.
9759 forward_htlcs.retain(|_, forwards| {
9760 forwards.retain(|forward| {
9761 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
9762 if pending_forward_matches_htlc(&htlc_info) {
9763 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
9764 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9769 !forwards.is_empty()
9771 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
9772 if pending_forward_matches_htlc(&htlc_info) {
9773 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
9774 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9775 pending_events_read.retain(|(event, _)| {
9776 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
9777 intercepted_id != ev_id
9784 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
9785 if let Some(preimage) = preimage_opt {
9786 let pending_events = Mutex::new(pending_events_read);
9787 // Note that we set `from_onchain` to "false" here,
9788 // deliberately keeping the pending payment around forever.
9789 // Given it should only occur when we have a channel we're
9790 // force-closing for being stale that's okay.
9791 // The alternative would be to wipe the state when claiming,
9792 // generating a `PaymentPathSuccessful` event but regenerating
9793 // it and the `PaymentSent` on every restart until the
9794 // `ChannelMonitor` is removed.
9796 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
9797 channel_funding_outpoint: monitor.get_funding_txo().0,
9798 counterparty_node_id: path.hops[0].pubkey,
9800 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
9801 path, false, compl_action, &pending_events, &args.logger);
9802 pending_events_read = pending_events.into_inner().unwrap();
9809 // Whether the downstream channel was closed or not, try to re-apply any payment
9810 // preimages from it which may be needed in upstream channels for forwarded
9812 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
9814 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
9815 if let HTLCSource::PreviousHopData(_) = htlc_source {
9816 if let Some(payment_preimage) = preimage_opt {
9817 Some((htlc_source, payment_preimage, htlc.amount_msat,
9818 // Check if `counterparty_opt.is_none()` to see if the
9819 // downstream chan is closed (because we don't have a
9820 // channel_id -> peer map entry).
9821 counterparty_opt.is_none(),
9822 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
9823 monitor.get_funding_txo().0))
9826 // If it was an outbound payment, we've handled it above - if a preimage
9827 // came in and we persisted the `ChannelManager` we either handled it and
9828 // are good to go or the channel force-closed - we don't have to handle the
9829 // channel still live case here.
9833 for tuple in outbound_claimed_htlcs_iter {
9834 pending_claims_to_replay.push(tuple);
9839 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
9840 // If we have pending HTLCs to forward, assume we either dropped a
9841 // `PendingHTLCsForwardable` or the user received it but never processed it as they
9842 // shut down before the timer hit. Either way, set the time_forwardable to a small
9843 // constant as enough time has likely passed that we should simply handle the forwards
9844 // now, or at least after the user gets a chance to reconnect to our peers.
9845 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
9846 time_forwardable: Duration::from_secs(2),
9850 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
9851 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
9853 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
9854 if let Some(purposes) = claimable_htlc_purposes {
9855 if purposes.len() != claimable_htlcs_list.len() {
9856 return Err(DecodeError::InvalidValue);
9858 if let Some(onion_fields) = claimable_htlc_onion_fields {
9859 if onion_fields.len() != claimable_htlcs_list.len() {
9860 return Err(DecodeError::InvalidValue);
9862 for (purpose, (onion, (payment_hash, htlcs))) in
9863 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
9865 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9866 purpose, htlcs, onion_fields: onion,
9868 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9871 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
9872 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9873 purpose, htlcs, onion_fields: None,
9875 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9879 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
9880 // include a `_legacy_hop_data` in the `OnionPayload`.
9881 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
9882 if htlcs.is_empty() {
9883 return Err(DecodeError::InvalidValue);
9885 let purpose = match &htlcs[0].onion_payload {
9886 OnionPayload::Invoice { _legacy_hop_data } => {
9887 if let Some(hop_data) = _legacy_hop_data {
9888 events::PaymentPurpose::InvoicePayment {
9889 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
9890 Some(inbound_payment) => inbound_payment.payment_preimage,
9891 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
9892 Ok((payment_preimage, _)) => payment_preimage,
9894 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", &payment_hash);
9895 return Err(DecodeError::InvalidValue);
9899 payment_secret: hop_data.payment_secret,
9901 } else { return Err(DecodeError::InvalidValue); }
9903 OnionPayload::Spontaneous(payment_preimage) =>
9904 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
9906 claimable_payments.insert(payment_hash, ClaimablePayment {
9907 purpose, htlcs, onion_fields: None,
9912 let mut secp_ctx = Secp256k1::new();
9913 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
9915 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
9917 Err(()) => return Err(DecodeError::InvalidValue)
9919 if let Some(network_pubkey) = received_network_pubkey {
9920 if network_pubkey != our_network_pubkey {
9921 log_error!(args.logger, "Key that was generated does not match the existing key.");
9922 return Err(DecodeError::InvalidValue);
9926 let mut outbound_scid_aliases = HashSet::new();
9927 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
9928 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9929 let peer_state = &mut *peer_state_lock;
9930 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
9931 if let ChannelPhase::Funded(chan) = phase {
9932 if chan.context.outbound_scid_alias() == 0 {
9933 let mut outbound_scid_alias;
9935 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
9936 .get_fake_scid(best_block_height, &chain_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
9937 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
9939 chan.context.set_outbound_scid_alias(outbound_scid_alias);
9940 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
9941 // Note that in rare cases its possible to hit this while reading an older
9942 // channel if we just happened to pick a colliding outbound alias above.
9943 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9944 return Err(DecodeError::InvalidValue);
9946 if chan.context.is_usable() {
9947 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
9948 // Note that in rare cases its possible to hit this while reading an older
9949 // channel if we just happened to pick a colliding outbound alias above.
9950 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9951 return Err(DecodeError::InvalidValue);
9955 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
9956 // created in this `channel_by_id` map.
9957 debug_assert!(false);
9958 return Err(DecodeError::InvalidValue);
9963 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
9965 for (_, monitor) in args.channel_monitors.iter() {
9966 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
9967 if let Some(payment) = claimable_payments.remove(&payment_hash) {
9968 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
9969 let mut claimable_amt_msat = 0;
9970 let mut receiver_node_id = Some(our_network_pubkey);
9971 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
9972 if phantom_shared_secret.is_some() {
9973 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
9974 .expect("Failed to get node_id for phantom node recipient");
9975 receiver_node_id = Some(phantom_pubkey)
9977 for claimable_htlc in &payment.htlcs {
9978 claimable_amt_msat += claimable_htlc.value;
9980 // Add a holding-cell claim of the payment to the Channel, which should be
9981 // applied ~immediately on peer reconnection. Because it won't generate a
9982 // new commitment transaction we can just provide the payment preimage to
9983 // the corresponding ChannelMonitor and nothing else.
9985 // We do so directly instead of via the normal ChannelMonitor update
9986 // procedure as the ChainMonitor hasn't yet been initialized, implying
9987 // we're not allowed to call it directly yet. Further, we do the update
9988 // without incrementing the ChannelMonitor update ID as there isn't any
9990 // If we were to generate a new ChannelMonitor update ID here and then
9991 // crash before the user finishes block connect we'd end up force-closing
9992 // this channel as well. On the flip side, there's no harm in restarting
9993 // without the new monitor persisted - we'll end up right back here on
9995 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
9996 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
9997 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
9998 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9999 let peer_state = &mut *peer_state_lock;
10000 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
10001 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
10004 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
10005 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
10008 pending_events_read.push_back((events::Event::PaymentClaimed {
10011 purpose: payment.purpose,
10012 amount_msat: claimable_amt_msat,
10013 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
10014 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
10020 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
10021 if let Some(peer_state) = per_peer_state.get(&node_id) {
10022 for (_, actions) in monitor_update_blocked_actions.iter() {
10023 for action in actions.iter() {
10024 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
10025 downstream_counterparty_and_funding_outpoint:
10026 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
10028 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
10029 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
10030 .entry(blocked_channel_outpoint.to_channel_id())
10031 .or_insert_with(Vec::new).push(blocking_action.clone());
10033 // If the channel we were blocking has closed, we don't need to
10034 // worry about it - the blocked monitor update should never have
10035 // been released from the `Channel` object so it can't have
10036 // completed, and if the channel closed there's no reason to bother
10042 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
10044 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
10045 return Err(DecodeError::InvalidValue);
10049 let channel_manager = ChannelManager {
10051 fee_estimator: bounded_fee_estimator,
10052 chain_monitor: args.chain_monitor,
10053 tx_broadcaster: args.tx_broadcaster,
10054 router: args.router,
10056 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
10058 inbound_payment_key: expanded_inbound_key,
10059 pending_inbound_payments: Mutex::new(pending_inbound_payments),
10060 pending_outbound_payments: pending_outbounds,
10061 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
10063 forward_htlcs: Mutex::new(forward_htlcs),
10064 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
10065 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
10066 id_to_peer: Mutex::new(id_to_peer),
10067 short_to_chan_info: FairRwLock::new(short_to_chan_info),
10068 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
10070 probing_cookie_secret: probing_cookie_secret.unwrap(),
10072 our_network_pubkey,
10075 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
10077 per_peer_state: FairRwLock::new(per_peer_state),
10079 pending_events: Mutex::new(pending_events_read),
10080 pending_events_processor: AtomicBool::new(false),
10081 pending_background_events: Mutex::new(pending_background_events),
10082 total_consistency_lock: RwLock::new(()),
10083 background_events_processed_since_startup: AtomicBool::new(false),
10085 event_persist_notifier: Notifier::new(),
10086 needs_persist_flag: AtomicBool::new(false),
10088 funding_batch_states: Mutex::new(BTreeMap::new()),
10090 entropy_source: args.entropy_source,
10091 node_signer: args.node_signer,
10092 signer_provider: args.signer_provider,
10094 logger: args.logger,
10095 default_configuration: args.default_config,
10098 for htlc_source in failed_htlcs.drain(..) {
10099 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
10100 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
10101 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
10102 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
10105 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding) in pending_claims_to_replay {
10106 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
10107 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
10108 // channel is closed we just assume that it probably came from an on-chain claim.
10109 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
10110 downstream_closed, downstream_node_id, downstream_funding);
10113 //TODO: Broadcast channel update for closed channels, but only after we've made a
10114 //connection or two.
10116 Ok((best_block_hash.clone(), channel_manager))
10122 use bitcoin::hashes::Hash;
10123 use bitcoin::hashes::sha256::Hash as Sha256;
10124 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
10125 use core::sync::atomic::Ordering;
10126 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
10127 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
10128 use crate::ln::ChannelId;
10129 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
10130 use crate::ln::functional_test_utils::*;
10131 use crate::ln::msgs::{self, ErrorAction};
10132 use crate::ln::msgs::ChannelMessageHandler;
10133 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
10134 use crate::util::errors::APIError;
10135 use crate::util::test_utils;
10136 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
10137 use crate::sign::EntropySource;
10140 fn test_notify_limits() {
10141 // Check that a few cases which don't require the persistence of a new ChannelManager,
10142 // indeed, do not cause the persistence of a new ChannelManager.
10143 let chanmon_cfgs = create_chanmon_cfgs(3);
10144 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10145 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
10146 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10148 // All nodes start with a persistable update pending as `create_network` connects each node
10149 // with all other nodes to make most tests simpler.
10150 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10151 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10152 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10154 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
10156 // We check that the channel info nodes have doesn't change too early, even though we try
10157 // to connect messages with new values
10158 chan.0.contents.fee_base_msat *= 2;
10159 chan.1.contents.fee_base_msat *= 2;
10160 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
10161 &nodes[1].node.get_our_node_id()).pop().unwrap();
10162 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
10163 &nodes[0].node.get_our_node_id()).pop().unwrap();
10165 // The first two nodes (which opened a channel) should now require fresh persistence
10166 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10167 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10168 // ... but the last node should not.
10169 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10170 // After persisting the first two nodes they should no longer need fresh persistence.
10171 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10172 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10174 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
10175 // about the channel.
10176 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
10177 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
10178 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10180 // The nodes which are a party to the channel should also ignore messages from unrelated
10182 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
10183 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
10184 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
10185 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
10186 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10187 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10189 // At this point the channel info given by peers should still be the same.
10190 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
10191 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
10193 // An earlier version of handle_channel_update didn't check the directionality of the
10194 // update message and would always update the local fee info, even if our peer was
10195 // (spuriously) forwarding us our own channel_update.
10196 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
10197 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
10198 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
10200 // First deliver each peers' own message, checking that the node doesn't need to be
10201 // persisted and that its channel info remains the same.
10202 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
10203 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
10204 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10205 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10206 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
10207 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
10209 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
10210 // the channel info has updated.
10211 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
10212 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
10213 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10214 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10215 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
10216 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
10220 fn test_keysend_dup_hash_partial_mpp() {
10221 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
10223 let chanmon_cfgs = create_chanmon_cfgs(2);
10224 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10225 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10226 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10227 create_announced_chan_between_nodes(&nodes, 0, 1);
10229 // First, send a partial MPP payment.
10230 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
10231 let mut mpp_route = route.clone();
10232 mpp_route.paths.push(mpp_route.paths[0].clone());
10234 let payment_id = PaymentId([42; 32]);
10235 // Use the utility function send_payment_along_path to send the payment with MPP data which
10236 // indicates there are more HTLCs coming.
10237 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.
10238 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
10239 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
10240 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
10241 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
10242 check_added_monitors!(nodes[0], 1);
10243 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10244 assert_eq!(events.len(), 1);
10245 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
10247 // Next, send a keysend payment with the same payment_hash and make sure it fails.
10248 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10249 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
10250 check_added_monitors!(nodes[0], 1);
10251 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10252 assert_eq!(events.len(), 1);
10253 let ev = events.drain(..).next().unwrap();
10254 let payment_event = SendEvent::from_event(ev);
10255 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10256 check_added_monitors!(nodes[1], 0);
10257 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10258 expect_pending_htlcs_forwardable!(nodes[1]);
10259 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
10260 check_added_monitors!(nodes[1], 1);
10261 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10262 assert!(updates.update_add_htlcs.is_empty());
10263 assert!(updates.update_fulfill_htlcs.is_empty());
10264 assert_eq!(updates.update_fail_htlcs.len(), 1);
10265 assert!(updates.update_fail_malformed_htlcs.is_empty());
10266 assert!(updates.update_fee.is_none());
10267 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10268 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10269 expect_payment_failed!(nodes[0], our_payment_hash, true);
10271 // Send the second half of the original MPP payment.
10272 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
10273 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
10274 check_added_monitors!(nodes[0], 1);
10275 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10276 assert_eq!(events.len(), 1);
10277 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
10279 // Claim the full MPP payment. Note that we can't use a test utility like
10280 // claim_funds_along_route because the ordering of the messages causes the second half of the
10281 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
10282 // lightning messages manually.
10283 nodes[1].node.claim_funds(payment_preimage);
10284 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
10285 check_added_monitors!(nodes[1], 2);
10287 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10288 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
10289 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
10290 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
10291 check_added_monitors!(nodes[0], 1);
10292 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10293 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
10294 check_added_monitors!(nodes[1], 1);
10295 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10296 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
10297 check_added_monitors!(nodes[1], 1);
10298 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
10299 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
10300 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
10301 check_added_monitors!(nodes[0], 1);
10302 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
10303 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
10304 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10305 check_added_monitors!(nodes[0], 1);
10306 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
10307 check_added_monitors!(nodes[1], 1);
10308 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
10309 check_added_monitors!(nodes[1], 1);
10310 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
10311 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
10312 check_added_monitors!(nodes[0], 1);
10314 // Note that successful MPP payments will generate a single PaymentSent event upon the first
10315 // path's success and a PaymentPathSuccessful event for each path's success.
10316 let events = nodes[0].node.get_and_clear_pending_events();
10317 assert_eq!(events.len(), 2);
10319 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
10320 assert_eq!(payment_id, *actual_payment_id);
10321 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
10322 assert_eq!(route.paths[0], *path);
10324 _ => panic!("Unexpected event"),
10327 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
10328 assert_eq!(payment_id, *actual_payment_id);
10329 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
10330 assert_eq!(route.paths[0], *path);
10332 _ => panic!("Unexpected event"),
10337 fn test_keysend_dup_payment_hash() {
10338 do_test_keysend_dup_payment_hash(false);
10339 do_test_keysend_dup_payment_hash(true);
10342 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
10343 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
10344 // outbound regular payment fails as expected.
10345 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
10346 // fails as expected.
10347 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
10348 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
10349 // reject MPP keysend payments, since in this case where the payment has no payment
10350 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
10351 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
10352 // payment secrets and reject otherwise.
10353 let chanmon_cfgs = create_chanmon_cfgs(2);
10354 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10355 let mut mpp_keysend_cfg = test_default_channel_config();
10356 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
10357 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
10358 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10359 create_announced_chan_between_nodes(&nodes, 0, 1);
10360 let scorer = test_utils::TestScorer::new();
10361 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10363 // To start (1), send a regular payment but don't claim it.
10364 let expected_route = [&nodes[1]];
10365 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
10367 // Next, attempt a keysend payment and make sure it fails.
10368 let route_params = RouteParameters::from_payment_params_and_value(
10369 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
10370 TEST_FINAL_CLTV, false), 100_000);
10371 let route = find_route(
10372 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
10373 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10375 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10376 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
10377 check_added_monitors!(nodes[0], 1);
10378 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10379 assert_eq!(events.len(), 1);
10380 let ev = events.drain(..).next().unwrap();
10381 let payment_event = SendEvent::from_event(ev);
10382 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10383 check_added_monitors!(nodes[1], 0);
10384 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10385 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
10386 // fails), the second will process the resulting failure and fail the HTLC backward
10387 expect_pending_htlcs_forwardable!(nodes[1]);
10388 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10389 check_added_monitors!(nodes[1], 1);
10390 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10391 assert!(updates.update_add_htlcs.is_empty());
10392 assert!(updates.update_fulfill_htlcs.is_empty());
10393 assert_eq!(updates.update_fail_htlcs.len(), 1);
10394 assert!(updates.update_fail_malformed_htlcs.is_empty());
10395 assert!(updates.update_fee.is_none());
10396 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10397 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10398 expect_payment_failed!(nodes[0], payment_hash, true);
10400 // Finally, claim the original payment.
10401 claim_payment(&nodes[0], &expected_route, payment_preimage);
10403 // To start (2), send a keysend payment but don't claim it.
10404 let payment_preimage = PaymentPreimage([42; 32]);
10405 let route = find_route(
10406 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
10407 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10409 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10410 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
10411 check_added_monitors!(nodes[0], 1);
10412 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10413 assert_eq!(events.len(), 1);
10414 let event = events.pop().unwrap();
10415 let path = vec![&nodes[1]];
10416 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
10418 // Next, attempt a regular payment and make sure it fails.
10419 let payment_secret = PaymentSecret([43; 32]);
10420 nodes[0].node.send_payment_with_route(&route, payment_hash,
10421 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
10422 check_added_monitors!(nodes[0], 1);
10423 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10424 assert_eq!(events.len(), 1);
10425 let ev = events.drain(..).next().unwrap();
10426 let payment_event = SendEvent::from_event(ev);
10427 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10428 check_added_monitors!(nodes[1], 0);
10429 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10430 expect_pending_htlcs_forwardable!(nodes[1]);
10431 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10432 check_added_monitors!(nodes[1], 1);
10433 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10434 assert!(updates.update_add_htlcs.is_empty());
10435 assert!(updates.update_fulfill_htlcs.is_empty());
10436 assert_eq!(updates.update_fail_htlcs.len(), 1);
10437 assert!(updates.update_fail_malformed_htlcs.is_empty());
10438 assert!(updates.update_fee.is_none());
10439 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10440 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10441 expect_payment_failed!(nodes[0], payment_hash, true);
10443 // Finally, succeed the keysend payment.
10444 claim_payment(&nodes[0], &expected_route, payment_preimage);
10446 // To start (3), send a keysend payment but don't claim it.
10447 let payment_id_1 = PaymentId([44; 32]);
10448 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10449 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
10450 check_added_monitors!(nodes[0], 1);
10451 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10452 assert_eq!(events.len(), 1);
10453 let event = events.pop().unwrap();
10454 let path = vec![&nodes[1]];
10455 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
10457 // Next, attempt a keysend payment and make sure it fails.
10458 let route_params = RouteParameters::from_payment_params_and_value(
10459 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
10462 let route = find_route(
10463 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
10464 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10466 let payment_id_2 = PaymentId([45; 32]);
10467 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10468 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
10469 check_added_monitors!(nodes[0], 1);
10470 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10471 assert_eq!(events.len(), 1);
10472 let ev = events.drain(..).next().unwrap();
10473 let payment_event = SendEvent::from_event(ev);
10474 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10475 check_added_monitors!(nodes[1], 0);
10476 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10477 expect_pending_htlcs_forwardable!(nodes[1]);
10478 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10479 check_added_monitors!(nodes[1], 1);
10480 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10481 assert!(updates.update_add_htlcs.is_empty());
10482 assert!(updates.update_fulfill_htlcs.is_empty());
10483 assert_eq!(updates.update_fail_htlcs.len(), 1);
10484 assert!(updates.update_fail_malformed_htlcs.is_empty());
10485 assert!(updates.update_fee.is_none());
10486 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10487 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10488 expect_payment_failed!(nodes[0], payment_hash, true);
10490 // Finally, claim the original payment.
10491 claim_payment(&nodes[0], &expected_route, payment_preimage);
10495 fn test_keysend_hash_mismatch() {
10496 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
10497 // preimage doesn't match the msg's payment hash.
10498 let chanmon_cfgs = create_chanmon_cfgs(2);
10499 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10500 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10501 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10503 let payer_pubkey = nodes[0].node.get_our_node_id();
10504 let payee_pubkey = nodes[1].node.get_our_node_id();
10506 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
10507 let route_params = RouteParameters::from_payment_params_and_value(
10508 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
10509 let network_graph = nodes[0].network_graph.clone();
10510 let first_hops = nodes[0].node.list_usable_channels();
10511 let scorer = test_utils::TestScorer::new();
10512 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10513 let route = find_route(
10514 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
10515 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10518 let test_preimage = PaymentPreimage([42; 32]);
10519 let mismatch_payment_hash = PaymentHash([43; 32]);
10520 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
10521 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
10522 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
10523 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
10524 check_added_monitors!(nodes[0], 1);
10526 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10527 assert_eq!(updates.update_add_htlcs.len(), 1);
10528 assert!(updates.update_fulfill_htlcs.is_empty());
10529 assert!(updates.update_fail_htlcs.is_empty());
10530 assert!(updates.update_fail_malformed_htlcs.is_empty());
10531 assert!(updates.update_fee.is_none());
10532 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
10534 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
10538 fn test_keysend_msg_with_secret_err() {
10539 // Test that we error as expected if we receive a keysend payment that includes a payment
10540 // secret when we don't support MPP keysend.
10541 let mut reject_mpp_keysend_cfg = test_default_channel_config();
10542 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
10543 let chanmon_cfgs = create_chanmon_cfgs(2);
10544 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10545 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
10546 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10548 let payer_pubkey = nodes[0].node.get_our_node_id();
10549 let payee_pubkey = nodes[1].node.get_our_node_id();
10551 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
10552 let route_params = RouteParameters::from_payment_params_and_value(
10553 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
10554 let network_graph = nodes[0].network_graph.clone();
10555 let first_hops = nodes[0].node.list_usable_channels();
10556 let scorer = test_utils::TestScorer::new();
10557 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10558 let route = find_route(
10559 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
10560 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10563 let test_preimage = PaymentPreimage([42; 32]);
10564 let test_secret = PaymentSecret([43; 32]);
10565 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
10566 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
10567 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
10568 nodes[0].node.test_send_payment_internal(&route, payment_hash,
10569 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
10570 PaymentId(payment_hash.0), None, session_privs).unwrap();
10571 check_added_monitors!(nodes[0], 1);
10573 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10574 assert_eq!(updates.update_add_htlcs.len(), 1);
10575 assert!(updates.update_fulfill_htlcs.is_empty());
10576 assert!(updates.update_fail_htlcs.is_empty());
10577 assert!(updates.update_fail_malformed_htlcs.is_empty());
10578 assert!(updates.update_fee.is_none());
10579 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
10581 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
10585 fn test_multi_hop_missing_secret() {
10586 let chanmon_cfgs = create_chanmon_cfgs(4);
10587 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
10588 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
10589 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
10591 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
10592 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
10593 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
10594 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
10596 // Marshall an MPP route.
10597 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
10598 let path = route.paths[0].clone();
10599 route.paths.push(path);
10600 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
10601 route.paths[0].hops[0].short_channel_id = chan_1_id;
10602 route.paths[0].hops[1].short_channel_id = chan_3_id;
10603 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
10604 route.paths[1].hops[0].short_channel_id = chan_2_id;
10605 route.paths[1].hops[1].short_channel_id = chan_4_id;
10607 match nodes[0].node.send_payment_with_route(&route, payment_hash,
10608 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
10610 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
10611 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
10613 _ => panic!("unexpected error")
10618 fn test_drop_disconnected_peers_when_removing_channels() {
10619 let chanmon_cfgs = create_chanmon_cfgs(2);
10620 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10621 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10622 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10624 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
10626 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
10627 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10629 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
10630 check_closed_broadcast!(nodes[0], true);
10631 check_added_monitors!(nodes[0], 1);
10632 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
10635 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
10636 // disconnected and the channel between has been force closed.
10637 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
10638 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
10639 assert_eq!(nodes_0_per_peer_state.len(), 1);
10640 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
10643 nodes[0].node.timer_tick_occurred();
10646 // Assert that nodes[1] has now been removed.
10647 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
10652 fn bad_inbound_payment_hash() {
10653 // Add coverage for checking that a user-provided payment hash matches the payment secret.
10654 let chanmon_cfgs = create_chanmon_cfgs(2);
10655 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10656 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10657 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10659 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
10660 let payment_data = msgs::FinalOnionHopData {
10662 total_msat: 100_000,
10665 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
10666 // payment verification fails as expected.
10667 let mut bad_payment_hash = payment_hash.clone();
10668 bad_payment_hash.0[0] += 1;
10669 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) {
10670 Ok(_) => panic!("Unexpected ok"),
10672 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
10676 // Check that using the original payment hash succeeds.
10677 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());
10681 fn test_id_to_peer_coverage() {
10682 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
10683 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
10684 // the channel is successfully closed.
10685 let chanmon_cfgs = create_chanmon_cfgs(2);
10686 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10687 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10688 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10690 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
10691 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10692 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
10693 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10694 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10696 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
10697 let channel_id = ChannelId::from_bytes(tx.txid().into_inner());
10699 // Ensure that the `id_to_peer` map is empty until either party has received the
10700 // funding transaction, and have the real `channel_id`.
10701 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10702 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10705 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
10707 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
10708 // as it has the funding transaction.
10709 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10710 assert_eq!(nodes_0_lock.len(), 1);
10711 assert!(nodes_0_lock.contains_key(&channel_id));
10714 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10716 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10718 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10720 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10721 assert_eq!(nodes_0_lock.len(), 1);
10722 assert!(nodes_0_lock.contains_key(&channel_id));
10724 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10727 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
10728 // as it has the funding transaction.
10729 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10730 assert_eq!(nodes_1_lock.len(), 1);
10731 assert!(nodes_1_lock.contains_key(&channel_id));
10733 check_added_monitors!(nodes[1], 1);
10734 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10735 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10736 check_added_monitors!(nodes[0], 1);
10737 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10738 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
10739 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
10740 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
10742 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
10743 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()));
10744 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
10745 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
10747 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
10748 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
10750 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
10751 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
10752 // fee for the closing transaction has been negotiated and the parties has the other
10753 // party's signature for the fee negotiated closing transaction.)
10754 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10755 assert_eq!(nodes_0_lock.len(), 1);
10756 assert!(nodes_0_lock.contains_key(&channel_id));
10760 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
10761 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
10762 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
10763 // kept in the `nodes[1]`'s `id_to_peer` map.
10764 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10765 assert_eq!(nodes_1_lock.len(), 1);
10766 assert!(nodes_1_lock.contains_key(&channel_id));
10769 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()));
10771 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
10772 // therefore has all it needs to fully close the channel (both signatures for the
10773 // closing transaction).
10774 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
10775 // fully closed by `nodes[0]`.
10776 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10778 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
10779 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
10780 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10781 assert_eq!(nodes_1_lock.len(), 1);
10782 assert!(nodes_1_lock.contains_key(&channel_id));
10785 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
10787 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
10789 // Assert that the channel has now been removed from both parties `id_to_peer` map once
10790 // they both have everything required to fully close the channel.
10791 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10793 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
10795 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
10796 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
10799 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10800 let expected_message = format!("Not connected to node: {}", expected_public_key);
10801 check_api_error_message(expected_message, res_err)
10804 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10805 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
10806 check_api_error_message(expected_message, res_err)
10809 fn check_channel_unavailable_error<T>(res_err: Result<T, APIError>, expected_channel_id: ChannelId, peer_node_id: PublicKey) {
10810 let expected_message = format!("Channel with id {} not found for the passed counterparty node_id {}", expected_channel_id, peer_node_id);
10811 check_api_error_message(expected_message, res_err)
10814 fn check_api_misuse_error<T>(res_err: Result<T, APIError>) {
10815 let expected_message = "No such channel awaiting to be accepted.".to_string();
10816 check_api_error_message(expected_message, res_err)
10819 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
10821 Err(APIError::APIMisuseError { err }) => {
10822 assert_eq!(err, expected_err_message);
10824 Err(APIError::ChannelUnavailable { err }) => {
10825 assert_eq!(err, expected_err_message);
10827 Ok(_) => panic!("Unexpected Ok"),
10828 Err(_) => panic!("Unexpected Error"),
10833 fn test_api_calls_with_unkown_counterparty_node() {
10834 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
10835 // expected if the `counterparty_node_id` is an unkown peer in the
10836 // `ChannelManager::per_peer_state` map.
10837 let chanmon_cfg = create_chanmon_cfgs(2);
10838 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10839 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
10840 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10843 let channel_id = ChannelId::from_bytes([4; 32]);
10844 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
10845 let intercept_id = InterceptId([0; 32]);
10847 // Test the API functions.
10848 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);
10850 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
10852 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
10854 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
10856 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
10858 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
10860 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
10864 fn test_api_calls_with_unavailable_channel() {
10865 // Tests that our API functions that expects a `counterparty_node_id` and a `channel_id`
10866 // as input, behaves as expected if the `counterparty_node_id` is a known peer in the
10867 // `ChannelManager::per_peer_state` map, but the peer state doesn't contain a channel with
10868 // the given `channel_id`.
10869 let chanmon_cfg = create_chanmon_cfgs(2);
10870 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10871 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
10872 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10874 let counterparty_node_id = nodes[1].node.get_our_node_id();
10877 let channel_id = ChannelId::from_bytes([4; 32]);
10879 // Test the API functions.
10880 check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42));
10882 check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
10884 check_channel_unavailable_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
10886 check_channel_unavailable_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
10888 check_channel_unavailable_error(nodes[0].node.forward_intercepted_htlc(InterceptId([0; 32]), &channel_id, counterparty_node_id, 1_000_000), channel_id, counterparty_node_id);
10890 check_channel_unavailable_error(nodes[0].node.update_channel_config(&counterparty_node_id, &[channel_id], &ChannelConfig::default()), channel_id, counterparty_node_id);
10894 fn test_connection_limiting() {
10895 // Test that we limit un-channel'd peers and un-funded channels properly.
10896 let chanmon_cfgs = create_chanmon_cfgs(2);
10897 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10898 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10899 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10901 // Note that create_network connects the nodes together for us
10903 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10904 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10906 let mut funding_tx = None;
10907 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10908 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10909 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10912 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10913 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
10914 funding_tx = Some(tx.clone());
10915 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
10916 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10918 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10919 check_added_monitors!(nodes[1], 1);
10920 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10922 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10924 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10925 check_added_monitors!(nodes[0], 1);
10926 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10928 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10931 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
10932 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10933 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10934 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10935 open_channel_msg.temporary_channel_id);
10937 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
10938 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
10940 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
10941 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
10942 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10943 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10944 peer_pks.push(random_pk);
10945 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10946 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10949 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10950 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10951 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10952 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10953 }, true).unwrap_err();
10955 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
10956 // them if we have too many un-channel'd peers.
10957 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10958 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
10959 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
10960 for ev in chan_closed_events {
10961 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
10963 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10964 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10966 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10967 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10968 }, true).unwrap_err();
10970 // but of course if the connection is outbound its allowed...
10971 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10972 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10973 }, false).unwrap();
10974 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10976 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
10977 // Even though we accept one more connection from new peers, we won't actually let them
10979 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
10980 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10981 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
10982 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
10983 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10985 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10986 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10987 open_channel_msg.temporary_channel_id);
10989 // Of course, however, outbound channels are always allowed
10990 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
10991 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
10993 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
10994 // "protected" and can connect again.
10995 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
10996 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10997 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10999 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
11001 // Further, because the first channel was funded, we can open another channel with
11003 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11004 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
11008 fn test_outbound_chans_unlimited() {
11009 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
11010 let chanmon_cfgs = create_chanmon_cfgs(2);
11011 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11012 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11013 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11015 // Note that create_network connects the nodes together for us
11017 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
11018 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11020 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
11021 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11022 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11023 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11026 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
11028 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11029 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11030 open_channel_msg.temporary_channel_id);
11032 // but we can still open an outbound channel.
11033 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
11034 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
11036 // but even with such an outbound channel, additional inbound channels will still fail.
11037 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11038 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11039 open_channel_msg.temporary_channel_id);
11043 fn test_0conf_limiting() {
11044 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
11045 // flag set and (sometimes) accept channels as 0conf.
11046 let chanmon_cfgs = create_chanmon_cfgs(2);
11047 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11048 let mut settings = test_default_channel_config();
11049 settings.manually_accept_inbound_channels = true;
11050 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
11051 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11053 // Note that create_network connects the nodes together for us
11055 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
11056 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11058 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
11059 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
11060 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11061 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11062 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
11063 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11066 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
11067 let events = nodes[1].node.get_and_clear_pending_events();
11069 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11070 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
11072 _ => panic!("Unexpected event"),
11074 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
11075 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11078 // If we try to accept a channel from another peer non-0conf it will fail.
11079 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11080 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11081 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11082 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11084 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11085 let events = nodes[1].node.get_and_clear_pending_events();
11087 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11088 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
11089 Err(APIError::APIMisuseError { err }) =>
11090 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
11094 _ => panic!("Unexpected event"),
11096 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
11097 open_channel_msg.temporary_channel_id);
11099 // ...however if we accept the same channel 0conf it should work just fine.
11100 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11101 let events = nodes[1].node.get_and_clear_pending_events();
11103 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11104 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
11106 _ => panic!("Unexpected event"),
11108 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
11112 fn reject_excessively_underpaying_htlcs() {
11113 let chanmon_cfg = create_chanmon_cfgs(1);
11114 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
11115 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
11116 let node = create_network(1, &node_cfg, &node_chanmgr);
11117 let sender_intended_amt_msat = 100;
11118 let extra_fee_msat = 10;
11119 let hop_data = msgs::InboundOnionPayload::Receive {
11121 outgoing_cltv_value: 42,
11122 payment_metadata: None,
11123 keysend_preimage: None,
11124 payment_data: Some(msgs::FinalOnionHopData {
11125 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
11127 custom_tlvs: Vec::new(),
11129 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
11130 // intended amount, we fail the payment.
11131 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
11132 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
11133 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
11135 assert_eq!(err_code, 19);
11136 } else { panic!(); }
11138 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
11139 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
11141 outgoing_cltv_value: 42,
11142 payment_metadata: None,
11143 keysend_preimage: None,
11144 payment_data: Some(msgs::FinalOnionHopData {
11145 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
11147 custom_tlvs: Vec::new(),
11149 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
11150 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
11154 fn test_final_incorrect_cltv(){
11155 let chanmon_cfg = create_chanmon_cfgs(1);
11156 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
11157 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
11158 let node = create_network(1, &node_cfg, &node_chanmgr);
11160 let result = node[0].node.construct_recv_pending_htlc_info(msgs::InboundOnionPayload::Receive {
11162 outgoing_cltv_value: 22,
11163 payment_metadata: None,
11164 keysend_preimage: None,
11165 payment_data: Some(msgs::FinalOnionHopData {
11166 payment_secret: PaymentSecret([0; 32]), total_msat: 100,
11168 custom_tlvs: Vec::new(),
11169 }, [0; 32], PaymentHash([0; 32]), 100, 23, None, true, None);
11171 // Should not return an error as this condition:
11172 // https://github.com/lightning/bolts/blob/4dcc377209509b13cf89a4b91fde7d478f5b46d8/04-onion-routing.md?plain=1#L334
11173 // is not satisfied.
11174 assert!(result.is_ok());
11178 fn test_inbound_anchors_manual_acceptance() {
11179 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
11180 // flag set and (sometimes) accept channels as 0conf.
11181 let mut anchors_cfg = test_default_channel_config();
11182 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
11184 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
11185 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
11187 let chanmon_cfgs = create_chanmon_cfgs(3);
11188 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
11189 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
11190 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
11191 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
11193 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
11194 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11196 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11197 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
11198 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
11199 match &msg_events[0] {
11200 MessageSendEvent::HandleError { node_id, action } => {
11201 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
11203 ErrorAction::SendErrorMessage { msg } =>
11204 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
11205 _ => panic!("Unexpected error action"),
11208 _ => panic!("Unexpected event"),
11211 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11212 let events = nodes[2].node.get_and_clear_pending_events();
11214 Event::OpenChannelRequest { temporary_channel_id, .. } =>
11215 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
11216 _ => panic!("Unexpected event"),
11218 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11222 fn test_anchors_zero_fee_htlc_tx_fallback() {
11223 // Tests that if both nodes support anchors, but the remote node does not want to accept
11224 // anchor channels at the moment, an error it sent to the local node such that it can retry
11225 // the channel without the anchors feature.
11226 let chanmon_cfgs = create_chanmon_cfgs(2);
11227 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11228 let mut anchors_config = test_default_channel_config();
11229 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
11230 anchors_config.manually_accept_inbound_channels = true;
11231 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
11232 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11234 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
11235 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11236 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
11238 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11239 let events = nodes[1].node.get_and_clear_pending_events();
11241 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11242 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
11244 _ => panic!("Unexpected event"),
11247 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
11248 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
11250 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11251 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
11253 // Since nodes[1] should not have accepted the channel, it should
11254 // not have generated any events.
11255 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
11259 fn test_update_channel_config() {
11260 let chanmon_cfg = create_chanmon_cfgs(2);
11261 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11262 let mut user_config = test_default_channel_config();
11263 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
11264 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11265 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
11266 let channel = &nodes[0].node.list_channels()[0];
11268 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
11269 let events = nodes[0].node.get_and_clear_pending_msg_events();
11270 assert_eq!(events.len(), 0);
11272 user_config.channel_config.forwarding_fee_base_msat += 10;
11273 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
11274 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
11275 let events = nodes[0].node.get_and_clear_pending_msg_events();
11276 assert_eq!(events.len(), 1);
11278 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
11279 _ => panic!("expected BroadcastChannelUpdate event"),
11282 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
11283 let events = nodes[0].node.get_and_clear_pending_msg_events();
11284 assert_eq!(events.len(), 0);
11286 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
11287 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
11288 cltv_expiry_delta: Some(new_cltv_expiry_delta),
11289 ..Default::default()
11291 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
11292 let events = nodes[0].node.get_and_clear_pending_msg_events();
11293 assert_eq!(events.len(), 1);
11295 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
11296 _ => panic!("expected BroadcastChannelUpdate event"),
11299 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
11300 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
11301 forwarding_fee_proportional_millionths: Some(new_fee),
11302 ..Default::default()
11304 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
11305 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
11306 let events = nodes[0].node.get_and_clear_pending_msg_events();
11307 assert_eq!(events.len(), 1);
11309 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
11310 _ => panic!("expected BroadcastChannelUpdate event"),
11313 // If we provide a channel_id not associated with the peer, we should get an error and no updates
11314 // should be applied to ensure update atomicity as specified in the API docs.
11315 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
11316 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
11317 let new_fee = current_fee + 100;
11320 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
11321 forwarding_fee_proportional_millionths: Some(new_fee),
11322 ..Default::default()
11324 Err(APIError::ChannelUnavailable { err: _ }),
11327 // Check that the fee hasn't changed for the channel that exists.
11328 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
11329 let events = nodes[0].node.get_and_clear_pending_msg_events();
11330 assert_eq!(events.len(), 0);
11334 fn test_payment_display() {
11335 let payment_id = PaymentId([42; 32]);
11336 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
11337 let payment_hash = PaymentHash([42; 32]);
11338 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
11339 let payment_preimage = PaymentPreimage([42; 32]);
11340 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
11344 fn test_trigger_lnd_force_close() {
11345 let chanmon_cfg = create_chanmon_cfgs(2);
11346 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11347 let user_config = test_default_channel_config();
11348 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
11349 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11351 // Open a channel, immediately disconnect each other, and broadcast Alice's latest state.
11352 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
11353 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
11354 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11355 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
11356 check_closed_broadcast(&nodes[0], 1, true);
11357 check_added_monitors(&nodes[0], 1);
11358 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
11360 let txn = nodes[0].tx_broadcaster.txn_broadcast();
11361 assert_eq!(txn.len(), 1);
11362 check_spends!(txn[0], funding_tx);
11365 // Since they're disconnected, Bob won't receive Alice's `Error` message. Reconnect them
11366 // such that Bob sends a `ChannelReestablish` to Alice since the channel is still open from
11368 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
11369 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
11371 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11372 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11373 }, false).unwrap();
11374 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
11375 let channel_reestablish = get_event_msg!(
11376 nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()
11378 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &channel_reestablish);
11380 // Alice should respond with an error since the channel isn't known, but a bogus
11381 // `ChannelReestablish` should be sent first, such that we actually trigger Bob to force
11382 // close even if it was an lnd node.
11383 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
11384 assert_eq!(msg_events.len(), 2);
11385 if let MessageSendEvent::SendChannelReestablish { node_id, msg } = &msg_events[0] {
11386 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
11387 assert_eq!(msg.next_local_commitment_number, 0);
11388 assert_eq!(msg.next_remote_commitment_number, 0);
11389 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &msg);
11390 } else { panic!() };
11391 check_closed_broadcast(&nodes[1], 1, true);
11392 check_added_monitors(&nodes[1], 1);
11393 let expected_close_reason = ClosureReason::ProcessingError {
11394 err: "Peer sent an invalid channel_reestablish to force close in a non-standard way".to_string()
11396 check_closed_event!(nodes[1], 1, expected_close_reason, [nodes[0].node.get_our_node_id()], 100000);
11398 let txn = nodes[1].tx_broadcaster.txn_broadcast();
11399 assert_eq!(txn.len(), 1);
11400 check_spends!(txn[0], funding_tx);
11407 use crate::chain::Listen;
11408 use crate::chain::chainmonitor::{ChainMonitor, Persist};
11409 use crate::sign::{KeysManager, InMemorySigner};
11410 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
11411 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
11412 use crate::ln::functional_test_utils::*;
11413 use crate::ln::msgs::{ChannelMessageHandler, Init};
11414 use crate::routing::gossip::NetworkGraph;
11415 use crate::routing::router::{PaymentParameters, RouteParameters};
11416 use crate::util::test_utils;
11417 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
11419 use bitcoin::hashes::Hash;
11420 use bitcoin::hashes::sha256::Hash as Sha256;
11421 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
11423 use crate::sync::{Arc, Mutex, RwLock};
11425 use criterion::Criterion;
11427 type Manager<'a, P> = ChannelManager<
11428 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
11429 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
11430 &'a test_utils::TestLogger, &'a P>,
11431 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
11432 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
11433 &'a test_utils::TestLogger>;
11435 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
11436 node: &'node_cfg Manager<'chan_mon_cfg, P>,
11438 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
11439 type CM = Manager<'chan_mon_cfg, P>;
11441 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
11443 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
11446 pub fn bench_sends(bench: &mut Criterion) {
11447 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
11450 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
11451 // Do a simple benchmark of sending a payment back and forth between two nodes.
11452 // Note that this is unrealistic as each payment send will require at least two fsync
11454 let network = bitcoin::Network::Testnet;
11455 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
11457 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
11458 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
11459 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
11460 let scorer = RwLock::new(test_utils::TestScorer::new());
11461 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
11463 let mut config: UserConfig = Default::default();
11464 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
11465 config.channel_handshake_config.minimum_depth = 1;
11467 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
11468 let seed_a = [1u8; 32];
11469 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
11470 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 {
11472 best_block: BestBlock::from_network(network),
11473 }, genesis_block.header.time);
11474 let node_a_holder = ANodeHolder { node: &node_a };
11476 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
11477 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
11478 let seed_b = [2u8; 32];
11479 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
11480 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 {
11482 best_block: BestBlock::from_network(network),
11483 }, genesis_block.header.time);
11484 let node_b_holder = ANodeHolder { node: &node_b };
11486 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
11487 features: node_b.init_features(), networks: None, remote_network_address: None
11489 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
11490 features: node_a.init_features(), networks: None, remote_network_address: None
11491 }, false).unwrap();
11492 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
11493 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()));
11494 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()));
11497 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
11498 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
11499 value: 8_000_000, script_pubkey: output_script,
11501 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
11502 } else { panic!(); }
11504 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()));
11505 let events_b = node_b.get_and_clear_pending_events();
11506 assert_eq!(events_b.len(), 1);
11507 match events_b[0] {
11508 Event::ChannelPending{ ref counterparty_node_id, .. } => {
11509 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
11511 _ => panic!("Unexpected event"),
11514 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()));
11515 let events_a = node_a.get_and_clear_pending_events();
11516 assert_eq!(events_a.len(), 1);
11517 match events_a[0] {
11518 Event::ChannelPending{ ref counterparty_node_id, .. } => {
11519 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
11521 _ => panic!("Unexpected event"),
11524 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
11526 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
11527 Listen::block_connected(&node_a, &block, 1);
11528 Listen::block_connected(&node_b, &block, 1);
11530 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()));
11531 let msg_events = node_a.get_and_clear_pending_msg_events();
11532 assert_eq!(msg_events.len(), 2);
11533 match msg_events[0] {
11534 MessageSendEvent::SendChannelReady { ref msg, .. } => {
11535 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
11536 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
11540 match msg_events[1] {
11541 MessageSendEvent::SendChannelUpdate { .. } => {},
11545 let events_a = node_a.get_and_clear_pending_events();
11546 assert_eq!(events_a.len(), 1);
11547 match events_a[0] {
11548 Event::ChannelReady{ ref counterparty_node_id, .. } => {
11549 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
11551 _ => panic!("Unexpected event"),
11554 let events_b = node_b.get_and_clear_pending_events();
11555 assert_eq!(events_b.len(), 1);
11556 match events_b[0] {
11557 Event::ChannelReady{ ref counterparty_node_id, .. } => {
11558 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
11560 _ => panic!("Unexpected event"),
11563 let mut payment_count: u64 = 0;
11564 macro_rules! send_payment {
11565 ($node_a: expr, $node_b: expr) => {
11566 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
11567 .with_bolt11_features($node_b.invoice_features()).unwrap();
11568 let mut payment_preimage = PaymentPreimage([0; 32]);
11569 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
11570 payment_count += 1;
11571 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
11572 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
11574 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
11575 PaymentId(payment_hash.0),
11576 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
11577 Retry::Attempts(0)).unwrap();
11578 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
11579 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
11580 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
11581 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
11582 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
11583 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
11584 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &get_event_msg!(ANodeHolder { node: &$node_a }, MessageSendEvent::SendRevokeAndACK, $node_b.get_our_node_id()));
11586 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
11587 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
11588 $node_b.claim_funds(payment_preimage);
11589 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
11591 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
11592 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
11593 assert_eq!(node_id, $node_a.get_our_node_id());
11594 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
11595 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
11597 _ => panic!("Failed to generate claim event"),
11600 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
11601 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
11602 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
11603 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &get_event_msg!(ANodeHolder { node: &$node_b }, MessageSendEvent::SendRevokeAndACK, $node_a.get_our_node_id()));
11605 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
11609 bench.bench_function(bench_name, |b| b.iter(|| {
11610 send_payment!(node_a, node_b);
11611 send_payment!(node_b, node_a);