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::Header;
21 use bitcoin::blockdata::transaction::Transaction;
22 use bitcoin::blockdata::constants::ChainHash;
23 use bitcoin::key::constants::SECRET_KEY_SIZE;
24 use bitcoin::network::constants::Network;
26 use bitcoin::hashes::Hash;
27 use bitcoin::hashes::sha256::Hash as Sha256;
28 use bitcoin::hash_types::{BlockHash, Txid};
30 use bitcoin::secp256k1::{SecretKey,PublicKey};
31 use bitcoin::secp256k1::Secp256k1;
32 use bitcoin::{secp256k1, Sequence};
34 use crate::blinded_path::BlindedPath;
35 use crate::blinded_path::payment::{PaymentConstraints, ReceiveTlvs};
37 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
38 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
39 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, WithChannelMonitor, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
40 use crate::chain::transaction::{OutPoint, TransactionData};
42 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
43 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
44 // construct one themselves.
45 use crate::ln::{inbound_payment, ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
46 use crate::ln::channel::{self, Channel, ChannelPhase, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UnfundedChannelContext, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel, WithChannelContext};
47 pub use crate::ln::channel::{InboundHTLCDetails, InboundHTLCStateDetails, OutboundHTLCDetails, OutboundHTLCStateDetails};
48 use crate::ln::features::{Bolt12InvoiceFeatures, ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
49 #[cfg(any(feature = "_test_utils", test))]
50 use crate::ln::features::Bolt11InvoiceFeatures;
51 use crate::routing::router::{BlindedTail, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
52 use crate::ln::onion_payment::{check_incoming_htlc_cltv, create_recv_pending_htlc_info, create_fwd_pending_htlc_info, decode_incoming_update_add_htlc_onion, InboundHTLCErr, NextPacketDetails};
54 use crate::ln::onion_utils;
55 use crate::ln::onion_utils::{HTLCFailReason, INVALID_ONION_BLINDING};
56 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
58 use crate::ln::outbound_payment;
59 use crate::ln::outbound_payment::{Bolt12PaymentError, OutboundPayments, PaymentAttempts, PendingOutboundPayment, SendAlongPathArgs, StaleExpiration};
60 use crate::ln::wire::Encode;
61 use crate::offers::invoice::{BlindedPayInfo, Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, DerivedSigningPubkey, InvoiceBuilder};
62 use crate::offers::invoice_error::InvoiceError;
63 use crate::offers::merkle::SignError;
64 use crate::offers::offer::{DerivedMetadata, Offer, OfferBuilder};
65 use crate::offers::parse::Bolt12SemanticError;
66 use crate::offers::refund::{Refund, RefundBuilder};
67 use crate::onion_message::messenger::{Destination, MessageRouter, PendingOnionMessage, new_pending_onion_message};
68 use crate::onion_message::offers::{OffersMessage, OffersMessageHandler};
69 use crate::sign::{EntropySource, NodeSigner, Recipient, SignerProvider};
70 use crate::sign::ecdsa::WriteableEcdsaChannelSigner;
71 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
72 use crate::util::wakers::{Future, Notifier};
73 use crate::util::scid_utils::fake_scid;
74 use crate::util::string::UntrustedString;
75 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
76 use crate::util::logger::{Level, Logger, WithContext};
77 use crate::util::errors::APIError;
78 #[cfg(not(c_bindings))]
80 crate::routing::router::DefaultRouter,
81 crate::routing::gossip::NetworkGraph,
82 crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters},
83 crate::sign::KeysManager,
86 use alloc::collections::{btree_map, BTreeMap};
89 use crate::prelude::*;
91 use core::cell::RefCell;
93 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
94 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
95 use core::time::Duration;
98 // Re-export this for use in the public API.
99 pub use crate::ln::outbound_payment::{PaymentSendFailure, ProbeSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
100 use crate::ln::script::ShutdownScript;
102 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
104 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
105 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
106 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
108 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
109 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
110 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
111 // before we forward it.
113 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
114 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
115 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
116 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
117 // our payment, which we can use to decode errors or inform the user that the payment was sent.
119 /// Information about where a received HTLC('s onion) has indicated the HTLC should go.
120 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
121 #[cfg_attr(test, derive(Debug, PartialEq))]
122 pub enum PendingHTLCRouting {
123 /// An HTLC which should be forwarded on to another node.
125 /// The onion which should be included in the forwarded HTLC, telling the next hop what to
126 /// do with the HTLC.
127 onion_packet: msgs::OnionPacket,
128 /// The short channel ID of the channel which we were instructed to forward this HTLC to.
130 /// This could be a real on-chain SCID, an SCID alias, or some other SCID which has meaning
131 /// to the receiving node, such as one returned from
132 /// [`ChannelManager::get_intercept_scid`] or [`ChannelManager::get_phantom_scid`].
133 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
134 /// Set if this HTLC is being forwarded within a blinded path.
135 blinded: Option<BlindedForward>,
137 /// The onion indicates that this is a payment for an invoice (supposedly) generated by us.
139 /// Note that at this point, we have not checked that the invoice being paid was actually
140 /// generated by us, but rather it's claiming to pay an invoice of ours.
142 /// Information about the amount the sender intended to pay and (potential) proof that this
143 /// is a payment for an invoice we generated. This proof of payment is is also used for
144 /// linking MPP parts of a larger payment.
145 payment_data: msgs::FinalOnionHopData,
146 /// Additional data which we (allegedly) instructed the sender to include in the onion.
148 /// For HTLCs received by LDK, this will ultimately be exposed in
149 /// [`Event::PaymentClaimable::onion_fields`] as
150 /// [`RecipientOnionFields::payment_metadata`].
151 payment_metadata: Option<Vec<u8>>,
152 /// CLTV expiry of the received HTLC.
154 /// Used to track when we should expire pending HTLCs that go unclaimed.
155 incoming_cltv_expiry: u32,
156 /// If the onion had forwarding instructions to one of our phantom node SCIDs, this will
157 /// provide the onion shared secret used to decrypt the next level of forwarding
159 phantom_shared_secret: Option<[u8; 32]>,
160 /// Custom TLVs which were set by the sender.
162 /// For HTLCs received by LDK, this will ultimately be exposed in
163 /// [`Event::PaymentClaimable::onion_fields`] as
164 /// [`RecipientOnionFields::custom_tlvs`].
165 custom_tlvs: Vec<(u64, Vec<u8>)>,
166 /// Set if this HTLC is the final hop in a multi-hop blinded path.
167 requires_blinded_error: bool,
169 /// The onion indicates that this is for payment to us but which contains the preimage for
170 /// claiming included, and is unrelated to any invoice we'd previously generated (aka a
171 /// "keysend" or "spontaneous" payment).
173 /// Information about the amount the sender intended to pay and possibly a token to
174 /// associate MPP parts of a larger payment.
176 /// This will only be filled in if receiving MPP keysend payments is enabled, and it being
177 /// present will cause deserialization to fail on versions of LDK prior to 0.0.116.
178 payment_data: Option<msgs::FinalOnionHopData>,
179 /// Preimage for this onion payment. This preimage is provided by the sender and will be
180 /// used to settle the spontaneous payment.
181 payment_preimage: PaymentPreimage,
182 /// Additional data which we (allegedly) instructed the sender to include in the onion.
184 /// For HTLCs received by LDK, this will ultimately bubble back up as
185 /// [`RecipientOnionFields::payment_metadata`].
186 payment_metadata: Option<Vec<u8>>,
187 /// CLTV expiry of the received HTLC.
189 /// Used to track when we should expire pending HTLCs that go unclaimed.
190 incoming_cltv_expiry: u32,
191 /// Custom TLVs which were set by the sender.
193 /// For HTLCs received by LDK, these will ultimately bubble back up as
194 /// [`RecipientOnionFields::custom_tlvs`].
195 custom_tlvs: Vec<(u64, Vec<u8>)>,
199 /// Information used to forward or fail this HTLC that is being forwarded within a blinded path.
200 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
201 pub struct BlindedForward {
202 /// The `blinding_point` that was set in the inbound [`msgs::UpdateAddHTLC`], or in the inbound
203 /// onion payload if we're the introduction node. Useful for calculating the next hop's
204 /// [`msgs::UpdateAddHTLC::blinding_point`].
205 pub inbound_blinding_point: PublicKey,
206 /// If needed, this determines how this HTLC should be failed backwards, based on whether we are
207 /// the introduction node.
208 pub failure: BlindedFailure,
211 impl PendingHTLCRouting {
212 // Used to override the onion failure code and data if the HTLC is blinded.
213 fn blinded_failure(&self) -> Option<BlindedFailure> {
215 Self::Forward { blinded: Some(BlindedForward { failure, .. }), .. } => Some(*failure),
216 Self::Receive { requires_blinded_error: true, .. } => Some(BlindedFailure::FromBlindedNode),
222 /// Information about an incoming HTLC, including the [`PendingHTLCRouting`] describing where it
224 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
225 #[cfg_attr(test, derive(Debug, PartialEq))]
226 pub struct PendingHTLCInfo {
227 /// Further routing details based on whether the HTLC is being forwarded or received.
228 pub routing: PendingHTLCRouting,
229 /// The onion shared secret we build with the sender used to decrypt the onion.
231 /// This is later used to encrypt failure packets in the event that the HTLC is failed.
232 pub incoming_shared_secret: [u8; 32],
233 /// Hash of the payment preimage, to lock the payment until the receiver releases the preimage.
234 pub payment_hash: PaymentHash,
235 /// Amount received in the incoming HTLC.
237 /// This field was added in LDK 0.0.113 and will be `None` for objects written by prior
239 pub incoming_amt_msat: Option<u64>,
240 /// The amount the sender indicated should be forwarded on to the next hop or amount the sender
241 /// intended for us to receive for received payments.
243 /// If the received amount is less than this for received payments, an intermediary hop has
244 /// attempted to steal some of our funds and we should fail the HTLC (the sender should retry
245 /// it along another path).
247 /// Because nodes can take less than their required fees, and because senders may wish to
248 /// improve their own privacy, this amount may be less than [`Self::incoming_amt_msat`] for
249 /// received payments. In such cases, recipients must handle this HTLC as if it had received
250 /// [`Self::outgoing_amt_msat`].
251 pub outgoing_amt_msat: u64,
252 /// The CLTV the sender has indicated we should set on the forwarded HTLC (or has indicated
253 /// should have been set on the received HTLC for received payments).
254 pub outgoing_cltv_value: u32,
255 /// The fee taken for this HTLC in addition to the standard protocol HTLC fees.
257 /// If this is a payment for forwarding, this is the fee we are taking before forwarding the
260 /// If this is a received payment, this is the fee that our counterparty took.
262 /// This is used to allow LSPs to take fees as a part of payments, without the sender having to
264 pub skimmed_fee_msat: Option<u64>,
267 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
268 pub(super) enum HTLCFailureMsg {
269 Relay(msgs::UpdateFailHTLC),
270 Malformed(msgs::UpdateFailMalformedHTLC),
273 /// Stores whether we can't forward an HTLC or relevant forwarding info
274 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
275 pub(super) enum PendingHTLCStatus {
276 Forward(PendingHTLCInfo),
277 Fail(HTLCFailureMsg),
280 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
281 pub(super) struct PendingAddHTLCInfo {
282 pub(super) forward_info: PendingHTLCInfo,
284 // These fields are produced in `forward_htlcs()` and consumed in
285 // `process_pending_htlc_forwards()` for constructing the
286 // `HTLCSource::PreviousHopData` for failed and forwarded
289 // Note that this may be an outbound SCID alias for the associated channel.
290 prev_short_channel_id: u64,
292 prev_channel_id: ChannelId,
293 prev_funding_outpoint: OutPoint,
294 prev_user_channel_id: u128,
297 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
298 pub(super) enum HTLCForwardInfo {
299 AddHTLC(PendingAddHTLCInfo),
302 err_packet: msgs::OnionErrorPacket,
307 sha256_of_onion: [u8; 32],
311 /// Whether this blinded HTLC is being failed backwards by the introduction node or a blinded node,
312 /// which determines the failure message that should be used.
313 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
314 pub enum BlindedFailure {
315 /// This HTLC is being failed backwards by the introduction node, and thus should be failed with
316 /// [`msgs::UpdateFailHTLC`] and error code `0x8000|0x4000|24`.
317 FromIntroductionNode,
318 /// This HTLC is being failed backwards by a blinded node within the path, and thus should be
319 /// failed with [`msgs::UpdateFailMalformedHTLC`] and error code `0x8000|0x4000|24`.
323 /// Tracks the inbound corresponding to an outbound HTLC
324 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
325 pub(crate) struct HTLCPreviousHopData {
326 // Note that this may be an outbound SCID alias for the associated channel.
327 short_channel_id: u64,
328 user_channel_id: Option<u128>,
330 incoming_packet_shared_secret: [u8; 32],
331 phantom_shared_secret: Option<[u8; 32]>,
332 blinded_failure: Option<BlindedFailure>,
333 channel_id: ChannelId,
335 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
336 // channel with a preimage provided by the forward channel.
341 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
343 /// This is only here for backwards-compatibility in serialization, in the future it can be
344 /// removed, breaking clients running 0.0.106 and earlier.
345 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
347 /// Contains the payer-provided preimage.
348 Spontaneous(PaymentPreimage),
351 /// HTLCs that are to us and can be failed/claimed by the user
352 struct ClaimableHTLC {
353 prev_hop: HTLCPreviousHopData,
355 /// The amount (in msats) of this MPP part
357 /// The amount (in msats) that the sender intended to be sent in this MPP
358 /// part (used for validating total MPP amount)
359 sender_intended_value: u64,
360 onion_payload: OnionPayload,
362 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
363 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
364 total_value_received: Option<u64>,
365 /// The sender intended sum total of all MPP parts specified in the onion
367 /// The extra fee our counterparty skimmed off the top of this HTLC.
368 counterparty_skimmed_fee_msat: Option<u64>,
371 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
372 fn from(val: &ClaimableHTLC) -> Self {
373 events::ClaimedHTLC {
374 channel_id: val.prev_hop.channel_id,
375 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
376 cltv_expiry: val.cltv_expiry,
377 value_msat: val.value,
378 counterparty_skimmed_fee_msat: val.counterparty_skimmed_fee_msat.unwrap_or(0),
383 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
384 /// a payment and ensure idempotency in LDK.
386 /// This is not exported to bindings users as we just use [u8; 32] directly
387 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
388 pub struct PaymentId(pub [u8; Self::LENGTH]);
391 /// Number of bytes in the id.
392 pub const LENGTH: usize = 32;
395 impl Writeable for PaymentId {
396 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
401 impl Readable for PaymentId {
402 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
403 let buf: [u8; 32] = Readable::read(r)?;
408 impl core::fmt::Display for PaymentId {
409 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
410 crate::util::logger::DebugBytes(&self.0).fmt(f)
414 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
416 /// This is not exported to bindings users as we just use [u8; 32] directly
417 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
418 pub struct InterceptId(pub [u8; 32]);
420 impl Writeable for InterceptId {
421 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
426 impl Readable for InterceptId {
427 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
428 let buf: [u8; 32] = Readable::read(r)?;
433 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
434 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
435 pub(crate) enum SentHTLCId {
436 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
437 OutboundRoute { session_priv: [u8; SECRET_KEY_SIZE] },
440 pub(crate) fn from_source(source: &HTLCSource) -> Self {
442 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
443 short_channel_id: hop_data.short_channel_id,
444 htlc_id: hop_data.htlc_id,
446 HTLCSource::OutboundRoute { session_priv, .. } =>
447 Self::OutboundRoute { session_priv: session_priv.secret_bytes() },
451 impl_writeable_tlv_based_enum!(SentHTLCId,
452 (0, PreviousHopData) => {
453 (0, short_channel_id, required),
454 (2, htlc_id, required),
456 (2, OutboundRoute) => {
457 (0, session_priv, required),
462 /// Tracks the inbound corresponding to an outbound HTLC
463 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
464 #[derive(Clone, Debug, PartialEq, Eq)]
465 pub(crate) enum HTLCSource {
466 PreviousHopData(HTLCPreviousHopData),
469 session_priv: SecretKey,
470 /// Technically we can recalculate this from the route, but we cache it here to avoid
471 /// doing a double-pass on route when we get a failure back
472 first_hop_htlc_msat: u64,
473 payment_id: PaymentId,
476 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
477 impl core::hash::Hash for HTLCSource {
478 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
480 HTLCSource::PreviousHopData(prev_hop_data) => {
482 prev_hop_data.hash(hasher);
484 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
487 session_priv[..].hash(hasher);
488 payment_id.hash(hasher);
489 first_hop_htlc_msat.hash(hasher);
495 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
497 pub fn dummy() -> Self {
498 HTLCSource::OutboundRoute {
499 path: Path { hops: Vec::new(), blinded_tail: None },
500 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
501 first_hop_htlc_msat: 0,
502 payment_id: PaymentId([2; 32]),
506 #[cfg(debug_assertions)]
507 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
508 /// transaction. Useful to ensure different datastructures match up.
509 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
510 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
511 *first_hop_htlc_msat == htlc.amount_msat
513 // There's nothing we can check for forwarded HTLCs
519 /// This enum is used to specify which error data to send to peers when failing back an HTLC
520 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
522 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
523 #[derive(Clone, Copy)]
524 pub enum FailureCode {
525 /// We had a temporary error processing the payment. Useful if no other error codes fit
526 /// and you want to indicate that the payer may want to retry.
527 TemporaryNodeFailure,
528 /// We have a required feature which was not in this onion. For example, you may require
529 /// some additional metadata that was not provided with this payment.
530 RequiredNodeFeatureMissing,
531 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
532 /// the HTLC is too close to the current block height for safe handling.
533 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
534 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
535 IncorrectOrUnknownPaymentDetails,
536 /// We failed to process the payload after the onion was decrypted. You may wish to
537 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
539 /// If available, the tuple data may include the type number and byte offset in the
540 /// decrypted byte stream where the failure occurred.
541 InvalidOnionPayload(Option<(u64, u16)>),
544 impl Into<u16> for FailureCode {
545 fn into(self) -> u16 {
547 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
548 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
549 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
550 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
555 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
556 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
557 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
558 /// peer_state lock. We then return the set of things that need to be done outside the lock in
559 /// this struct and call handle_error!() on it.
561 struct MsgHandleErrInternal {
562 err: msgs::LightningError,
563 closes_channel: bool,
564 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
566 impl MsgHandleErrInternal {
568 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
570 err: LightningError {
572 action: msgs::ErrorAction::SendErrorMessage {
573 msg: msgs::ErrorMessage {
579 closes_channel: false,
580 shutdown_finish: None,
584 fn from_no_close(err: msgs::LightningError) -> Self {
585 Self { err, closes_channel: false, shutdown_finish: None }
588 fn from_finish_shutdown(err: String, channel_id: ChannelId, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
589 let err_msg = msgs::ErrorMessage { channel_id, data: err.clone() };
590 let action = if shutdown_res.monitor_update.is_some() {
591 // We have a closing `ChannelMonitorUpdate`, which means the channel was funded and we
592 // should disconnect our peer such that we force them to broadcast their latest
593 // commitment upon reconnecting.
594 msgs::ErrorAction::DisconnectPeer { msg: Some(err_msg) }
596 msgs::ErrorAction::SendErrorMessage { msg: err_msg }
599 err: LightningError { err, action },
600 closes_channel: true,
601 shutdown_finish: Some((shutdown_res, channel_update)),
605 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
608 ChannelError::Warn(msg) => LightningError {
610 action: msgs::ErrorAction::SendWarningMessage {
611 msg: msgs::WarningMessage {
615 log_level: Level::Warn,
618 ChannelError::Ignore(msg) => LightningError {
620 action: msgs::ErrorAction::IgnoreError,
622 ChannelError::Close(msg) => LightningError {
624 action: msgs::ErrorAction::SendErrorMessage {
625 msg: msgs::ErrorMessage {
632 closes_channel: false,
633 shutdown_finish: None,
637 fn closes_channel(&self) -> bool {
642 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
643 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
644 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
645 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
646 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
648 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
649 /// be sent in the order they appear in the return value, however sometimes the order needs to be
650 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
651 /// they were originally sent). In those cases, this enum is also returned.
652 #[derive(Clone, PartialEq)]
653 pub(super) enum RAACommitmentOrder {
654 /// Send the CommitmentUpdate messages first
656 /// Send the RevokeAndACK message first
660 /// Information about a payment which is currently being claimed.
661 struct ClaimingPayment {
663 payment_purpose: events::PaymentPurpose,
664 receiver_node_id: PublicKey,
665 htlcs: Vec<events::ClaimedHTLC>,
666 sender_intended_value: Option<u64>,
668 impl_writeable_tlv_based!(ClaimingPayment, {
669 (0, amount_msat, required),
670 (2, payment_purpose, required),
671 (4, receiver_node_id, required),
672 (5, htlcs, optional_vec),
673 (7, sender_intended_value, option),
676 struct ClaimablePayment {
677 purpose: events::PaymentPurpose,
678 onion_fields: Option<RecipientOnionFields>,
679 htlcs: Vec<ClaimableHTLC>,
682 /// Information about claimable or being-claimed payments
683 struct ClaimablePayments {
684 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
685 /// failed/claimed by the user.
687 /// Note that, no consistency guarantees are made about the channels given here actually
688 /// existing anymore by the time you go to read them!
690 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
691 /// we don't get a duplicate payment.
692 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
694 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
695 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
696 /// as an [`events::Event::PaymentClaimed`].
697 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
700 /// Events which we process internally but cannot be processed immediately at the generation site
701 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
702 /// running normally, and specifically must be processed before any other non-background
703 /// [`ChannelMonitorUpdate`]s are applied.
705 enum BackgroundEvent {
706 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
707 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
708 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
709 /// channel has been force-closed we do not need the counterparty node_id.
711 /// Note that any such events are lost on shutdown, so in general they must be updates which
712 /// are regenerated on startup.
713 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelId, ChannelMonitorUpdate)),
714 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
715 /// channel to continue normal operation.
717 /// In general this should be used rather than
718 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
719 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
720 /// error the other variant is acceptable.
722 /// Note that any such events are lost on shutdown, so in general they must be updates which
723 /// are regenerated on startup.
724 MonitorUpdateRegeneratedOnStartup {
725 counterparty_node_id: PublicKey,
726 funding_txo: OutPoint,
727 channel_id: ChannelId,
728 update: ChannelMonitorUpdate
730 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
731 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
733 MonitorUpdatesComplete {
734 counterparty_node_id: PublicKey,
735 channel_id: ChannelId,
740 pub(crate) enum MonitorUpdateCompletionAction {
741 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
742 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
743 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
744 /// event can be generated.
745 PaymentClaimed { payment_hash: PaymentHash },
746 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
747 /// operation of another channel.
749 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
750 /// from completing a monitor update which removes the payment preimage until the inbound edge
751 /// completes a monitor update containing the payment preimage. In that case, after the inbound
752 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
754 EmitEventAndFreeOtherChannel {
755 event: events::Event,
756 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, ChannelId, RAAMonitorUpdateBlockingAction)>,
758 /// Indicates we should immediately resume the operation of another channel, unless there is
759 /// some other reason why the channel is blocked. In practice this simply means immediately
760 /// removing the [`RAAMonitorUpdateBlockingAction`] provided from the blocking set.
762 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
763 /// from completing a monitor update which removes the payment preimage until the inbound edge
764 /// completes a monitor update containing the payment preimage. However, we use this variant
765 /// instead of [`Self::EmitEventAndFreeOtherChannel`] when we discover that the claim was in
766 /// fact duplicative and we simply want to resume the outbound edge channel immediately.
768 /// This variant should thus never be written to disk, as it is processed inline rather than
769 /// stored for later processing.
770 FreeOtherChannelImmediately {
771 downstream_counterparty_node_id: PublicKey,
772 downstream_funding_outpoint: OutPoint,
773 blocking_action: RAAMonitorUpdateBlockingAction,
774 downstream_channel_id: ChannelId,
778 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
779 (0, PaymentClaimed) => { (0, payment_hash, required) },
780 // Note that FreeOtherChannelImmediately should never be written - we were supposed to free
781 // *immediately*. However, for simplicity we implement read/write here.
782 (1, FreeOtherChannelImmediately) => {
783 (0, downstream_counterparty_node_id, required),
784 (2, downstream_funding_outpoint, required),
785 (4, blocking_action, required),
786 // Note that by the time we get past the required read above, downstream_funding_outpoint will be
787 // filled in, so we can safely unwrap it here.
788 (5, downstream_channel_id, (default_value, ChannelId::v1_from_funding_outpoint(downstream_funding_outpoint.0.unwrap()))),
790 (2, EmitEventAndFreeOtherChannel) => {
791 (0, event, upgradable_required),
792 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
793 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
794 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
795 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
796 // downgrades to prior versions.
797 (1, downstream_counterparty_and_funding_outpoint, option),
801 #[derive(Clone, Debug, PartialEq, Eq)]
802 pub(crate) enum EventCompletionAction {
803 ReleaseRAAChannelMonitorUpdate {
804 counterparty_node_id: PublicKey,
805 channel_funding_outpoint: OutPoint,
806 channel_id: ChannelId,
809 impl_writeable_tlv_based_enum!(EventCompletionAction,
810 (0, ReleaseRAAChannelMonitorUpdate) => {
811 (0, channel_funding_outpoint, required),
812 (2, counterparty_node_id, required),
813 // Note that by the time we get past the required read above, channel_funding_outpoint will be
814 // filled in, so we can safely unwrap it here.
815 (3, channel_id, (default_value, ChannelId::v1_from_funding_outpoint(channel_funding_outpoint.0.unwrap()))),
819 #[derive(Clone, PartialEq, Eq, Debug)]
820 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
821 /// the blocked action here. See enum variants for more info.
822 pub(crate) enum RAAMonitorUpdateBlockingAction {
823 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
824 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
826 ForwardedPaymentInboundClaim {
827 /// The upstream channel ID (i.e. the inbound edge).
828 channel_id: ChannelId,
829 /// The HTLC ID on the inbound edge.
834 impl RAAMonitorUpdateBlockingAction {
835 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
836 Self::ForwardedPaymentInboundClaim {
837 channel_id: prev_hop.channel_id,
838 htlc_id: prev_hop.htlc_id,
843 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
844 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
848 /// State we hold per-peer.
849 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
850 /// `channel_id` -> `ChannelPhase`
852 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
853 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
854 /// `temporary_channel_id` -> `InboundChannelRequest`.
856 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
857 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
858 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
859 /// the channel is rejected, then the entry is simply removed.
860 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
861 /// The latest `InitFeatures` we heard from the peer.
862 latest_features: InitFeatures,
863 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
864 /// for broadcast messages, where ordering isn't as strict).
865 pub(super) pending_msg_events: Vec<MessageSendEvent>,
866 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
867 /// user but which have not yet completed.
869 /// Note that the channel may no longer exist. For example if the channel was closed but we
870 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
871 /// for a missing channel.
872 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
873 /// Map from a specific channel to some action(s) that should be taken when all pending
874 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
876 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
877 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
878 /// channels with a peer this will just be one allocation and will amount to a linear list of
879 /// channels to walk, avoiding the whole hashing rigmarole.
881 /// Note that the channel may no longer exist. For example, if a channel was closed but we
882 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
883 /// for a missing channel. While a malicious peer could construct a second channel with the
884 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
885 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
886 /// duplicates do not occur, so such channels should fail without a monitor update completing.
887 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
888 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
889 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
890 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
891 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
892 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
893 /// The peer is currently connected (i.e. we've seen a
894 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
895 /// [`ChannelMessageHandler::peer_disconnected`].
899 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
900 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
901 /// If true is passed for `require_disconnected`, the function will return false if we haven't
902 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
903 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
904 if require_disconnected && self.is_connected {
907 !self.channel_by_id.iter().any(|(_, phase)|
908 matches!(phase, ChannelPhase::Funded(_) | ChannelPhase::UnfundedOutboundV1(_))
910 && self.monitor_update_blocked_actions.is_empty()
911 && self.in_flight_monitor_updates.is_empty()
914 // Returns a count of all channels we have with this peer, including unfunded channels.
915 fn total_channel_count(&self) -> usize {
916 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
919 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
920 fn has_channel(&self, channel_id: &ChannelId) -> bool {
921 self.channel_by_id.contains_key(channel_id) ||
922 self.inbound_channel_request_by_id.contains_key(channel_id)
926 /// A not-yet-accepted inbound (from counterparty) channel. Once
927 /// accepted, the parameters will be used to construct a channel.
928 pub(super) struct InboundChannelRequest {
929 /// The original OpenChannel message.
930 pub open_channel_msg: msgs::OpenChannel,
931 /// The number of ticks remaining before the request expires.
932 pub ticks_remaining: i32,
935 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
936 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
937 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
939 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
940 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
942 /// For users who don't want to bother doing their own payment preimage storage, we also store that
945 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
946 /// and instead encoding it in the payment secret.
947 struct PendingInboundPayment {
948 /// The payment secret that the sender must use for us to accept this payment
949 payment_secret: PaymentSecret,
950 /// Time at which this HTLC expires - blocks with a header time above this value will result in
951 /// this payment being removed.
953 /// Arbitrary identifier the user specifies (or not)
954 user_payment_id: u64,
955 // Other required attributes of the payment, optionally enforced:
956 payment_preimage: Option<PaymentPreimage>,
957 min_value_msat: Option<u64>,
960 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
961 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
962 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
963 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
964 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
965 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
966 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
967 /// of [`KeysManager`] and [`DefaultRouter`].
969 /// This is not exported to bindings users as type aliases aren't supported in most languages.
970 #[cfg(not(c_bindings))]
971 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
979 Arc<NetworkGraph<Arc<L>>>,
982 Arc<RwLock<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
983 ProbabilisticScoringFeeParameters,
984 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
989 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
990 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
991 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
992 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
993 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
994 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
995 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
996 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
997 /// of [`KeysManager`] and [`DefaultRouter`].
999 /// This is not exported to bindings users as type aliases aren't supported in most languages.
1000 #[cfg(not(c_bindings))]
1001 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
1010 &'f NetworkGraph<&'g L>,
1013 &'h RwLock<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
1014 ProbabilisticScoringFeeParameters,
1015 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
1020 /// A trivial trait which describes any [`ChannelManager`].
1022 /// This is not exported to bindings users as general cover traits aren't useful in other
1024 pub trait AChannelManager {
1025 /// A type implementing [`chain::Watch`].
1026 type Watch: chain::Watch<Self::Signer> + ?Sized;
1027 /// A type that may be dereferenced to [`Self::Watch`].
1028 type M: Deref<Target = Self::Watch>;
1029 /// A type implementing [`BroadcasterInterface`].
1030 type Broadcaster: BroadcasterInterface + ?Sized;
1031 /// A type that may be dereferenced to [`Self::Broadcaster`].
1032 type T: Deref<Target = Self::Broadcaster>;
1033 /// A type implementing [`EntropySource`].
1034 type EntropySource: EntropySource + ?Sized;
1035 /// A type that may be dereferenced to [`Self::EntropySource`].
1036 type ES: Deref<Target = Self::EntropySource>;
1037 /// A type implementing [`NodeSigner`].
1038 type NodeSigner: NodeSigner + ?Sized;
1039 /// A type that may be dereferenced to [`Self::NodeSigner`].
1040 type NS: Deref<Target = Self::NodeSigner>;
1041 /// A type implementing [`WriteableEcdsaChannelSigner`].
1042 type Signer: WriteableEcdsaChannelSigner + Sized;
1043 /// A type implementing [`SignerProvider`] for [`Self::Signer`].
1044 type SignerProvider: SignerProvider<EcdsaSigner= Self::Signer> + ?Sized;
1045 /// A type that may be dereferenced to [`Self::SignerProvider`].
1046 type SP: Deref<Target = Self::SignerProvider>;
1047 /// A type implementing [`FeeEstimator`].
1048 type FeeEstimator: FeeEstimator + ?Sized;
1049 /// A type that may be dereferenced to [`Self::FeeEstimator`].
1050 type F: Deref<Target = Self::FeeEstimator>;
1051 /// A type implementing [`Router`].
1052 type Router: Router + ?Sized;
1053 /// A type that may be dereferenced to [`Self::Router`].
1054 type R: Deref<Target = Self::Router>;
1055 /// A type implementing [`Logger`].
1056 type Logger: Logger + ?Sized;
1057 /// A type that may be dereferenced to [`Self::Logger`].
1058 type L: Deref<Target = Self::Logger>;
1059 /// Returns a reference to the actual [`ChannelManager`] object.
1060 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
1063 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
1064 for ChannelManager<M, T, ES, NS, SP, F, R, L>
1066 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
1067 T::Target: BroadcasterInterface,
1068 ES::Target: EntropySource,
1069 NS::Target: NodeSigner,
1070 SP::Target: SignerProvider,
1071 F::Target: FeeEstimator,
1075 type Watch = M::Target;
1077 type Broadcaster = T::Target;
1079 type EntropySource = ES::Target;
1081 type NodeSigner = NS::Target;
1083 type Signer = <SP::Target as SignerProvider>::EcdsaSigner;
1084 type SignerProvider = SP::Target;
1086 type FeeEstimator = F::Target;
1088 type Router = R::Target;
1090 type Logger = L::Target;
1092 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
1095 /// Manager which keeps track of a number of channels and sends messages to the appropriate
1096 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
1098 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
1099 /// to individual Channels.
1101 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
1102 /// all peers during write/read (though does not modify this instance, only the instance being
1103 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
1104 /// called [`funding_transaction_generated`] for outbound channels) being closed.
1106 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
1107 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST durably write each
1108 /// [`ChannelMonitorUpdate`] before returning from
1109 /// [`chain::Watch::watch_channel`]/[`update_channel`] or before completing async writes. With
1110 /// `ChannelManager`s, writing updates happens out-of-band (and will prevent any other
1111 /// `ChannelManager` operations from occurring during the serialization process). If the
1112 /// deserialized version is out-of-date compared to the [`ChannelMonitor`] passed by reference to
1113 /// [`read`], those channels will be force-closed based on the `ChannelMonitor` state and no funds
1114 /// will be lost (modulo on-chain transaction fees).
1116 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
1117 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
1118 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
1120 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
1121 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
1122 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
1123 /// offline for a full minute. In order to track this, you must call
1124 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
1126 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
1127 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
1128 /// not have a channel with being unable to connect to us or open new channels with us if we have
1129 /// many peers with unfunded channels.
1131 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
1132 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
1133 /// never limited. Please ensure you limit the count of such channels yourself.
1135 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
1136 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
1137 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
1138 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
1139 /// you're using lightning-net-tokio.
1141 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
1142 /// [`funding_created`]: msgs::FundingCreated
1143 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
1144 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
1145 /// [`update_channel`]: chain::Watch::update_channel
1146 /// [`ChannelUpdate`]: msgs::ChannelUpdate
1147 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
1148 /// [`read`]: ReadableArgs::read
1151 // The tree structure below illustrates the lock order requirements for the different locks of the
1152 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
1153 // and should then be taken in the order of the lowest to the highest level in the tree.
1154 // Note that locks on different branches shall not be taken at the same time, as doing so will
1155 // create a new lock order for those specific locks in the order they were taken.
1159 // `pending_offers_messages`
1161 // `total_consistency_lock`
1163 // |__`forward_htlcs`
1165 // | |__`pending_intercepted_htlcs`
1167 // |__`per_peer_state`
1169 // |__`pending_inbound_payments`
1171 // |__`claimable_payments`
1173 // |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
1177 // |__`outpoint_to_peer`
1179 // |__`short_to_chan_info`
1181 // |__`outbound_scid_aliases`
1185 // |__`pending_events`
1187 // |__`pending_background_events`
1189 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
1191 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
1192 T::Target: BroadcasterInterface,
1193 ES::Target: EntropySource,
1194 NS::Target: NodeSigner,
1195 SP::Target: SignerProvider,
1196 F::Target: FeeEstimator,
1200 default_configuration: UserConfig,
1201 chain_hash: ChainHash,
1202 fee_estimator: LowerBoundedFeeEstimator<F>,
1208 /// See `ChannelManager` struct-level documentation for lock order requirements.
1210 pub(super) best_block: RwLock<BestBlock>,
1212 best_block: RwLock<BestBlock>,
1213 secp_ctx: Secp256k1<secp256k1::All>,
1215 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1216 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1217 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1218 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1220 /// See `ChannelManager` struct-level documentation for lock order requirements.
1221 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1223 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1224 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1225 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1226 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1227 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1228 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1229 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1230 /// after reloading from disk while replaying blocks against ChannelMonitors.
1232 /// See `PendingOutboundPayment` documentation for more info.
1234 /// See `ChannelManager` struct-level documentation for lock order requirements.
1235 pending_outbound_payments: OutboundPayments,
1237 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1239 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1240 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1241 /// and via the classic SCID.
1243 /// Note that no consistency guarantees are made about the existence of a channel with the
1244 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1246 /// See `ChannelManager` struct-level documentation for lock order requirements.
1248 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1250 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1251 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1252 /// until the user tells us what we should do with them.
1254 /// See `ChannelManager` struct-level documentation for lock order requirements.
1255 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1257 /// The sets of payments which are claimable or currently being claimed. See
1258 /// [`ClaimablePayments`]' individual field docs for more info.
1260 /// See `ChannelManager` struct-level documentation for lock order requirements.
1261 claimable_payments: Mutex<ClaimablePayments>,
1263 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1264 /// and some closed channels which reached a usable state prior to being closed. This is used
1265 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1266 /// active channel list on load.
1268 /// See `ChannelManager` struct-level documentation for lock order requirements.
1269 outbound_scid_aliases: Mutex<HashSet<u64>>,
1271 /// Channel funding outpoint -> `counterparty_node_id`.
1273 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1274 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1275 /// the handling of the events.
1277 /// Note that no consistency guarantees are made about the existence of a peer with the
1278 /// `counterparty_node_id` in our other maps.
1281 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1282 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1283 /// would break backwards compatability.
1284 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1285 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1286 /// required to access the channel with the `counterparty_node_id`.
1288 /// See `ChannelManager` struct-level documentation for lock order requirements.
1290 outpoint_to_peer: Mutex<HashMap<OutPoint, PublicKey>>,
1292 pub(crate) outpoint_to_peer: Mutex<HashMap<OutPoint, PublicKey>>,
1294 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1296 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1297 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1298 /// confirmation depth.
1300 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1301 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1302 /// channel with the `channel_id` in our other maps.
1304 /// See `ChannelManager` struct-level documentation for lock order requirements.
1306 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1308 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1310 our_network_pubkey: PublicKey,
1312 inbound_payment_key: inbound_payment::ExpandedKey,
1314 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1315 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1316 /// we encrypt the namespace identifier using these bytes.
1318 /// [fake scids]: crate::util::scid_utils::fake_scid
1319 fake_scid_rand_bytes: [u8; 32],
1321 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1322 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1323 /// keeping additional state.
1324 probing_cookie_secret: [u8; 32],
1326 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1327 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1328 /// very far in the past, and can only ever be up to two hours in the future.
1329 highest_seen_timestamp: AtomicUsize,
1331 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1332 /// basis, as well as the peer's latest features.
1334 /// If we are connected to a peer we always at least have an entry here, even if no channels
1335 /// are currently open with that peer.
1337 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1338 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1341 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1343 /// See `ChannelManager` struct-level documentation for lock order requirements.
1344 #[cfg(not(any(test, feature = "_test_utils")))]
1345 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1346 #[cfg(any(test, feature = "_test_utils"))]
1347 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1349 /// The set of events which we need to give to the user to handle. In some cases an event may
1350 /// require some further action after the user handles it (currently only blocking a monitor
1351 /// update from being handed to the user to ensure the included changes to the channel state
1352 /// are handled by the user before they're persisted durably to disk). In that case, the second
1353 /// element in the tuple is set to `Some` with further details of the action.
1355 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1356 /// could be in the middle of being processed without the direct mutex held.
1358 /// See `ChannelManager` struct-level documentation for lock order requirements.
1359 #[cfg(not(any(test, feature = "_test_utils")))]
1360 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1361 #[cfg(any(test, feature = "_test_utils"))]
1362 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1364 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1365 pending_events_processor: AtomicBool,
1367 /// If we are running during init (either directly during the deserialization method or in
1368 /// block connection methods which run after deserialization but before normal operation) we
1369 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1370 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1371 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1373 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1375 /// See `ChannelManager` struct-level documentation for lock order requirements.
1377 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1378 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1379 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1380 /// Essentially just when we're serializing ourselves out.
1381 /// Taken first everywhere where we are making changes before any other locks.
1382 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1383 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1384 /// Notifier the lock contains sends out a notification when the lock is released.
1385 total_consistency_lock: RwLock<()>,
1386 /// Tracks the progress of channels going through batch funding by whether funding_signed was
1387 /// received and the monitor has been persisted.
1389 /// This information does not need to be persisted as funding nodes can forget
1390 /// unfunded channels upon disconnection.
1391 funding_batch_states: Mutex<BTreeMap<Txid, Vec<(ChannelId, PublicKey, bool)>>>,
1393 background_events_processed_since_startup: AtomicBool,
1395 event_persist_notifier: Notifier,
1396 needs_persist_flag: AtomicBool,
1398 pending_offers_messages: Mutex<Vec<PendingOnionMessage<OffersMessage>>>,
1402 signer_provider: SP,
1407 /// Chain-related parameters used to construct a new `ChannelManager`.
1409 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1410 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1411 /// are not needed when deserializing a previously constructed `ChannelManager`.
1412 #[derive(Clone, Copy, PartialEq)]
1413 pub struct ChainParameters {
1414 /// The network for determining the `chain_hash` in Lightning messages.
1415 pub network: Network,
1417 /// The hash and height of the latest block successfully connected.
1419 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1420 pub best_block: BestBlock,
1423 #[derive(Copy, Clone, PartialEq)]
1427 SkipPersistHandleEvents,
1428 SkipPersistNoEvents,
1431 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1432 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1433 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1434 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1435 /// sending the aforementioned notification (since the lock being released indicates that the
1436 /// updates are ready for persistence).
1438 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1439 /// notify or not based on whether relevant changes have been made, providing a closure to
1440 /// `optionally_notify` which returns a `NotifyOption`.
1441 struct PersistenceNotifierGuard<'a, F: FnMut() -> NotifyOption> {
1442 event_persist_notifier: &'a Notifier,
1443 needs_persist_flag: &'a AtomicBool,
1445 // We hold onto this result so the lock doesn't get released immediately.
1446 _read_guard: RwLockReadGuard<'a, ()>,
1449 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1450 /// Notifies any waiters and indicates that we need to persist, in addition to possibly having
1451 /// events to handle.
1453 /// This must always be called if the changes included a `ChannelMonitorUpdate`, as well as in
1454 /// other cases where losing the changes on restart may result in a force-close or otherwise
1456 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1457 Self::optionally_notify(cm, || -> NotifyOption { NotifyOption::DoPersist })
1460 fn optionally_notify<F: FnMut() -> NotifyOption, C: AChannelManager>(cm: &'a C, mut persist_check: F)
1461 -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1462 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1463 let force_notify = cm.get_cm().process_background_events();
1465 PersistenceNotifierGuard {
1466 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1467 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1468 should_persist: move || {
1469 // Pick the "most" action between `persist_check` and the background events
1470 // processing and return that.
1471 let notify = persist_check();
1472 match (notify, force_notify) {
1473 (NotifyOption::DoPersist, _) => NotifyOption::DoPersist,
1474 (_, NotifyOption::DoPersist) => NotifyOption::DoPersist,
1475 (NotifyOption::SkipPersistHandleEvents, _) => NotifyOption::SkipPersistHandleEvents,
1476 (_, NotifyOption::SkipPersistHandleEvents) => NotifyOption::SkipPersistHandleEvents,
1477 _ => NotifyOption::SkipPersistNoEvents,
1480 _read_guard: read_guard,
1484 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1485 /// [`ChannelManager::process_background_events`] MUST be called first (or
1486 /// [`Self::optionally_notify`] used).
1487 fn optionally_notify_skipping_background_events<F: Fn() -> NotifyOption, C: AChannelManager>
1488 (cm: &'a C, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1489 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1491 PersistenceNotifierGuard {
1492 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1493 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1494 should_persist: persist_check,
1495 _read_guard: read_guard,
1500 impl<'a, F: FnMut() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1501 fn drop(&mut self) {
1502 match (self.should_persist)() {
1503 NotifyOption::DoPersist => {
1504 self.needs_persist_flag.store(true, Ordering::Release);
1505 self.event_persist_notifier.notify()
1507 NotifyOption::SkipPersistHandleEvents =>
1508 self.event_persist_notifier.notify(),
1509 NotifyOption::SkipPersistNoEvents => {},
1514 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1515 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1517 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1519 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1520 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1521 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1522 /// the maximum required amount in lnd as of March 2021.
1523 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1525 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1526 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1528 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1530 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1531 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1532 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1533 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1534 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1535 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1536 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1537 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1538 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1539 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1540 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1541 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1542 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1544 /// Minimum CLTV difference between the current block height and received inbound payments.
1545 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1547 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1548 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1549 // a payment was being routed, so we add an extra block to be safe.
1550 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1552 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1553 // ie that if the next-hop peer fails the HTLC within
1554 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1555 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1556 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1557 // LATENCY_GRACE_PERIOD_BLOCKS.
1559 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;
1561 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1562 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1564 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1566 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1567 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1569 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1570 /// until we mark the channel disabled and gossip the update.
1571 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1573 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1574 /// we mark the channel enabled and gossip the update.
1575 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1577 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1578 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1579 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1580 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1582 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1583 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1584 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1586 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1587 /// many peers we reject new (inbound) connections.
1588 const MAX_NO_CHANNEL_PEERS: usize = 250;
1590 /// Information needed for constructing an invoice route hint for this channel.
1591 #[derive(Clone, Debug, PartialEq)]
1592 pub struct CounterpartyForwardingInfo {
1593 /// Base routing fee in millisatoshis.
1594 pub fee_base_msat: u32,
1595 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1596 pub fee_proportional_millionths: u32,
1597 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1598 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1599 /// `cltv_expiry_delta` for more details.
1600 pub cltv_expiry_delta: u16,
1603 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1604 /// to better separate parameters.
1605 #[derive(Clone, Debug, PartialEq)]
1606 pub struct ChannelCounterparty {
1607 /// The node_id of our counterparty
1608 pub node_id: PublicKey,
1609 /// The Features the channel counterparty provided upon last connection.
1610 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1611 /// many routing-relevant features are present in the init context.
1612 pub features: InitFeatures,
1613 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1614 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1615 /// claiming at least this value on chain.
1617 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1619 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1620 pub unspendable_punishment_reserve: u64,
1621 /// Information on the fees and requirements that the counterparty requires when forwarding
1622 /// payments to us through this channel.
1623 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1624 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1625 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1626 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1627 pub outbound_htlc_minimum_msat: Option<u64>,
1628 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1629 pub outbound_htlc_maximum_msat: Option<u64>,
1632 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1633 #[derive(Clone, Debug, PartialEq)]
1634 pub struct ChannelDetails {
1635 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1636 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1637 /// Note that this means this value is *not* persistent - it can change once during the
1638 /// lifetime of the channel.
1639 pub channel_id: ChannelId,
1640 /// Parameters which apply to our counterparty. See individual fields for more information.
1641 pub counterparty: ChannelCounterparty,
1642 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1643 /// our counterparty already.
1644 pub funding_txo: Option<OutPoint>,
1645 /// The features which this channel operates with. See individual features for more info.
1647 /// `None` until negotiation completes and the channel type is finalized.
1648 pub channel_type: Option<ChannelTypeFeatures>,
1649 /// The position of the funding transaction in the chain. None if the funding transaction has
1650 /// not yet been confirmed and the channel fully opened.
1652 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1653 /// payments instead of this. See [`get_inbound_payment_scid`].
1655 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1656 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1658 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1659 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1660 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1661 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1662 /// [`confirmations_required`]: Self::confirmations_required
1663 pub short_channel_id: Option<u64>,
1664 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1665 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1666 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1669 /// This will be `None` as long as the channel is not available for routing outbound payments.
1671 /// [`short_channel_id`]: Self::short_channel_id
1672 /// [`confirmations_required`]: Self::confirmations_required
1673 pub outbound_scid_alias: Option<u64>,
1674 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1675 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1676 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1677 /// when they see a payment to be routed to us.
1679 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1680 /// previous values for inbound payment forwarding.
1682 /// [`short_channel_id`]: Self::short_channel_id
1683 pub inbound_scid_alias: Option<u64>,
1684 /// The value, in satoshis, of this channel as appears in the funding output
1685 pub channel_value_satoshis: u64,
1686 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1687 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1688 /// this value on chain.
1690 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1692 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1694 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1695 pub unspendable_punishment_reserve: Option<u64>,
1696 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1697 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1698 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1699 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1700 /// serialized with LDK versions prior to 0.0.113.
1702 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1703 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1704 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1705 pub user_channel_id: u128,
1706 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1707 /// which is applied to commitment and HTLC transactions.
1709 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1710 pub feerate_sat_per_1000_weight: Option<u32>,
1711 /// Our total balance. This is the amount we would get if we close the channel.
1712 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1713 /// amount is not likely to be recoverable on close.
1715 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1716 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1717 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1718 /// This does not consider any on-chain fees.
1720 /// See also [`ChannelDetails::outbound_capacity_msat`]
1721 pub balance_msat: u64,
1722 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1723 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1724 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1725 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1727 /// See also [`ChannelDetails::balance_msat`]
1729 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1730 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1731 /// should be able to spend nearly this amount.
1732 pub outbound_capacity_msat: u64,
1733 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1734 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1735 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1736 /// to use a limit as close as possible to the HTLC limit we can currently send.
1738 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1739 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1740 pub next_outbound_htlc_limit_msat: u64,
1741 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1742 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1743 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1744 /// route which is valid.
1745 pub next_outbound_htlc_minimum_msat: u64,
1746 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1747 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1748 /// available for inclusion in new inbound HTLCs).
1749 /// Note that there are some corner cases not fully handled here, so the actual available
1750 /// inbound capacity may be slightly higher than this.
1752 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1753 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1754 /// However, our counterparty should be able to spend nearly this amount.
1755 pub inbound_capacity_msat: u64,
1756 /// The number of required confirmations on the funding transaction before the funding will be
1757 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1758 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1759 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1760 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1762 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1764 /// [`is_outbound`]: ChannelDetails::is_outbound
1765 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1766 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1767 pub confirmations_required: Option<u32>,
1768 /// The current number of confirmations on the funding transaction.
1770 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1771 pub confirmations: Option<u32>,
1772 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1773 /// until we can claim our funds after we force-close the channel. During this time our
1774 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1775 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1776 /// time to claim our non-HTLC-encumbered funds.
1778 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1779 pub force_close_spend_delay: Option<u16>,
1780 /// True if the channel was initiated (and thus funded) by us.
1781 pub is_outbound: bool,
1782 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1783 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1784 /// required confirmation count has been reached (and we were connected to the peer at some
1785 /// point after the funding transaction received enough confirmations). The required
1786 /// confirmation count is provided in [`confirmations_required`].
1788 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1789 pub is_channel_ready: bool,
1790 /// The stage of the channel's shutdown.
1791 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1792 pub channel_shutdown_state: Option<ChannelShutdownState>,
1793 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1794 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1796 /// This is a strict superset of `is_channel_ready`.
1797 pub is_usable: bool,
1798 /// True if this channel is (or will be) publicly-announced.
1799 pub is_public: bool,
1800 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1801 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1802 pub inbound_htlc_minimum_msat: Option<u64>,
1803 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1804 pub inbound_htlc_maximum_msat: Option<u64>,
1805 /// Set of configurable parameters that affect channel operation.
1807 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1808 pub config: Option<ChannelConfig>,
1809 /// Pending inbound HTLCs.
1811 /// This field is empty for objects serialized with LDK versions prior to 0.0.122.
1812 pub pending_inbound_htlcs: Vec<InboundHTLCDetails>,
1813 /// Pending outbound HTLCs.
1815 /// This field is empty for objects serialized with LDK versions prior to 0.0.122.
1816 pub pending_outbound_htlcs: Vec<OutboundHTLCDetails>,
1819 impl ChannelDetails {
1820 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1821 /// This should be used for providing invoice hints or in any other context where our
1822 /// counterparty will forward a payment to us.
1824 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1825 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1826 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1827 self.inbound_scid_alias.or(self.short_channel_id)
1830 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1831 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1832 /// we're sending or forwarding a payment outbound over this channel.
1834 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1835 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1836 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1837 self.short_channel_id.or(self.outbound_scid_alias)
1840 fn from_channel_context<SP: Deref, F: Deref>(
1841 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1842 fee_estimator: &LowerBoundedFeeEstimator<F>
1845 SP::Target: SignerProvider,
1846 F::Target: FeeEstimator
1848 let balance = context.get_available_balances(fee_estimator);
1849 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1850 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1852 channel_id: context.channel_id(),
1853 counterparty: ChannelCounterparty {
1854 node_id: context.get_counterparty_node_id(),
1855 features: latest_features,
1856 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1857 forwarding_info: context.counterparty_forwarding_info(),
1858 // Ensures that we have actually received the `htlc_minimum_msat` value
1859 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1860 // message (as they are always the first message from the counterparty).
1861 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1862 // default `0` value set by `Channel::new_outbound`.
1863 outbound_htlc_minimum_msat: if context.have_received_message() {
1864 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1865 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1867 funding_txo: context.get_funding_txo(),
1868 // Note that accept_channel (or open_channel) is always the first message, so
1869 // `have_received_message` indicates that type negotiation has completed.
1870 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1871 short_channel_id: context.get_short_channel_id(),
1872 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1873 inbound_scid_alias: context.latest_inbound_scid_alias(),
1874 channel_value_satoshis: context.get_value_satoshis(),
1875 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1876 unspendable_punishment_reserve: to_self_reserve_satoshis,
1877 balance_msat: balance.balance_msat,
1878 inbound_capacity_msat: balance.inbound_capacity_msat,
1879 outbound_capacity_msat: balance.outbound_capacity_msat,
1880 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1881 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1882 user_channel_id: context.get_user_id(),
1883 confirmations_required: context.minimum_depth(),
1884 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1885 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1886 is_outbound: context.is_outbound(),
1887 is_channel_ready: context.is_usable(),
1888 is_usable: context.is_live(),
1889 is_public: context.should_announce(),
1890 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1891 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1892 config: Some(context.config()),
1893 channel_shutdown_state: Some(context.shutdown_state()),
1894 pending_inbound_htlcs: context.get_pending_inbound_htlc_details(),
1895 pending_outbound_htlcs: context.get_pending_outbound_htlc_details(),
1900 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1901 /// Further information on the details of the channel shutdown.
1902 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1903 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1904 /// the channel will be removed shortly.
1905 /// Also note, that in normal operation, peers could disconnect at any of these states
1906 /// and require peer re-connection before making progress onto other states
1907 pub enum ChannelShutdownState {
1908 /// Channel has not sent or received a shutdown message.
1910 /// Local node has sent a shutdown message for this channel.
1912 /// Shutdown message exchanges have concluded and the channels are in the midst of
1913 /// resolving all existing open HTLCs before closing can continue.
1915 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1916 NegotiatingClosingFee,
1917 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1918 /// to drop the channel.
1922 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1923 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1924 #[derive(Debug, PartialEq)]
1925 pub enum RecentPaymentDetails {
1926 /// When an invoice was requested and thus a payment has not yet been sent.
1928 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1929 /// a payment and ensure idempotency in LDK.
1930 payment_id: PaymentId,
1932 /// When a payment is still being sent and awaiting successful delivery.
1934 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1935 /// a payment and ensure idempotency in LDK.
1936 payment_id: PaymentId,
1937 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1939 payment_hash: PaymentHash,
1940 /// Total amount (in msat, excluding fees) across all paths for this payment,
1941 /// not just the amount currently inflight.
1944 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1945 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1946 /// payment is removed from tracking.
1948 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1949 /// a payment and ensure idempotency in LDK.
1950 payment_id: PaymentId,
1951 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1952 /// made before LDK version 0.0.104.
1953 payment_hash: Option<PaymentHash>,
1955 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1956 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1957 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1959 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1960 /// a payment and ensure idempotency in LDK.
1961 payment_id: PaymentId,
1962 /// Hash of the payment that we have given up trying to send.
1963 payment_hash: PaymentHash,
1967 /// Route hints used in constructing invoices for [phantom node payents].
1969 /// [phantom node payments]: crate::sign::PhantomKeysManager
1971 pub struct PhantomRouteHints {
1972 /// The list of channels to be included in the invoice route hints.
1973 pub channels: Vec<ChannelDetails>,
1974 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1976 pub phantom_scid: u64,
1977 /// The pubkey of the real backing node that would ultimately receive the payment.
1978 pub real_node_pubkey: PublicKey,
1981 macro_rules! handle_error {
1982 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1983 // In testing, ensure there are no deadlocks where the lock is already held upon
1984 // entering the macro.
1985 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1986 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1990 Err(MsgHandleErrInternal { err, shutdown_finish, .. }) => {
1991 let mut msg_events = Vec::with_capacity(2);
1993 if let Some((shutdown_res, update_option)) = shutdown_finish {
1994 let counterparty_node_id = shutdown_res.counterparty_node_id;
1995 let channel_id = shutdown_res.channel_id;
1996 let logger = WithContext::from(
1997 &$self.logger, Some(counterparty_node_id), Some(channel_id),
1999 log_error!(logger, "Force-closing channel: {}", err.err);
2001 $self.finish_close_channel(shutdown_res);
2002 if let Some(update) = update_option {
2003 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2008 log_error!($self.logger, "Got non-closing error: {}", err.err);
2011 if let msgs::ErrorAction::IgnoreError = err.action {
2013 msg_events.push(events::MessageSendEvent::HandleError {
2014 node_id: $counterparty_node_id,
2015 action: err.action.clone()
2019 if !msg_events.is_empty() {
2020 let per_peer_state = $self.per_peer_state.read().unwrap();
2021 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
2022 let mut peer_state = peer_state_mutex.lock().unwrap();
2023 peer_state.pending_msg_events.append(&mut msg_events);
2027 // Return error in case higher-API need one
2034 macro_rules! update_maps_on_chan_removal {
2035 ($self: expr, $channel_context: expr) => {{
2036 if let Some(outpoint) = $channel_context.get_funding_txo() {
2037 $self.outpoint_to_peer.lock().unwrap().remove(&outpoint);
2039 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2040 if let Some(short_id) = $channel_context.get_short_channel_id() {
2041 short_to_chan_info.remove(&short_id);
2043 // If the channel was never confirmed on-chain prior to its closure, remove the
2044 // outbound SCID alias we used for it from the collision-prevention set. While we
2045 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
2046 // also don't want a counterparty to be able to trivially cause a memory leak by simply
2047 // opening a million channels with us which are closed before we ever reach the funding
2049 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
2050 debug_assert!(alias_removed);
2052 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
2056 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
2057 macro_rules! convert_chan_phase_err {
2058 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
2060 ChannelError::Warn(msg) => {
2061 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
2063 ChannelError::Ignore(msg) => {
2064 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
2066 ChannelError::Close(msg) => {
2067 let logger = WithChannelContext::from(&$self.logger, &$channel.context);
2068 log_error!(logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
2069 update_maps_on_chan_removal!($self, $channel.context);
2070 let reason = ClosureReason::ProcessingError { err: msg.clone() };
2071 let shutdown_res = $channel.context.force_shutdown(true, reason);
2073 MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $channel_update);
2078 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
2079 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
2081 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
2082 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
2084 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
2085 match $channel_phase {
2086 ChannelPhase::Funded(channel) => {
2087 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
2089 ChannelPhase::UnfundedOutboundV1(channel) => {
2090 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2092 ChannelPhase::UnfundedInboundV1(channel) => {
2093 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2099 macro_rules! break_chan_phase_entry {
2100 ($self: ident, $res: expr, $entry: expr) => {
2104 let key = *$entry.key();
2105 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2107 $entry.remove_entry();
2115 macro_rules! try_chan_phase_entry {
2116 ($self: ident, $res: expr, $entry: expr) => {
2120 let key = *$entry.key();
2121 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2123 $entry.remove_entry();
2131 macro_rules! remove_channel_phase {
2132 ($self: expr, $entry: expr) => {
2134 let channel = $entry.remove_entry().1;
2135 update_maps_on_chan_removal!($self, &channel.context());
2141 macro_rules! send_channel_ready {
2142 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
2143 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
2144 node_id: $channel.context.get_counterparty_node_id(),
2145 msg: $channel_ready_msg,
2147 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
2148 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
2149 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2150 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2151 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2152 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2153 if let Some(real_scid) = $channel.context.get_short_channel_id() {
2154 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2155 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2156 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2161 macro_rules! emit_channel_pending_event {
2162 ($locked_events: expr, $channel: expr) => {
2163 if $channel.context.should_emit_channel_pending_event() {
2164 $locked_events.push_back((events::Event::ChannelPending {
2165 channel_id: $channel.context.channel_id(),
2166 former_temporary_channel_id: $channel.context.temporary_channel_id(),
2167 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2168 user_channel_id: $channel.context.get_user_id(),
2169 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
2170 channel_type: Some($channel.context.get_channel_type().clone()),
2172 $channel.context.set_channel_pending_event_emitted();
2177 macro_rules! emit_channel_ready_event {
2178 ($locked_events: expr, $channel: expr) => {
2179 if $channel.context.should_emit_channel_ready_event() {
2180 debug_assert!($channel.context.channel_pending_event_emitted());
2181 $locked_events.push_back((events::Event::ChannelReady {
2182 channel_id: $channel.context.channel_id(),
2183 user_channel_id: $channel.context.get_user_id(),
2184 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2185 channel_type: $channel.context.get_channel_type().clone(),
2187 $channel.context.set_channel_ready_event_emitted();
2192 macro_rules! handle_monitor_update_completion {
2193 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2194 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2195 let mut updates = $chan.monitor_updating_restored(&&logger,
2196 &$self.node_signer, $self.chain_hash, &$self.default_configuration,
2197 $self.best_block.read().unwrap().height());
2198 let counterparty_node_id = $chan.context.get_counterparty_node_id();
2199 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
2200 // We only send a channel_update in the case where we are just now sending a
2201 // channel_ready and the channel is in a usable state. We may re-send a
2202 // channel_update later through the announcement_signatures process for public
2203 // channels, but there's no reason not to just inform our counterparty of our fees
2205 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
2206 Some(events::MessageSendEvent::SendChannelUpdate {
2207 node_id: counterparty_node_id,
2213 let update_actions = $peer_state.monitor_update_blocked_actions
2214 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
2216 let htlc_forwards = $self.handle_channel_resumption(
2217 &mut $peer_state.pending_msg_events, $chan, updates.raa,
2218 updates.commitment_update, updates.order, updates.accepted_htlcs,
2219 updates.funding_broadcastable, updates.channel_ready,
2220 updates.announcement_sigs);
2221 if let Some(upd) = channel_update {
2222 $peer_state.pending_msg_events.push(upd);
2225 let channel_id = $chan.context.channel_id();
2226 let unbroadcasted_batch_funding_txid = $chan.context.unbroadcasted_batch_funding_txid();
2227 core::mem::drop($peer_state_lock);
2228 core::mem::drop($per_peer_state_lock);
2230 // If the channel belongs to a batch funding transaction, the progress of the batch
2231 // should be updated as we have received funding_signed and persisted the monitor.
2232 if let Some(txid) = unbroadcasted_batch_funding_txid {
2233 let mut funding_batch_states = $self.funding_batch_states.lock().unwrap();
2234 let mut batch_completed = false;
2235 if let Some(batch_state) = funding_batch_states.get_mut(&txid) {
2236 let channel_state = batch_state.iter_mut().find(|(chan_id, pubkey, _)| (
2237 *chan_id == channel_id &&
2238 *pubkey == counterparty_node_id
2240 if let Some(channel_state) = channel_state {
2241 channel_state.2 = true;
2243 debug_assert!(false, "Missing channel batch state for channel which completed initial monitor update");
2245 batch_completed = batch_state.iter().all(|(_, _, completed)| *completed);
2247 debug_assert!(false, "Missing batch state for channel which completed initial monitor update");
2250 // When all channels in a batched funding transaction have become ready, it is not necessary
2251 // to track the progress of the batch anymore and the state of the channels can be updated.
2252 if batch_completed {
2253 let removed_batch_state = funding_batch_states.remove(&txid).into_iter().flatten();
2254 let per_peer_state = $self.per_peer_state.read().unwrap();
2255 let mut batch_funding_tx = None;
2256 for (channel_id, counterparty_node_id, _) in removed_batch_state {
2257 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2258 let mut peer_state = peer_state_mutex.lock().unwrap();
2259 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
2260 batch_funding_tx = batch_funding_tx.or_else(|| chan.context.unbroadcasted_funding());
2261 chan.set_batch_ready();
2262 let mut pending_events = $self.pending_events.lock().unwrap();
2263 emit_channel_pending_event!(pending_events, chan);
2267 if let Some(tx) = batch_funding_tx {
2268 log_info!($self.logger, "Broadcasting batch funding transaction with txid {}", tx.txid());
2269 $self.tx_broadcaster.broadcast_transactions(&[&tx]);
2274 $self.handle_monitor_update_completion_actions(update_actions);
2276 if let Some(forwards) = htlc_forwards {
2277 $self.forward_htlcs(&mut [forwards][..]);
2279 $self.finalize_claims(updates.finalized_claimed_htlcs);
2280 for failure in updates.failed_htlcs.drain(..) {
2281 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2282 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2287 macro_rules! handle_new_monitor_update {
2288 ($self: ident, $update_res: expr, $chan: expr, _internal, $completed: expr) => { {
2289 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2290 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2292 ChannelMonitorUpdateStatus::UnrecoverableError => {
2293 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
2294 log_error!(logger, "{}", err_str);
2295 panic!("{}", err_str);
2297 ChannelMonitorUpdateStatus::InProgress => {
2298 log_debug!(logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2299 &$chan.context.channel_id());
2302 ChannelMonitorUpdateStatus::Completed => {
2308 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, INITIAL_MONITOR) => {
2309 handle_new_monitor_update!($self, $update_res, $chan, _internal,
2310 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2312 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2313 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2314 .or_insert_with(Vec::new);
2315 // During startup, we push monitor updates as background events through to here in
2316 // order to replay updates that were in-flight when we shut down. Thus, we have to
2317 // filter for uniqueness here.
2318 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2319 .unwrap_or_else(|| {
2320 in_flight_updates.push($update);
2321 in_flight_updates.len() - 1
2323 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2324 handle_new_monitor_update!($self, update_res, $chan, _internal,
2326 let _ = in_flight_updates.remove(idx);
2327 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2328 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2334 macro_rules! process_events_body {
2335 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2336 let mut processed_all_events = false;
2337 while !processed_all_events {
2338 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2345 // We'll acquire our total consistency lock so that we can be sure no other
2346 // persists happen while processing monitor events.
2347 let _read_guard = $self.total_consistency_lock.read().unwrap();
2349 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2350 // ensure any startup-generated background events are handled first.
2351 result = $self.process_background_events();
2353 // TODO: This behavior should be documented. It's unintuitive that we query
2354 // ChannelMonitors when clearing other events.
2355 if $self.process_pending_monitor_events() {
2356 result = NotifyOption::DoPersist;
2360 let pending_events = $self.pending_events.lock().unwrap().clone();
2361 let num_events = pending_events.len();
2362 if !pending_events.is_empty() {
2363 result = NotifyOption::DoPersist;
2366 let mut post_event_actions = Vec::new();
2368 for (event, action_opt) in pending_events {
2369 $event_to_handle = event;
2371 if let Some(action) = action_opt {
2372 post_event_actions.push(action);
2377 let mut pending_events = $self.pending_events.lock().unwrap();
2378 pending_events.drain(..num_events);
2379 processed_all_events = pending_events.is_empty();
2380 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2381 // updated here with the `pending_events` lock acquired.
2382 $self.pending_events_processor.store(false, Ordering::Release);
2385 if !post_event_actions.is_empty() {
2386 $self.handle_post_event_actions(post_event_actions);
2387 // If we had some actions, go around again as we may have more events now
2388 processed_all_events = false;
2392 NotifyOption::DoPersist => {
2393 $self.needs_persist_flag.store(true, Ordering::Release);
2394 $self.event_persist_notifier.notify();
2396 NotifyOption::SkipPersistHandleEvents =>
2397 $self.event_persist_notifier.notify(),
2398 NotifyOption::SkipPersistNoEvents => {},
2404 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>
2406 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
2407 T::Target: BroadcasterInterface,
2408 ES::Target: EntropySource,
2409 NS::Target: NodeSigner,
2410 SP::Target: SignerProvider,
2411 F::Target: FeeEstimator,
2415 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2417 /// The current time or latest block header time can be provided as the `current_timestamp`.
2419 /// This is the main "logic hub" for all channel-related actions, and implements
2420 /// [`ChannelMessageHandler`].
2422 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2424 /// Users need to notify the new `ChannelManager` when a new block is connected or
2425 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2426 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2429 /// [`block_connected`]: chain::Listen::block_connected
2430 /// [`block_disconnected`]: chain::Listen::block_disconnected
2431 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2433 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2434 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2435 current_timestamp: u32,
2437 let mut secp_ctx = Secp256k1::new();
2438 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2439 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2440 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2442 default_configuration: config.clone(),
2443 chain_hash: ChainHash::using_genesis_block(params.network),
2444 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2449 best_block: RwLock::new(params.best_block),
2451 outbound_scid_aliases: Mutex::new(new_hash_set()),
2452 pending_inbound_payments: Mutex::new(new_hash_map()),
2453 pending_outbound_payments: OutboundPayments::new(),
2454 forward_htlcs: Mutex::new(new_hash_map()),
2455 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: new_hash_map(), pending_claiming_payments: new_hash_map() }),
2456 pending_intercepted_htlcs: Mutex::new(new_hash_map()),
2457 outpoint_to_peer: Mutex::new(new_hash_map()),
2458 short_to_chan_info: FairRwLock::new(new_hash_map()),
2460 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2463 inbound_payment_key: expanded_inbound_key,
2464 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2466 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2468 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2470 per_peer_state: FairRwLock::new(new_hash_map()),
2472 pending_events: Mutex::new(VecDeque::new()),
2473 pending_events_processor: AtomicBool::new(false),
2474 pending_background_events: Mutex::new(Vec::new()),
2475 total_consistency_lock: RwLock::new(()),
2476 background_events_processed_since_startup: AtomicBool::new(false),
2477 event_persist_notifier: Notifier::new(),
2478 needs_persist_flag: AtomicBool::new(false),
2479 funding_batch_states: Mutex::new(BTreeMap::new()),
2481 pending_offers_messages: Mutex::new(Vec::new()),
2491 /// Gets the current configuration applied to all new channels.
2492 pub fn get_current_default_configuration(&self) -> &UserConfig {
2493 &self.default_configuration
2496 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2497 let height = self.best_block.read().unwrap().height();
2498 let mut outbound_scid_alias = 0;
2501 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2502 outbound_scid_alias += 1;
2504 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2506 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2510 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"); }
2515 /// Creates a new outbound channel to the given remote node and with the given value.
2517 /// `user_channel_id` will be provided back as in
2518 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2519 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2520 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2521 /// is simply copied to events and otherwise ignored.
2523 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2524 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2526 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2527 /// generate a shutdown scriptpubkey or destination script set by
2528 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2530 /// Note that we do not check if you are currently connected to the given peer. If no
2531 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2532 /// the channel eventually being silently forgotten (dropped on reload).
2534 /// If `temporary_channel_id` is specified, it will be used as the temporary channel ID of the
2535 /// channel. Otherwise, a random one will be generated for you.
2537 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2538 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2539 /// [`ChannelDetails::channel_id`] until after
2540 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2541 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2542 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2544 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2545 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2546 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2547 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, temporary_channel_id: Option<ChannelId>, override_config: Option<UserConfig>) -> Result<ChannelId, APIError> {
2548 if channel_value_satoshis < 1000 {
2549 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2552 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2553 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2554 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2556 let per_peer_state = self.per_peer_state.read().unwrap();
2558 let peer_state_mutex = per_peer_state.get(&their_network_key)
2559 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2561 let mut peer_state = peer_state_mutex.lock().unwrap();
2563 if let Some(temporary_channel_id) = temporary_channel_id {
2564 if peer_state.channel_by_id.contains_key(&temporary_channel_id) {
2565 return Err(APIError::APIMisuseError{ err: format!("Channel with temporary channel ID {} already exists!", temporary_channel_id)});
2570 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2571 let their_features = &peer_state.latest_features;
2572 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2573 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2574 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2575 self.best_block.read().unwrap().height(), outbound_scid_alias, temporary_channel_id)
2579 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2584 let res = channel.get_open_channel(self.chain_hash);
2586 let temporary_channel_id = channel.context.channel_id();
2587 match peer_state.channel_by_id.entry(temporary_channel_id) {
2588 hash_map::Entry::Occupied(_) => {
2590 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2592 panic!("RNG is bad???");
2595 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2598 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2599 node_id: their_network_key,
2602 Ok(temporary_channel_id)
2605 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2606 // Allocate our best estimate of the number of channels we have in the `res`
2607 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2608 // a scid or a scid alias, and the `outpoint_to_peer` shouldn't be used outside
2609 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2610 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2611 // the same channel.
2612 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2614 let best_block_height = self.best_block.read().unwrap().height();
2615 let per_peer_state = self.per_peer_state.read().unwrap();
2616 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2617 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2618 let peer_state = &mut *peer_state_lock;
2619 res.extend(peer_state.channel_by_id.iter()
2620 .filter_map(|(chan_id, phase)| match phase {
2621 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2622 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2626 .map(|(_channel_id, channel)| {
2627 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2628 peer_state.latest_features.clone(), &self.fee_estimator)
2636 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2637 /// more information.
2638 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2639 // Allocate our best estimate of the number of channels we have in the `res`
2640 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2641 // a scid or a scid alias, and the `outpoint_to_peer` shouldn't be used outside
2642 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2643 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2644 // the same channel.
2645 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2647 let best_block_height = self.best_block.read().unwrap().height();
2648 let per_peer_state = self.per_peer_state.read().unwrap();
2649 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2650 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2651 let peer_state = &mut *peer_state_lock;
2652 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2653 let details = ChannelDetails::from_channel_context(context, best_block_height,
2654 peer_state.latest_features.clone(), &self.fee_estimator);
2662 /// Gets the list of usable channels, in random order. Useful as an argument to
2663 /// [`Router::find_route`] to ensure non-announced channels are used.
2665 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2666 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2668 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2669 // Note we use is_live here instead of usable which leads to somewhat confused
2670 // internal/external nomenclature, but that's ok cause that's probably what the user
2671 // really wanted anyway.
2672 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2675 /// Gets the list of channels we have with a given counterparty, in random order.
2676 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2677 let best_block_height = self.best_block.read().unwrap().height();
2678 let per_peer_state = self.per_peer_state.read().unwrap();
2680 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2681 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2682 let peer_state = &mut *peer_state_lock;
2683 let features = &peer_state.latest_features;
2684 let context_to_details = |context| {
2685 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2687 return peer_state.channel_by_id
2689 .map(|(_, phase)| phase.context())
2690 .map(context_to_details)
2696 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2697 /// successful path, or have unresolved HTLCs.
2699 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2700 /// result of a crash. If such a payment exists, is not listed here, and an
2701 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2703 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2704 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2705 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2706 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2707 PendingOutboundPayment::AwaitingInvoice { .. } => {
2708 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2710 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2711 PendingOutboundPayment::InvoiceReceived { .. } => {
2712 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2714 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2715 Some(RecentPaymentDetails::Pending {
2716 payment_id: *payment_id,
2717 payment_hash: *payment_hash,
2718 total_msat: *total_msat,
2721 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2722 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2724 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2725 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2727 PendingOutboundPayment::Legacy { .. } => None
2732 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> {
2733 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2735 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
2736 let mut shutdown_result = None;
2739 let per_peer_state = self.per_peer_state.read().unwrap();
2741 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2742 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2744 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2745 let peer_state = &mut *peer_state_lock;
2747 match peer_state.channel_by_id.entry(channel_id.clone()) {
2748 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2749 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2750 let funding_txo_opt = chan.context.get_funding_txo();
2751 let their_features = &peer_state.latest_features;
2752 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2753 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2754 failed_htlcs = htlcs;
2756 // We can send the `shutdown` message before updating the `ChannelMonitor`
2757 // here as we don't need the monitor update to complete until we send a
2758 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2759 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2760 node_id: *counterparty_node_id,
2764 debug_assert!(monitor_update_opt.is_none() || !chan.is_shutdown(),
2765 "We can't both complete shutdown and generate a monitor update");
2767 // Update the monitor with the shutdown script if necessary.
2768 if let Some(monitor_update) = monitor_update_opt.take() {
2769 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2770 peer_state_lock, peer_state, per_peer_state, chan);
2773 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2774 shutdown_result = Some(chan_phase.context_mut().force_shutdown(false, ClosureReason::HolderForceClosed));
2777 hash_map::Entry::Vacant(_) => {
2778 return Err(APIError::ChannelUnavailable {
2780 "Channel with id {} not found for the passed counterparty node_id {}",
2781 channel_id, counterparty_node_id,
2788 for htlc_source in failed_htlcs.drain(..) {
2789 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2790 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2791 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2794 if let Some(shutdown_result) = shutdown_result {
2795 self.finish_close_channel(shutdown_result);
2801 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2802 /// will be accepted on the given channel, and after additional timeout/the closing of all
2803 /// pending HTLCs, the channel will be closed on chain.
2805 /// * If we are the channel initiator, we will pay between our [`ChannelCloseMinimum`] and
2806 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2808 /// * If our counterparty is the channel initiator, we will require a channel closing
2809 /// transaction feerate of at least our [`ChannelCloseMinimum`] feerate or the feerate which
2810 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2811 /// counterparty to pay as much fee as they'd like, however.
2813 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2815 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2816 /// generate a shutdown scriptpubkey or destination script set by
2817 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2820 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2821 /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
2822 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2823 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2824 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2825 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2828 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2829 /// will be accepted on the given channel, and after additional timeout/the closing of all
2830 /// pending HTLCs, the channel will be closed on chain.
2832 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2833 /// the channel being closed or not:
2834 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2835 /// transaction. The upper-bound is set by
2836 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2837 /// fee estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2838 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2839 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2840 /// will appear on a force-closure transaction, whichever is lower).
2842 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2843 /// Will fail if a shutdown script has already been set for this channel by
2844 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2845 /// also be compatible with our and the counterparty's features.
2847 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2849 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2850 /// generate a shutdown scriptpubkey or destination script set by
2851 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2854 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2855 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2856 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2857 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> {
2858 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2861 fn finish_close_channel(&self, mut shutdown_res: ShutdownResult) {
2862 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
2863 #[cfg(debug_assertions)]
2864 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
2865 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
2868 let logger = WithContext::from(
2869 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
2872 log_debug!(logger, "Finishing closure of channel due to {} with {} HTLCs to fail",
2873 shutdown_res.closure_reason, shutdown_res.dropped_outbound_htlcs.len());
2874 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
2875 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2876 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2877 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2878 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2880 if let Some((_, funding_txo, _channel_id, monitor_update)) = shutdown_res.monitor_update {
2881 // There isn't anything we can do if we get an update failure - we're already
2882 // force-closing. The monitor update on the required in-memory copy should broadcast
2883 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2884 // ignore the result here.
2885 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2887 let mut shutdown_results = Vec::new();
2888 if let Some(txid) = shutdown_res.unbroadcasted_batch_funding_txid {
2889 let mut funding_batch_states = self.funding_batch_states.lock().unwrap();
2890 let affected_channels = funding_batch_states.remove(&txid).into_iter().flatten();
2891 let per_peer_state = self.per_peer_state.read().unwrap();
2892 let mut has_uncompleted_channel = None;
2893 for (channel_id, counterparty_node_id, state) in affected_channels {
2894 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2895 let mut peer_state = peer_state_mutex.lock().unwrap();
2896 if let Some(mut chan) = peer_state.channel_by_id.remove(&channel_id) {
2897 update_maps_on_chan_removal!(self, &chan.context());
2898 shutdown_results.push(chan.context_mut().force_shutdown(false, ClosureReason::FundingBatchClosure));
2901 has_uncompleted_channel = Some(has_uncompleted_channel.map_or(!state, |v| v || !state));
2904 has_uncompleted_channel.unwrap_or(true),
2905 "Closing a batch where all channels have completed initial monitor update",
2910 let mut pending_events = self.pending_events.lock().unwrap();
2911 pending_events.push_back((events::Event::ChannelClosed {
2912 channel_id: shutdown_res.channel_id,
2913 user_channel_id: shutdown_res.user_channel_id,
2914 reason: shutdown_res.closure_reason,
2915 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
2916 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
2917 channel_funding_txo: shutdown_res.channel_funding_txo,
2920 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
2921 pending_events.push_back((events::Event::DiscardFunding {
2922 channel_id: shutdown_res.channel_id, transaction
2926 for shutdown_result in shutdown_results.drain(..) {
2927 self.finish_close_channel(shutdown_result);
2931 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2932 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2933 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2934 -> Result<PublicKey, APIError> {
2935 let per_peer_state = self.per_peer_state.read().unwrap();
2936 let peer_state_mutex = per_peer_state.get(peer_node_id)
2937 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2938 let (update_opt, counterparty_node_id) = {
2939 let mut peer_state = peer_state_mutex.lock().unwrap();
2940 let closure_reason = if let Some(peer_msg) = peer_msg {
2941 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2943 ClosureReason::HolderForceClosed
2945 let logger = WithContext::from(&self.logger, Some(*peer_node_id), Some(*channel_id));
2946 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2947 log_error!(logger, "Force-closing channel {}", channel_id);
2948 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2949 mem::drop(peer_state);
2950 mem::drop(per_peer_state);
2952 ChannelPhase::Funded(mut chan) => {
2953 self.finish_close_channel(chan.context.force_shutdown(broadcast, closure_reason));
2954 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2956 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2957 self.finish_close_channel(chan_phase.context_mut().force_shutdown(false, closure_reason));
2958 // Unfunded channel has no update
2959 (None, chan_phase.context().get_counterparty_node_id())
2962 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2963 log_error!(logger, "Force-closing channel {}", &channel_id);
2964 // N.B. that we don't send any channel close event here: we
2965 // don't have a user_channel_id, and we never sent any opening
2967 (None, *peer_node_id)
2969 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2972 if let Some(update) = update_opt {
2973 // Try to send the `BroadcastChannelUpdate` to the peer we just force-closed on, but if
2974 // not try to broadcast it via whatever peer we have.
2975 let per_peer_state = self.per_peer_state.read().unwrap();
2976 let a_peer_state_opt = per_peer_state.get(peer_node_id)
2977 .ok_or(per_peer_state.values().next());
2978 if let Ok(a_peer_state_mutex) = a_peer_state_opt {
2979 let mut a_peer_state = a_peer_state_mutex.lock().unwrap();
2980 a_peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2986 Ok(counterparty_node_id)
2989 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2990 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2991 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2992 Ok(counterparty_node_id) => {
2993 let per_peer_state = self.per_peer_state.read().unwrap();
2994 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2995 let mut peer_state = peer_state_mutex.lock().unwrap();
2996 peer_state.pending_msg_events.push(
2997 events::MessageSendEvent::HandleError {
2998 node_id: counterparty_node_id,
2999 action: msgs::ErrorAction::DisconnectPeer {
3000 msg: Some(msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() })
3011 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
3012 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
3013 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
3015 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
3016 -> Result<(), APIError> {
3017 self.force_close_sending_error(channel_id, counterparty_node_id, true)
3020 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
3021 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
3022 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
3024 /// You can always broadcast the latest local transaction(s) via
3025 /// [`ChannelMonitor::broadcast_latest_holder_commitment_txn`].
3026 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
3027 -> Result<(), APIError> {
3028 self.force_close_sending_error(channel_id, counterparty_node_id, false)
3031 /// Force close all channels, immediately broadcasting the latest local commitment transaction
3032 /// for each to the chain and rejecting new HTLCs on each.
3033 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
3034 for chan in self.list_channels() {
3035 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
3039 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
3040 /// local transaction(s).
3041 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
3042 for chan in self.list_channels() {
3043 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
3047 fn decode_update_add_htlc_onion(
3048 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
3050 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
3052 let (next_hop, shared_secret, next_packet_details_opt) = decode_incoming_update_add_htlc_onion(
3053 msg, &self.node_signer, &self.logger, &self.secp_ctx
3056 let is_intro_node_forward = match next_hop {
3057 onion_utils::Hop::Forward {
3058 next_hop_data: msgs::InboundOnionPayload::BlindedForward {
3059 intro_node_blinding_point: Some(_), ..
3065 macro_rules! return_err {
3066 ($msg: expr, $err_code: expr, $data: expr) => {
3069 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
3070 "Failed to accept/forward incoming HTLC: {}", $msg
3072 // If `msg.blinding_point` is set, we must always fail with malformed.
3073 if msg.blinding_point.is_some() {
3074 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
3075 channel_id: msg.channel_id,
3076 htlc_id: msg.htlc_id,
3077 sha256_of_onion: [0; 32],
3078 failure_code: INVALID_ONION_BLINDING,
3082 let (err_code, err_data) = if is_intro_node_forward {
3083 (INVALID_ONION_BLINDING, &[0; 32][..])
3084 } else { ($err_code, $data) };
3085 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3086 channel_id: msg.channel_id,
3087 htlc_id: msg.htlc_id,
3088 reason: HTLCFailReason::reason(err_code, err_data.to_vec())
3089 .get_encrypted_failure_packet(&shared_secret, &None),
3095 let NextPacketDetails {
3096 next_packet_pubkey, outgoing_amt_msat, outgoing_scid, outgoing_cltv_value
3097 } = match next_packet_details_opt {
3098 Some(next_packet_details) => next_packet_details,
3099 // it is a receive, so no need for outbound checks
3100 None => return Ok((next_hop, shared_secret, None)),
3103 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
3104 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
3105 if let Some((err, mut code, chan_update)) = loop {
3106 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
3107 let forwarding_chan_info_opt = match id_option {
3108 None => { // unknown_next_peer
3109 // Note that this is likely a timing oracle for detecting whether an scid is a
3110 // phantom or an intercept.
3111 if (self.default_configuration.accept_intercept_htlcs &&
3112 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)) ||
3113 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)
3117 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3120 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
3122 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
3123 let per_peer_state = self.per_peer_state.read().unwrap();
3124 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3125 if peer_state_mutex_opt.is_none() {
3126 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3128 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3129 let peer_state = &mut *peer_state_lock;
3130 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
3131 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
3134 // Channel was removed. The short_to_chan_info and channel_by_id maps
3135 // have no consistency guarantees.
3136 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3140 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3141 // Note that the behavior here should be identical to the above block - we
3142 // should NOT reveal the existence or non-existence of a private channel if
3143 // we don't allow forwards outbound over them.
3144 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3146 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3147 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3148 // "refuse to forward unless the SCID alias was used", so we pretend
3149 // we don't have the channel here.
3150 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3152 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3154 // Note that we could technically not return an error yet here and just hope
3155 // that the connection is reestablished or monitor updated by the time we get
3156 // around to doing the actual forward, but better to fail early if we can and
3157 // hopefully an attacker trying to path-trace payments cannot make this occur
3158 // on a small/per-node/per-channel scale.
3159 if !chan.context.is_live() { // channel_disabled
3160 // If the channel_update we're going to return is disabled (i.e. the
3161 // peer has been disabled for some time), return `channel_disabled`,
3162 // otherwise return `temporary_channel_failure`.
3163 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3164 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3166 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3169 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3170 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3172 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3173 break Some((err, code, chan_update_opt));
3180 let cur_height = self.best_block.read().unwrap().height() + 1;
3182 if let Err((err_msg, code)) = check_incoming_htlc_cltv(
3183 cur_height, outgoing_cltv_value, msg.cltv_expiry
3185 if code & 0x1000 != 0 && chan_update_opt.is_none() {
3186 // We really should set `incorrect_cltv_expiry` here but as we're not
3187 // forwarding over a real channel we can't generate a channel_update
3188 // for it. Instead we just return a generic temporary_node_failure.
3189 break Some((err_msg, 0x2000 | 2, None))
3191 let chan_update_opt = if code & 0x1000 != 0 { chan_update_opt } else { None };
3192 break Some((err_msg, code, chan_update_opt));
3198 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3199 if let Some(chan_update) = chan_update {
3200 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3201 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3203 else if code == 0x1000 | 13 {
3204 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3206 else if code == 0x1000 | 20 {
3207 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3208 0u16.write(&mut res).expect("Writes cannot fail");
3210 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3211 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3212 chan_update.write(&mut res).expect("Writes cannot fail");
3213 } else if code & 0x1000 == 0x1000 {
3214 // If we're trying to return an error that requires a `channel_update` but
3215 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3216 // generate an update), just use the generic "temporary_node_failure"
3220 return_err!(err, code, &res.0[..]);
3222 Ok((next_hop, shared_secret, Some(next_packet_pubkey)))
3225 fn construct_pending_htlc_status<'a>(
3226 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
3227 decoded_hop: onion_utils::Hop, allow_underpay: bool,
3228 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
3229 ) -> PendingHTLCStatus {
3230 macro_rules! return_err {
3231 ($msg: expr, $err_code: expr, $data: expr) => {
3233 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
3234 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3235 if msg.blinding_point.is_some() {
3236 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(
3237 msgs::UpdateFailMalformedHTLC {
3238 channel_id: msg.channel_id,
3239 htlc_id: msg.htlc_id,
3240 sha256_of_onion: [0; 32],
3241 failure_code: INVALID_ONION_BLINDING,
3245 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3246 channel_id: msg.channel_id,
3247 htlc_id: msg.htlc_id,
3248 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3249 .get_encrypted_failure_packet(&shared_secret, &None),
3255 onion_utils::Hop::Receive(next_hop_data) => {
3257 let current_height: u32 = self.best_block.read().unwrap().height();
3258 match create_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3259 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat,
3260 current_height, self.default_configuration.accept_mpp_keysend)
3263 // Note that we could obviously respond immediately with an update_fulfill_htlc
3264 // message, however that would leak that we are the recipient of this payment, so
3265 // instead we stay symmetric with the forwarding case, only responding (after a
3266 // delay) once they've send us a commitment_signed!
3267 PendingHTLCStatus::Forward(info)
3269 Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3272 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3273 match create_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3274 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3275 Ok(info) => PendingHTLCStatus::Forward(info),
3276 Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3282 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3283 /// public, and thus should be called whenever the result is going to be passed out in a
3284 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3286 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3287 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3288 /// storage and the `peer_state` lock has been dropped.
3290 /// [`channel_update`]: msgs::ChannelUpdate
3291 /// [`internal_closing_signed`]: Self::internal_closing_signed
3292 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3293 if !chan.context.should_announce() {
3294 return Err(LightningError {
3295 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3296 action: msgs::ErrorAction::IgnoreError
3299 if chan.context.get_short_channel_id().is_none() {
3300 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3302 let logger = WithChannelContext::from(&self.logger, &chan.context);
3303 log_trace!(logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3304 self.get_channel_update_for_unicast(chan)
3307 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3308 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3309 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3310 /// provided evidence that they know about the existence of the channel.
3312 /// Note that through [`internal_closing_signed`], this function is called without the
3313 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3314 /// removed from the storage and the `peer_state` lock has been dropped.
3316 /// [`channel_update`]: msgs::ChannelUpdate
3317 /// [`internal_closing_signed`]: Self::internal_closing_signed
3318 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3319 let logger = WithChannelContext::from(&self.logger, &chan.context);
3320 log_trace!(logger, "Attempting to generate channel update for channel {}", chan.context.channel_id());
3321 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3322 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3326 self.get_channel_update_for_onion(short_channel_id, chan)
3329 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3330 let logger = WithChannelContext::from(&self.logger, &chan.context);
3331 log_trace!(logger, "Generating channel update for channel {}", chan.context.channel_id());
3332 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3334 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3335 ChannelUpdateStatus::Enabled => true,
3336 ChannelUpdateStatus::DisabledStaged(_) => true,
3337 ChannelUpdateStatus::Disabled => false,
3338 ChannelUpdateStatus::EnabledStaged(_) => false,
3341 let unsigned = msgs::UnsignedChannelUpdate {
3342 chain_hash: self.chain_hash,
3344 timestamp: chan.context.get_update_time_counter(),
3345 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3346 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3347 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3348 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3349 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3350 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3351 excess_data: Vec::new(),
3353 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3354 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3355 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3357 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3359 Ok(msgs::ChannelUpdate {
3366 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> {
3367 let _lck = self.total_consistency_lock.read().unwrap();
3368 self.send_payment_along_path(SendAlongPathArgs {
3369 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3374 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3375 let SendAlongPathArgs {
3376 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3379 // The top-level caller should hold the total_consistency_lock read lock.
3380 debug_assert!(self.total_consistency_lock.try_write().is_err());
3381 let prng_seed = self.entropy_source.get_secure_random_bytes();
3382 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3384 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
3385 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
3386 payment_hash, keysend_preimage, prng_seed
3388 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3389 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
3393 let err: Result<(), _> = loop {
3394 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3396 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3397 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
3398 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
3400 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3403 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
3405 "Attempting to send payment with payment hash {} along path with next hop {}",
3406 payment_hash, path.hops.first().unwrap().short_channel_id);
3408 let per_peer_state = self.per_peer_state.read().unwrap();
3409 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3410 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3411 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3412 let peer_state = &mut *peer_state_lock;
3413 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3414 match chan_phase_entry.get_mut() {
3415 ChannelPhase::Funded(chan) => {
3416 if !chan.context.is_live() {
3417 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3419 let funding_txo = chan.context.get_funding_txo().unwrap();
3420 let logger = WithChannelContext::from(&self.logger, &chan.context);
3421 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3422 htlc_cltv, HTLCSource::OutboundRoute {
3424 session_priv: session_priv.clone(),
3425 first_hop_htlc_msat: htlc_msat,
3427 }, onion_packet, None, &self.fee_estimator, &&logger);
3428 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3429 Some(monitor_update) => {
3430 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3432 // Note that MonitorUpdateInProgress here indicates (per function
3433 // docs) that we will resend the commitment update once monitor
3434 // updating completes. Therefore, we must return an error
3435 // indicating that it is unsafe to retry the payment wholesale,
3436 // which we do in the send_payment check for
3437 // MonitorUpdateInProgress, below.
3438 return Err(APIError::MonitorUpdateInProgress);
3446 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3449 // The channel was likely removed after we fetched the id from the
3450 // `short_to_chan_info` map, but before we successfully locked the
3451 // `channel_by_id` map.
3452 // This can occur as no consistency guarantees exists between the two maps.
3453 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3457 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3458 Ok(_) => unreachable!(),
3460 Err(APIError::ChannelUnavailable { err: e.err })
3465 /// Sends a payment along a given route.
3467 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3468 /// fields for more info.
3470 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3471 /// [`PeerManager::process_events`]).
3473 /// # Avoiding Duplicate Payments
3475 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3476 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3477 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3478 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3479 /// second payment with the same [`PaymentId`].
3481 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3482 /// tracking of payments, including state to indicate once a payment has completed. Because you
3483 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3484 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3485 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3487 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3488 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3489 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3490 /// [`ChannelManager::list_recent_payments`] for more information.
3492 /// # Possible Error States on [`PaymentSendFailure`]
3494 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3495 /// each entry matching the corresponding-index entry in the route paths, see
3496 /// [`PaymentSendFailure`] for more info.
3498 /// In general, a path may raise:
3499 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3500 /// node public key) is specified.
3501 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3502 /// closed, doesn't exist, or the peer is currently disconnected.
3503 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3504 /// relevant updates.
3506 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3507 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3508 /// different route unless you intend to pay twice!
3510 /// [`RouteHop`]: crate::routing::router::RouteHop
3511 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3512 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3513 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3514 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3515 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3516 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3517 let best_block_height = self.best_block.read().unwrap().height();
3518 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3519 self.pending_outbound_payments
3520 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3521 &self.entropy_source, &self.node_signer, best_block_height,
3522 |args| self.send_payment_along_path(args))
3525 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3526 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3527 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3528 let best_block_height = self.best_block.read().unwrap().height();
3529 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3530 self.pending_outbound_payments
3531 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3532 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3533 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3534 &self.pending_events, |args| self.send_payment_along_path(args))
3538 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> {
3539 let best_block_height = self.best_block.read().unwrap().height();
3540 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3541 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3542 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3543 best_block_height, |args| self.send_payment_along_path(args))
3547 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> {
3548 let best_block_height = self.best_block.read().unwrap().height();
3549 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3553 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3554 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3557 pub(super) fn send_payment_for_bolt12_invoice(&self, invoice: &Bolt12Invoice, payment_id: PaymentId) -> Result<(), Bolt12PaymentError> {
3558 let best_block_height = self.best_block.read().unwrap().height();
3559 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3560 self.pending_outbound_payments
3561 .send_payment_for_bolt12_invoice(
3562 invoice, payment_id, &self.router, self.list_usable_channels(),
3563 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer,
3564 best_block_height, &self.logger, &self.pending_events,
3565 |args| self.send_payment_along_path(args)
3569 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3570 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3571 /// retries are exhausted.
3573 /// # Event Generation
3575 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3576 /// as there are no remaining pending HTLCs for this payment.
3578 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3579 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3580 /// determine the ultimate status of a payment.
3582 /// # Requested Invoices
3584 /// In the case of paying a [`Bolt12Invoice`] via [`ChannelManager::pay_for_offer`], abandoning
3585 /// the payment prior to receiving the invoice will result in an [`Event::InvoiceRequestFailed`]
3586 /// and prevent any attempts at paying it once received. The other events may only be generated
3587 /// once the invoice has been received.
3589 /// # Restart Behavior
3591 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3592 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3593 /// [`Event::InvoiceRequestFailed`].
3595 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3596 pub fn abandon_payment(&self, payment_id: PaymentId) {
3597 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3598 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3601 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3602 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3603 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3604 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3605 /// never reach the recipient.
3607 /// See [`send_payment`] documentation for more details on the return value of this function
3608 /// and idempotency guarantees provided by the [`PaymentId`] key.
3610 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3611 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3613 /// [`send_payment`]: Self::send_payment
3614 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3615 let best_block_height = self.best_block.read().unwrap().height();
3616 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3617 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3618 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3619 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3622 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3623 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3625 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3628 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3629 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> {
3630 let best_block_height = self.best_block.read().unwrap().height();
3631 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3632 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3633 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3634 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3635 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3638 /// Send a payment that is probing the given route for liquidity. We calculate the
3639 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3640 /// us to easily discern them from real payments.
3641 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3642 let best_block_height = self.best_block.read().unwrap().height();
3643 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3644 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3645 &self.entropy_source, &self.node_signer, best_block_height,
3646 |args| self.send_payment_along_path(args))
3649 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3652 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3653 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3656 /// Sends payment probes over all paths of a route that would be used to pay the given
3657 /// amount to the given `node_id`.
3659 /// See [`ChannelManager::send_preflight_probes`] for more information.
3660 pub fn send_spontaneous_preflight_probes(
3661 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3662 liquidity_limit_multiplier: Option<u64>,
3663 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3664 let payment_params =
3665 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3667 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
3669 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3672 /// Sends payment probes over all paths of a route that would be used to pay a route found
3673 /// according to the given [`RouteParameters`].
3675 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3676 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3677 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3678 /// confirmation in a wallet UI.
3680 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3681 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3682 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3683 /// payment. To mitigate this issue, channels with available liquidity less than the required
3684 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3685 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3686 pub fn send_preflight_probes(
3687 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3688 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3689 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3691 let payer = self.get_our_node_id();
3692 let usable_channels = self.list_usable_channels();
3693 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3694 let inflight_htlcs = self.compute_inflight_htlcs();
3698 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3700 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3701 ProbeSendFailure::RouteNotFound
3704 let mut used_liquidity_map = hash_map_with_capacity(first_hops.len());
3706 let mut res = Vec::new();
3708 for mut path in route.paths {
3709 // If the last hop is probably an unannounced channel we refrain from probing all the
3710 // way through to the end and instead probe up to the second-to-last channel.
3711 while let Some(last_path_hop) = path.hops.last() {
3712 if last_path_hop.maybe_announced_channel {
3713 // We found a potentially announced last hop.
3716 // Drop the last hop, as it's likely unannounced.
3719 "Avoided sending payment probe all the way to last hop {} as it is likely unannounced.",
3720 last_path_hop.short_channel_id
3722 let final_value_msat = path.final_value_msat();
3724 if let Some(new_last) = path.hops.last_mut() {
3725 new_last.fee_msat += final_value_msat;
3730 if path.hops.len() < 2 {
3733 "Skipped sending payment probe over path with less than two hops."
3738 if let Some(first_path_hop) = path.hops.first() {
3739 if let Some(first_hop) = first_hops.iter().find(|h| {
3740 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3742 let path_value = path.final_value_msat() + path.fee_msat();
3743 let used_liquidity =
3744 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3746 if first_hop.next_outbound_htlc_limit_msat
3747 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3749 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3752 *used_liquidity += path_value;
3757 res.push(self.send_probe(path).map_err(|e| {
3758 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3759 ProbeSendFailure::SendingFailed(e)
3766 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3767 /// which checks the correctness of the funding transaction given the associated channel.
3768 fn funding_transaction_generated_intern<FundingOutput: FnMut(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3769 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, is_batch_funding: bool,
3770 mut find_funding_output: FundingOutput,
3771 ) -> Result<(), APIError> {
3772 let per_peer_state = self.per_peer_state.read().unwrap();
3773 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3774 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3776 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3777 let peer_state = &mut *peer_state_lock;
3779 let (mut chan, msg_opt) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3780 Some(ChannelPhase::UnfundedOutboundV1(mut chan)) => {
3781 funding_txo = find_funding_output(&chan, &funding_transaction)?;
3783 let logger = WithChannelContext::from(&self.logger, &chan.context);
3784 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, is_batch_funding, &&logger)
3785 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3786 let channel_id = chan.context.channel_id();
3787 let reason = ClosureReason::ProcessingError { err: msg.clone() };
3788 let shutdown_res = chan.context.force_shutdown(false, reason);
3789 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, None))
3790 } else { unreachable!(); });
3792 Ok(funding_msg) => (chan, funding_msg),
3793 Err((chan, err)) => {
3794 mem::drop(peer_state_lock);
3795 mem::drop(per_peer_state);
3796 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3797 return Err(APIError::ChannelUnavailable {
3798 err: "Signer refused to sign the initial commitment transaction".to_owned()
3804 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3805 return Err(APIError::APIMisuseError {
3807 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3808 temporary_channel_id, counterparty_node_id),
3811 None => return Err(APIError::ChannelUnavailable {err: format!(
3812 "Channel with id {} not found for the passed counterparty node_id {}",
3813 temporary_channel_id, counterparty_node_id),
3817 if let Some(msg) = msg_opt {
3818 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3819 node_id: chan.context.get_counterparty_node_id(),
3823 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3824 hash_map::Entry::Occupied(_) => {
3825 panic!("Generated duplicate funding txid?");
3827 hash_map::Entry::Vacant(e) => {
3828 let mut outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
3829 match outpoint_to_peer.entry(funding_txo) {
3830 hash_map::Entry::Vacant(e) => { e.insert(chan.context.get_counterparty_node_id()); },
3831 hash_map::Entry::Occupied(o) => {
3833 "An existing channel using outpoint {} is open with peer {}",
3834 funding_txo, o.get()
3836 mem::drop(outpoint_to_peer);
3837 mem::drop(peer_state_lock);
3838 mem::drop(per_peer_state);
3839 let reason = ClosureReason::ProcessingError { err: err.clone() };
3840 self.finish_close_channel(chan.context.force_shutdown(true, reason));
3841 return Err(APIError::ChannelUnavailable { err });
3844 e.insert(ChannelPhase::UnfundedOutboundV1(chan));
3851 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3852 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, false, |_, tx| {
3853 Ok(OutPoint { txid: tx.txid(), index: output_index })
3857 /// Call this upon creation of a funding transaction for the given channel.
3859 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3860 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3862 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3863 /// across the p2p network.
3865 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3866 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3868 /// May panic if the output found in the funding transaction is duplicative with some other
3869 /// channel (note that this should be trivially prevented by using unique funding transaction
3870 /// keys per-channel).
3872 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3873 /// counterparty's signature the funding transaction will automatically be broadcast via the
3874 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3876 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3877 /// not currently support replacing a funding transaction on an existing channel. Instead,
3878 /// create a new channel with a conflicting funding transaction.
3880 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3881 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3882 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3883 /// for more details.
3885 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3886 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3887 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3888 self.batch_funding_transaction_generated(&[(temporary_channel_id, counterparty_node_id)], funding_transaction)
3891 /// Call this upon creation of a batch funding transaction for the given channels.
3893 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
3894 /// each individual channel and transaction output.
3896 /// Do NOT broadcast the funding transaction yourself. This batch funding transaction
3897 /// will only be broadcast when we have safely received and persisted the counterparty's
3898 /// signature for each channel.
3900 /// If there is an error, all channels in the batch are to be considered closed.
3901 pub fn batch_funding_transaction_generated(&self, temporary_channels: &[(&ChannelId, &PublicKey)], funding_transaction: Transaction) -> Result<(), APIError> {
3902 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3903 let mut result = Ok(());
3905 if !funding_transaction.is_coin_base() {
3906 for inp in funding_transaction.input.iter() {
3907 if inp.witness.is_empty() {
3908 result = result.and(Err(APIError::APIMisuseError {
3909 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3914 if funding_transaction.output.len() > u16::max_value() as usize {
3915 result = result.and(Err(APIError::APIMisuseError {
3916 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3920 let height = self.best_block.read().unwrap().height();
3921 // Transactions are evaluated as final by network mempools if their locktime is strictly
3922 // lower than the next block height. However, the modules constituting our Lightning
3923 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3924 // module is ahead of LDK, only allow one more block of headroom.
3925 if !funding_transaction.input.iter().all(|input| input.sequence == Sequence::MAX) &&
3926 funding_transaction.lock_time.is_block_height() &&
3927 funding_transaction.lock_time.to_consensus_u32() > height + 1
3929 result = result.and(Err(APIError::APIMisuseError {
3930 err: "Funding transaction absolute timelock is non-final".to_owned()
3935 let txid = funding_transaction.txid();
3936 let is_batch_funding = temporary_channels.len() > 1;
3937 let mut funding_batch_states = if is_batch_funding {
3938 Some(self.funding_batch_states.lock().unwrap())
3942 let mut funding_batch_state = funding_batch_states.as_mut().and_then(|states| {
3943 match states.entry(txid) {
3944 btree_map::Entry::Occupied(_) => {
3945 result = result.clone().and(Err(APIError::APIMisuseError {
3946 err: "Batch funding transaction with the same txid already exists".to_owned()
3950 btree_map::Entry::Vacant(vacant) => Some(vacant.insert(Vec::new())),
3953 for &(temporary_channel_id, counterparty_node_id) in temporary_channels {
3954 result = result.and_then(|_| self.funding_transaction_generated_intern(
3955 temporary_channel_id,
3956 counterparty_node_id,
3957 funding_transaction.clone(),
3960 let mut output_index = None;
3961 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3962 for (idx, outp) in tx.output.iter().enumerate() {
3963 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3964 if output_index.is_some() {
3965 return Err(APIError::APIMisuseError {
3966 err: "Multiple outputs matched the expected script and value".to_owned()
3969 output_index = Some(idx as u16);
3972 if output_index.is_none() {
3973 return Err(APIError::APIMisuseError {
3974 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3977 let outpoint = OutPoint { txid: tx.txid(), index: output_index.unwrap() };
3978 if let Some(funding_batch_state) = funding_batch_state.as_mut() {
3979 // TODO(dual_funding): We only do batch funding for V1 channels at the moment, but we'll probably
3980 // need to fix this somehow to not rely on using the outpoint for the channel ID if we
3981 // want to support V2 batching here as well.
3982 funding_batch_state.push((ChannelId::v1_from_funding_outpoint(outpoint), *counterparty_node_id, false));
3988 if let Err(ref e) = result {
3989 // Remaining channels need to be removed on any error.
3990 let e = format!("Error in transaction funding: {:?}", e);
3991 let mut channels_to_remove = Vec::new();
3992 channels_to_remove.extend(funding_batch_states.as_mut()
3993 .and_then(|states| states.remove(&txid))
3994 .into_iter().flatten()
3995 .map(|(chan_id, node_id, _state)| (chan_id, node_id))
3997 channels_to_remove.extend(temporary_channels.iter()
3998 .map(|(&chan_id, &node_id)| (chan_id, node_id))
4000 let mut shutdown_results = Vec::new();
4002 let per_peer_state = self.per_peer_state.read().unwrap();
4003 for (channel_id, counterparty_node_id) in channels_to_remove {
4004 per_peer_state.get(&counterparty_node_id)
4005 .map(|peer_state_mutex| peer_state_mutex.lock().unwrap())
4006 .and_then(|mut peer_state| peer_state.channel_by_id.remove(&channel_id))
4008 update_maps_on_chan_removal!(self, &chan.context());
4009 let closure_reason = ClosureReason::ProcessingError { err: e.clone() };
4010 shutdown_results.push(chan.context_mut().force_shutdown(false, closure_reason));
4014 mem::drop(funding_batch_states);
4015 for shutdown_result in shutdown_results.drain(..) {
4016 self.finish_close_channel(shutdown_result);
4022 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
4024 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4025 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4026 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4027 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4029 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4030 /// `counterparty_node_id` is provided.
4032 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4033 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4035 /// If an error is returned, none of the updates should be considered applied.
4037 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4038 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4039 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4040 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4041 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4042 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4043 /// [`APIMisuseError`]: APIError::APIMisuseError
4044 pub fn update_partial_channel_config(
4045 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
4046 ) -> Result<(), APIError> {
4047 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
4048 return Err(APIError::APIMisuseError {
4049 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
4053 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4054 let per_peer_state = self.per_peer_state.read().unwrap();
4055 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4056 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4057 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4058 let peer_state = &mut *peer_state_lock;
4059 for channel_id in channel_ids {
4060 if !peer_state.has_channel(channel_id) {
4061 return Err(APIError::ChannelUnavailable {
4062 err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, counterparty_node_id),
4066 for channel_id in channel_ids {
4067 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
4068 let mut config = channel_phase.context().config();
4069 config.apply(config_update);
4070 if !channel_phase.context_mut().update_config(&config) {
4073 if let ChannelPhase::Funded(channel) = channel_phase {
4074 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
4075 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
4076 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
4077 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4078 node_id: channel.context.get_counterparty_node_id(),
4085 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
4086 debug_assert!(false);
4087 return Err(APIError::ChannelUnavailable {
4089 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
4090 channel_id, counterparty_node_id),
4097 /// Atomically updates the [`ChannelConfig`] for the given channels.
4099 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4100 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4101 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4102 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4104 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4105 /// `counterparty_node_id` is provided.
4107 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4108 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4110 /// If an error is returned, none of the updates should be considered applied.
4112 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4113 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4114 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4115 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4116 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4117 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4118 /// [`APIMisuseError`]: APIError::APIMisuseError
4119 pub fn update_channel_config(
4120 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
4121 ) -> Result<(), APIError> {
4122 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
4125 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
4126 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
4128 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
4129 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
4131 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
4132 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
4133 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
4134 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
4135 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
4137 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
4138 /// you from forwarding more than you received. See
4139 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
4142 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4145 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
4146 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4147 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
4148 // TODO: when we move to deciding the best outbound channel at forward time, only take
4149 // `next_node_id` and not `next_hop_channel_id`
4150 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> {
4151 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4153 let next_hop_scid = {
4154 let peer_state_lock = self.per_peer_state.read().unwrap();
4155 let peer_state_mutex = peer_state_lock.get(&next_node_id)
4156 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
4157 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4158 let peer_state = &mut *peer_state_lock;
4159 match peer_state.channel_by_id.get(next_hop_channel_id) {
4160 Some(ChannelPhase::Funded(chan)) => {
4161 if !chan.context.is_usable() {
4162 return Err(APIError::ChannelUnavailable {
4163 err: format!("Channel with id {} not fully established", next_hop_channel_id)
4166 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
4168 Some(_) => return Err(APIError::ChannelUnavailable {
4169 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
4170 next_hop_channel_id, next_node_id)
4173 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
4174 next_hop_channel_id, next_node_id);
4175 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
4176 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
4177 return Err(APIError::ChannelUnavailable {
4184 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4185 .ok_or_else(|| APIError::APIMisuseError {
4186 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4189 let routing = match payment.forward_info.routing {
4190 PendingHTLCRouting::Forward { onion_packet, blinded, .. } => {
4191 PendingHTLCRouting::Forward {
4192 onion_packet, blinded, short_channel_id: next_hop_scid
4195 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
4197 let skimmed_fee_msat =
4198 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
4199 let pending_htlc_info = PendingHTLCInfo {
4200 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
4201 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
4204 let mut per_source_pending_forward = [(
4205 payment.prev_short_channel_id,
4206 payment.prev_funding_outpoint,
4207 payment.prev_channel_id,
4208 payment.prev_user_channel_id,
4209 vec![(pending_htlc_info, payment.prev_htlc_id)]
4211 self.forward_htlcs(&mut per_source_pending_forward);
4215 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
4216 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
4218 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4221 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4222 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
4223 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4225 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4226 .ok_or_else(|| APIError::APIMisuseError {
4227 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4230 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
4231 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4232 short_channel_id: payment.prev_short_channel_id,
4233 user_channel_id: Some(payment.prev_user_channel_id),
4234 outpoint: payment.prev_funding_outpoint,
4235 channel_id: payment.prev_channel_id,
4236 htlc_id: payment.prev_htlc_id,
4237 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
4238 phantom_shared_secret: None,
4239 blinded_failure: payment.forward_info.routing.blinded_failure(),
4242 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
4243 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
4244 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
4245 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
4250 /// Processes HTLCs which are pending waiting on random forward delay.
4252 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
4253 /// Will likely generate further events.
4254 pub fn process_pending_htlc_forwards(&self) {
4255 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4257 let mut new_events = VecDeque::new();
4258 let mut failed_forwards = Vec::new();
4259 let mut phantom_receives: Vec<(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
4261 let mut forward_htlcs = new_hash_map();
4262 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
4264 for (short_chan_id, mut pending_forwards) in forward_htlcs {
4265 if short_chan_id != 0 {
4266 let mut forwarding_counterparty = None;
4267 macro_rules! forwarding_channel_not_found {
4269 for forward_info in pending_forwards.drain(..) {
4270 match forward_info {
4271 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4272 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4273 prev_user_channel_id, forward_info: PendingHTLCInfo {
4274 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
4275 outgoing_cltv_value, ..
4278 macro_rules! failure_handler {
4279 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
4280 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_channel_id));
4281 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
4283 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4284 short_channel_id: prev_short_channel_id,
4285 user_channel_id: Some(prev_user_channel_id),
4286 channel_id: prev_channel_id,
4287 outpoint: prev_funding_outpoint,
4288 htlc_id: prev_htlc_id,
4289 incoming_packet_shared_secret: incoming_shared_secret,
4290 phantom_shared_secret: $phantom_ss,
4291 blinded_failure: routing.blinded_failure(),
4294 let reason = if $next_hop_unknown {
4295 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
4297 HTLCDestination::FailedPayment{ payment_hash }
4300 failed_forwards.push((htlc_source, payment_hash,
4301 HTLCFailReason::reason($err_code, $err_data),
4307 macro_rules! fail_forward {
4308 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4310 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4314 macro_rules! failed_payment {
4315 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4317 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4321 if let PendingHTLCRouting::Forward { ref onion_packet, .. } = routing {
4322 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4323 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.chain_hash) {
4324 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4325 let next_hop = match onion_utils::decode_next_payment_hop(
4326 phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac,
4327 payment_hash, None, &self.node_signer
4330 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4331 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).to_byte_array();
4332 // In this scenario, the phantom would have sent us an
4333 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4334 // if it came from us (the second-to-last hop) but contains the sha256
4336 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4338 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4339 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4343 onion_utils::Hop::Receive(hop_data) => {
4344 let current_height: u32 = self.best_block.read().unwrap().height();
4345 match create_recv_pending_htlc_info(hop_data,
4346 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4347 outgoing_cltv_value, Some(phantom_shared_secret), false, None,
4348 current_height, self.default_configuration.accept_mpp_keysend)
4350 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4351 Err(InboundHTLCErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4357 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4360 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4363 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4364 // Channel went away before we could fail it. This implies
4365 // the channel is now on chain and our counterparty is
4366 // trying to broadcast the HTLC-Timeout, but that's their
4367 // problem, not ours.
4373 let chan_info_opt = self.short_to_chan_info.read().unwrap().get(&short_chan_id).cloned();
4374 let (counterparty_node_id, forward_chan_id) = match chan_info_opt {
4375 Some((cp_id, chan_id)) => (cp_id, chan_id),
4377 forwarding_channel_not_found!();
4381 forwarding_counterparty = Some(counterparty_node_id);
4382 let per_peer_state = self.per_peer_state.read().unwrap();
4383 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4384 if peer_state_mutex_opt.is_none() {
4385 forwarding_channel_not_found!();
4388 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4389 let peer_state = &mut *peer_state_lock;
4390 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4391 let logger = WithChannelContext::from(&self.logger, &chan.context);
4392 for forward_info in pending_forwards.drain(..) {
4393 let queue_fail_htlc_res = match forward_info {
4394 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4395 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4396 prev_user_channel_id, forward_info: PendingHTLCInfo {
4397 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4398 routing: PendingHTLCRouting::Forward {
4399 onion_packet, blinded, ..
4400 }, skimmed_fee_msat, ..
4403 log_trace!(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);
4404 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4405 short_channel_id: prev_short_channel_id,
4406 user_channel_id: Some(prev_user_channel_id),
4407 channel_id: prev_channel_id,
4408 outpoint: prev_funding_outpoint,
4409 htlc_id: prev_htlc_id,
4410 incoming_packet_shared_secret: incoming_shared_secret,
4411 // Phantom payments are only PendingHTLCRouting::Receive.
4412 phantom_shared_secret: None,
4413 blinded_failure: blinded.map(|b| b.failure),
4415 let next_blinding_point = blinded.and_then(|b| {
4416 let encrypted_tlvs_ss = self.node_signer.ecdh(
4417 Recipient::Node, &b.inbound_blinding_point, None
4418 ).unwrap().secret_bytes();
4419 onion_utils::next_hop_pubkey(
4420 &self.secp_ctx, b.inbound_blinding_point, &encrypted_tlvs_ss
4423 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4424 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4425 onion_packet, skimmed_fee_msat, next_blinding_point, &self.fee_estimator,
4428 if let ChannelError::Ignore(msg) = e {
4429 log_trace!(logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4431 panic!("Stated return value requirements in send_htlc() were not met");
4433 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4434 failed_forwards.push((htlc_source, payment_hash,
4435 HTLCFailReason::reason(failure_code, data),
4436 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4442 HTLCForwardInfo::AddHTLC { .. } => {
4443 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4445 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4446 log_trace!(logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4447 Some((chan.queue_fail_htlc(htlc_id, err_packet, &&logger), htlc_id))
4449 HTLCForwardInfo::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
4450 log_trace!(logger, "Failing malformed HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4451 let res = chan.queue_fail_malformed_htlc(
4452 htlc_id, failure_code, sha256_of_onion, &&logger
4454 Some((res, htlc_id))
4457 if let Some((queue_fail_htlc_res, htlc_id)) = queue_fail_htlc_res {
4458 if let Err(e) = queue_fail_htlc_res {
4459 if let ChannelError::Ignore(msg) = e {
4460 log_trace!(logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4462 panic!("Stated return value requirements in queue_fail_{{malformed_}}htlc() were not met");
4464 // fail-backs are best-effort, we probably already have one
4465 // pending, and if not that's OK, if not, the channel is on
4466 // the chain and sending the HTLC-Timeout is their problem.
4472 forwarding_channel_not_found!();
4476 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4477 match forward_info {
4478 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4479 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4480 prev_user_channel_id, forward_info: PendingHTLCInfo {
4481 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4482 skimmed_fee_msat, ..
4485 let blinded_failure = routing.blinded_failure();
4486 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4487 PendingHTLCRouting::Receive {
4488 payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret,
4489 custom_tlvs, requires_blinded_error: _
4491 let _legacy_hop_data = Some(payment_data.clone());
4492 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4493 payment_metadata, custom_tlvs };
4494 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4495 Some(payment_data), phantom_shared_secret, onion_fields)
4497 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4498 let onion_fields = RecipientOnionFields {
4499 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4503 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4504 payment_data, None, onion_fields)
4507 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4510 let claimable_htlc = ClaimableHTLC {
4511 prev_hop: HTLCPreviousHopData {
4512 short_channel_id: prev_short_channel_id,
4513 user_channel_id: Some(prev_user_channel_id),
4514 channel_id: prev_channel_id,
4515 outpoint: prev_funding_outpoint,
4516 htlc_id: prev_htlc_id,
4517 incoming_packet_shared_secret: incoming_shared_secret,
4518 phantom_shared_secret,
4521 // We differentiate the received value from the sender intended value
4522 // if possible so that we don't prematurely mark MPP payments complete
4523 // if routing nodes overpay
4524 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4525 sender_intended_value: outgoing_amt_msat,
4527 total_value_received: None,
4528 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4531 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4534 let mut committed_to_claimable = false;
4536 macro_rules! fail_htlc {
4537 ($htlc: expr, $payment_hash: expr) => {
4538 debug_assert!(!committed_to_claimable);
4539 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4540 htlc_msat_height_data.extend_from_slice(
4541 &self.best_block.read().unwrap().height().to_be_bytes(),
4543 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4544 short_channel_id: $htlc.prev_hop.short_channel_id,
4545 user_channel_id: $htlc.prev_hop.user_channel_id,
4546 channel_id: prev_channel_id,
4547 outpoint: prev_funding_outpoint,
4548 htlc_id: $htlc.prev_hop.htlc_id,
4549 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4550 phantom_shared_secret,
4553 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4554 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4556 continue 'next_forwardable_htlc;
4559 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4560 let mut receiver_node_id = self.our_network_pubkey;
4561 if phantom_shared_secret.is_some() {
4562 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4563 .expect("Failed to get node_id for phantom node recipient");
4566 macro_rules! check_total_value {
4567 ($purpose: expr) => {{
4568 let mut payment_claimable_generated = false;
4569 let is_keysend = match $purpose {
4570 events::PaymentPurpose::SpontaneousPayment(_) => true,
4571 events::PaymentPurpose::InvoicePayment { .. } => false,
4573 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4574 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4575 fail_htlc!(claimable_htlc, payment_hash);
4577 let ref mut claimable_payment = claimable_payments.claimable_payments
4578 .entry(payment_hash)
4579 // Note that if we insert here we MUST NOT fail_htlc!()
4580 .or_insert_with(|| {
4581 committed_to_claimable = true;
4583 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4586 if $purpose != claimable_payment.purpose {
4587 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4588 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));
4589 fail_htlc!(claimable_htlc, payment_hash);
4591 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4592 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);
4593 fail_htlc!(claimable_htlc, payment_hash);
4595 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4596 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4597 fail_htlc!(claimable_htlc, payment_hash);
4600 claimable_payment.onion_fields = Some(onion_fields);
4602 let ref mut htlcs = &mut claimable_payment.htlcs;
4603 let mut total_value = claimable_htlc.sender_intended_value;
4604 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4605 for htlc in htlcs.iter() {
4606 total_value += htlc.sender_intended_value;
4607 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4608 if htlc.total_msat != claimable_htlc.total_msat {
4609 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4610 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4611 total_value = msgs::MAX_VALUE_MSAT;
4613 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4615 // The condition determining whether an MPP is complete must
4616 // match exactly the condition used in `timer_tick_occurred`
4617 if total_value >= msgs::MAX_VALUE_MSAT {
4618 fail_htlc!(claimable_htlc, payment_hash);
4619 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4620 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4622 fail_htlc!(claimable_htlc, payment_hash);
4623 } else if total_value >= claimable_htlc.total_msat {
4624 #[allow(unused_assignments)] {
4625 committed_to_claimable = true;
4627 htlcs.push(claimable_htlc);
4628 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4629 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4630 let counterparty_skimmed_fee_msat = htlcs.iter()
4631 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4632 debug_assert!(total_value.saturating_sub(amount_msat) <=
4633 counterparty_skimmed_fee_msat);
4634 new_events.push_back((events::Event::PaymentClaimable {
4635 receiver_node_id: Some(receiver_node_id),
4639 counterparty_skimmed_fee_msat,
4640 via_channel_id: Some(prev_channel_id),
4641 via_user_channel_id: Some(prev_user_channel_id),
4642 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4643 onion_fields: claimable_payment.onion_fields.clone(),
4645 payment_claimable_generated = true;
4647 // Nothing to do - we haven't reached the total
4648 // payment value yet, wait until we receive more
4650 htlcs.push(claimable_htlc);
4651 #[allow(unused_assignments)] {
4652 committed_to_claimable = true;
4655 payment_claimable_generated
4659 // Check that the payment hash and secret are known. Note that we
4660 // MUST take care to handle the "unknown payment hash" and
4661 // "incorrect payment secret" cases here identically or we'd expose
4662 // that we are the ultimate recipient of the given payment hash.
4663 // Further, we must not expose whether we have any other HTLCs
4664 // associated with the same payment_hash pending or not.
4665 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4666 match payment_secrets.entry(payment_hash) {
4667 hash_map::Entry::Vacant(_) => {
4668 match claimable_htlc.onion_payload {
4669 OnionPayload::Invoice { .. } => {
4670 let payment_data = payment_data.unwrap();
4671 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) {
4672 Ok(result) => result,
4674 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4675 fail_htlc!(claimable_htlc, payment_hash);
4678 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4679 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4680 if (cltv_expiry as u64) < expected_min_expiry_height {
4681 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4682 &payment_hash, cltv_expiry, expected_min_expiry_height);
4683 fail_htlc!(claimable_htlc, payment_hash);
4686 let purpose = events::PaymentPurpose::InvoicePayment {
4687 payment_preimage: payment_preimage.clone(),
4688 payment_secret: payment_data.payment_secret,
4690 check_total_value!(purpose);
4692 OnionPayload::Spontaneous(preimage) => {
4693 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4694 check_total_value!(purpose);
4698 hash_map::Entry::Occupied(inbound_payment) => {
4699 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4700 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);
4701 fail_htlc!(claimable_htlc, payment_hash);
4703 let payment_data = payment_data.unwrap();
4704 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4705 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4706 fail_htlc!(claimable_htlc, payment_hash);
4707 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4708 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4709 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4710 fail_htlc!(claimable_htlc, payment_hash);
4712 let purpose = events::PaymentPurpose::InvoicePayment {
4713 payment_preimage: inbound_payment.get().payment_preimage,
4714 payment_secret: payment_data.payment_secret,
4716 let payment_claimable_generated = check_total_value!(purpose);
4717 if payment_claimable_generated {
4718 inbound_payment.remove_entry();
4724 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4725 panic!("Got pending fail of our own HTLC");
4733 let best_block_height = self.best_block.read().unwrap().height();
4734 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4735 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4736 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4738 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4739 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4741 self.forward_htlcs(&mut phantom_receives);
4743 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4744 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4745 // nice to do the work now if we can rather than while we're trying to get messages in the
4747 self.check_free_holding_cells();
4749 if new_events.is_empty() { return }
4750 let mut events = self.pending_events.lock().unwrap();
4751 events.append(&mut new_events);
4754 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4756 /// Expects the caller to have a total_consistency_lock read lock.
4757 fn process_background_events(&self) -> NotifyOption {
4758 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4760 self.background_events_processed_since_startup.store(true, Ordering::Release);
4762 let mut background_events = Vec::new();
4763 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4764 if background_events.is_empty() {
4765 return NotifyOption::SkipPersistNoEvents;
4768 for event in background_events.drain(..) {
4770 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, _channel_id, update)) => {
4771 // The channel has already been closed, so no use bothering to care about the
4772 // monitor updating completing.
4773 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4775 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, channel_id, update } => {
4776 let mut updated_chan = false;
4778 let per_peer_state = self.per_peer_state.read().unwrap();
4779 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4780 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4781 let peer_state = &mut *peer_state_lock;
4782 match peer_state.channel_by_id.entry(channel_id) {
4783 hash_map::Entry::Occupied(mut chan_phase) => {
4784 if let ChannelPhase::Funded(chan) = chan_phase.get_mut() {
4785 updated_chan = true;
4786 handle_new_monitor_update!(self, funding_txo, update.clone(),
4787 peer_state_lock, peer_state, per_peer_state, chan);
4789 debug_assert!(false, "We shouldn't have an update for a non-funded channel");
4792 hash_map::Entry::Vacant(_) => {},
4797 // TODO: Track this as in-flight even though the channel is closed.
4798 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4801 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4802 let per_peer_state = self.per_peer_state.read().unwrap();
4803 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4804 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4805 let peer_state = &mut *peer_state_lock;
4806 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4807 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4809 let update_actions = peer_state.monitor_update_blocked_actions
4810 .remove(&channel_id).unwrap_or(Vec::new());
4811 mem::drop(peer_state_lock);
4812 mem::drop(per_peer_state);
4813 self.handle_monitor_update_completion_actions(update_actions);
4819 NotifyOption::DoPersist
4822 #[cfg(any(test, feature = "_test_utils"))]
4823 /// Process background events, for functional testing
4824 pub fn test_process_background_events(&self) {
4825 let _lck = self.total_consistency_lock.read().unwrap();
4826 let _ = self.process_background_events();
4829 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4830 if !chan.context.is_outbound() { return NotifyOption::SkipPersistNoEvents; }
4832 let logger = WithChannelContext::from(&self.logger, &chan.context);
4834 // If the feerate has decreased by less than half, don't bother
4835 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4836 return NotifyOption::SkipPersistNoEvents;
4838 if !chan.context.is_live() {
4839 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {} as it cannot currently be updated (probably the peer is disconnected).",
4840 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4841 return NotifyOption::SkipPersistNoEvents;
4843 log_trace!(logger, "Channel {} qualifies for a feerate change from {} to {}.",
4844 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4846 chan.queue_update_fee(new_feerate, &self.fee_estimator, &&logger);
4847 NotifyOption::DoPersist
4851 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4852 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4853 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4854 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4855 pub fn maybe_update_chan_fees(&self) {
4856 PersistenceNotifierGuard::optionally_notify(self, || {
4857 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4859 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4860 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4862 let per_peer_state = self.per_peer_state.read().unwrap();
4863 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4864 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4865 let peer_state = &mut *peer_state_lock;
4866 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4867 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4869 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4874 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4875 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4883 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4885 /// This currently includes:
4886 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4887 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4888 /// than a minute, informing the network that they should no longer attempt to route over
4890 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4891 /// with the current [`ChannelConfig`].
4892 /// * Removing peers which have disconnected but and no longer have any channels.
4893 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4894 /// * Forgetting about stale outbound payments, either those that have already been fulfilled
4895 /// or those awaiting an invoice that hasn't been delivered in the necessary amount of time.
4896 /// The latter is determined using the system clock in `std` and the highest seen block time
4897 /// minus two hours in `no-std`.
4899 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4900 /// estimate fetches.
4902 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4903 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4904 pub fn timer_tick_occurred(&self) {
4905 PersistenceNotifierGuard::optionally_notify(self, || {
4906 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4908 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4909 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4911 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4912 let mut timed_out_mpp_htlcs = Vec::new();
4913 let mut pending_peers_awaiting_removal = Vec::new();
4914 let mut shutdown_channels = Vec::new();
4916 let mut process_unfunded_channel_tick = |
4917 chan_id: &ChannelId,
4918 context: &mut ChannelContext<SP>,
4919 unfunded_context: &mut UnfundedChannelContext,
4920 pending_msg_events: &mut Vec<MessageSendEvent>,
4921 counterparty_node_id: PublicKey,
4923 context.maybe_expire_prev_config();
4924 if unfunded_context.should_expire_unfunded_channel() {
4925 let logger = WithChannelContext::from(&self.logger, context);
4927 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4928 update_maps_on_chan_removal!(self, &context);
4929 shutdown_channels.push(context.force_shutdown(false, ClosureReason::HolderForceClosed));
4930 pending_msg_events.push(MessageSendEvent::HandleError {
4931 node_id: counterparty_node_id,
4932 action: msgs::ErrorAction::SendErrorMessage {
4933 msg: msgs::ErrorMessage {
4934 channel_id: *chan_id,
4935 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4946 let per_peer_state = self.per_peer_state.read().unwrap();
4947 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4948 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4949 let peer_state = &mut *peer_state_lock;
4950 let pending_msg_events = &mut peer_state.pending_msg_events;
4951 let counterparty_node_id = *counterparty_node_id;
4952 peer_state.channel_by_id.retain(|chan_id, phase| {
4954 ChannelPhase::Funded(chan) => {
4955 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4960 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4961 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4963 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4964 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4965 handle_errors.push((Err(err), counterparty_node_id));
4966 if needs_close { return false; }
4969 match chan.channel_update_status() {
4970 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4971 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4972 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4973 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4974 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4975 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4976 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4978 if n >= DISABLE_GOSSIP_TICKS {
4979 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4980 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4981 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4985 should_persist = NotifyOption::DoPersist;
4987 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4990 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4992 if n >= ENABLE_GOSSIP_TICKS {
4993 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4994 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4995 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4999 should_persist = NotifyOption::DoPersist;
5001 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
5007 chan.context.maybe_expire_prev_config();
5009 if chan.should_disconnect_peer_awaiting_response() {
5010 let logger = WithChannelContext::from(&self.logger, &chan.context);
5011 log_debug!(logger, "Disconnecting peer {} due to not making any progress on channel {}",
5012 counterparty_node_id, chan_id);
5013 pending_msg_events.push(MessageSendEvent::HandleError {
5014 node_id: counterparty_node_id,
5015 action: msgs::ErrorAction::DisconnectPeerWithWarning {
5016 msg: msgs::WarningMessage {
5017 channel_id: *chan_id,
5018 data: "Disconnecting due to timeout awaiting response".to_owned(),
5026 ChannelPhase::UnfundedInboundV1(chan) => {
5027 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
5028 pending_msg_events, counterparty_node_id)
5030 ChannelPhase::UnfundedOutboundV1(chan) => {
5031 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
5032 pending_msg_events, counterparty_node_id)
5037 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
5038 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
5039 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(*chan_id));
5040 log_error!(logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
5041 peer_state.pending_msg_events.push(
5042 events::MessageSendEvent::HandleError {
5043 node_id: counterparty_node_id,
5044 action: msgs::ErrorAction::SendErrorMessage {
5045 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
5051 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
5053 if peer_state.ok_to_remove(true) {
5054 pending_peers_awaiting_removal.push(counterparty_node_id);
5059 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
5060 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
5061 // of to that peer is later closed while still being disconnected (i.e. force closed),
5062 // we therefore need to remove the peer from `peer_state` separately.
5063 // To avoid having to take the `per_peer_state` `write` lock once the channels are
5064 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
5065 // negative effects on parallelism as much as possible.
5066 if pending_peers_awaiting_removal.len() > 0 {
5067 let mut per_peer_state = self.per_peer_state.write().unwrap();
5068 for counterparty_node_id in pending_peers_awaiting_removal {
5069 match per_peer_state.entry(counterparty_node_id) {
5070 hash_map::Entry::Occupied(entry) => {
5071 // Remove the entry if the peer is still disconnected and we still
5072 // have no channels to the peer.
5073 let remove_entry = {
5074 let peer_state = entry.get().lock().unwrap();
5075 peer_state.ok_to_remove(true)
5078 entry.remove_entry();
5081 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
5086 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
5087 if payment.htlcs.is_empty() {
5088 // This should be unreachable
5089 debug_assert!(false);
5092 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
5093 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
5094 // In this case we're not going to handle any timeouts of the parts here.
5095 // This condition determining whether the MPP is complete here must match
5096 // exactly the condition used in `process_pending_htlc_forwards`.
5097 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
5098 .fold(0, |total, htlc| total + htlc.sender_intended_value)
5101 } else if payment.htlcs.iter_mut().any(|htlc| {
5102 htlc.timer_ticks += 1;
5103 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
5105 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
5106 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
5113 for htlc_source in timed_out_mpp_htlcs.drain(..) {
5114 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
5115 let reason = HTLCFailReason::from_failure_code(23);
5116 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
5117 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
5120 for (err, counterparty_node_id) in handle_errors.drain(..) {
5121 let _ = handle_error!(self, err, counterparty_node_id);
5124 for shutdown_res in shutdown_channels {
5125 self.finish_close_channel(shutdown_res);
5128 #[cfg(feature = "std")]
5129 let duration_since_epoch = std::time::SystemTime::now()
5130 .duration_since(std::time::SystemTime::UNIX_EPOCH)
5131 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
5132 #[cfg(not(feature = "std"))]
5133 let duration_since_epoch = Duration::from_secs(
5134 self.highest_seen_timestamp.load(Ordering::Acquire).saturating_sub(7200) as u64
5137 self.pending_outbound_payments.remove_stale_payments(
5138 duration_since_epoch, &self.pending_events
5141 // Technically we don't need to do this here, but if we have holding cell entries in a
5142 // channel that need freeing, it's better to do that here and block a background task
5143 // than block the message queueing pipeline.
5144 if self.check_free_holding_cells() {
5145 should_persist = NotifyOption::DoPersist;
5152 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
5153 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
5154 /// along the path (including in our own channel on which we received it).
5156 /// Note that in some cases around unclean shutdown, it is possible the payment may have
5157 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
5158 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
5159 /// may have already been failed automatically by LDK if it was nearing its expiration time.
5161 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
5162 /// [`ChannelManager::claim_funds`]), you should still monitor for
5163 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
5164 /// startup during which time claims that were in-progress at shutdown may be replayed.
5165 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
5166 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
5169 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
5170 /// reason for the failure.
5172 /// See [`FailureCode`] for valid failure codes.
5173 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
5174 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5176 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
5177 if let Some(payment) = removed_source {
5178 for htlc in payment.htlcs {
5179 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
5180 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5181 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
5182 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5187 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
5188 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
5189 match failure_code {
5190 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
5191 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
5192 FailureCode::IncorrectOrUnknownPaymentDetails => {
5193 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5194 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5195 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
5197 FailureCode::InvalidOnionPayload(data) => {
5198 let fail_data = match data {
5199 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
5202 HTLCFailReason::reason(failure_code.into(), fail_data)
5207 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5208 /// that we want to return and a channel.
5210 /// This is for failures on the channel on which the HTLC was *received*, not failures
5212 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5213 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
5214 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
5215 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
5216 // an inbound SCID alias before the real SCID.
5217 let scid_pref = if chan.context.should_announce() {
5218 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
5220 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
5222 if let Some(scid) = scid_pref {
5223 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
5225 (0x4000|10, Vec::new())
5230 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5231 /// that we want to return and a channel.
5232 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5233 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
5234 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
5235 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
5236 if desired_err_code == 0x1000 | 20 {
5237 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
5238 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
5239 0u16.write(&mut enc).expect("Writes cannot fail");
5241 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
5242 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
5243 upd.write(&mut enc).expect("Writes cannot fail");
5244 (desired_err_code, enc.0)
5246 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
5247 // which means we really shouldn't have gotten a payment to be forwarded over this
5248 // channel yet, or if we did it's from a route hint. Either way, returning an error of
5249 // PERM|no_such_channel should be fine.
5250 (0x4000|10, Vec::new())
5254 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
5255 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
5256 // be surfaced to the user.
5257 fn fail_holding_cell_htlcs(
5258 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
5259 counterparty_node_id: &PublicKey
5261 let (failure_code, onion_failure_data) = {
5262 let per_peer_state = self.per_peer_state.read().unwrap();
5263 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5264 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5265 let peer_state = &mut *peer_state_lock;
5266 match peer_state.channel_by_id.entry(channel_id) {
5267 hash_map::Entry::Occupied(chan_phase_entry) => {
5268 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
5269 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
5271 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
5272 debug_assert!(false);
5273 (0x4000|10, Vec::new())
5276 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
5278 } else { (0x4000|10, Vec::new()) }
5281 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
5282 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
5283 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
5284 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
5288 /// Fails an HTLC backwards to the sender of it to us.
5289 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
5290 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
5291 // Ensure that no peer state channel storage lock is held when calling this function.
5292 // This ensures that future code doesn't introduce a lock-order requirement for
5293 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
5294 // this function with any `per_peer_state` peer lock acquired would.
5295 #[cfg(debug_assertions)]
5296 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
5297 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
5300 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
5301 //identify whether we sent it or not based on the (I presume) very different runtime
5302 //between the branches here. We should make this async and move it into the forward HTLCs
5305 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5306 // from block_connected which may run during initialization prior to the chain_monitor
5307 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
5309 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
5310 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
5311 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
5312 &self.pending_events, &self.logger)
5313 { self.push_pending_forwards_ev(); }
5315 HTLCSource::PreviousHopData(HTLCPreviousHopData {
5316 ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret,
5317 ref phantom_shared_secret, outpoint: _, ref blinded_failure, ref channel_id, ..
5320 WithContext::from(&self.logger, None, Some(*channel_id)),
5321 "Failing {}HTLC with payment_hash {} backwards from us: {:?}",
5322 if blinded_failure.is_some() { "blinded " } else { "" }, &payment_hash, onion_error
5324 let failure = match blinded_failure {
5325 Some(BlindedFailure::FromIntroductionNode) => {
5326 let blinded_onion_error = HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32]);
5327 let err_packet = blinded_onion_error.get_encrypted_failure_packet(
5328 incoming_packet_shared_secret, phantom_shared_secret
5330 HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }
5332 Some(BlindedFailure::FromBlindedNode) => {
5333 HTLCForwardInfo::FailMalformedHTLC {
5335 failure_code: INVALID_ONION_BLINDING,
5336 sha256_of_onion: [0; 32]
5340 let err_packet = onion_error.get_encrypted_failure_packet(
5341 incoming_packet_shared_secret, phantom_shared_secret
5343 HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }
5347 let mut push_forward_ev = false;
5348 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5349 if forward_htlcs.is_empty() {
5350 push_forward_ev = true;
5352 match forward_htlcs.entry(*short_channel_id) {
5353 hash_map::Entry::Occupied(mut entry) => {
5354 entry.get_mut().push(failure);
5356 hash_map::Entry::Vacant(entry) => {
5357 entry.insert(vec!(failure));
5360 mem::drop(forward_htlcs);
5361 if push_forward_ev { self.push_pending_forwards_ev(); }
5362 let mut pending_events = self.pending_events.lock().unwrap();
5363 pending_events.push_back((events::Event::HTLCHandlingFailed {
5364 prev_channel_id: *channel_id,
5365 failed_next_destination: destination,
5371 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
5372 /// [`MessageSendEvent`]s needed to claim the payment.
5374 /// This method is guaranteed to ensure the payment has been claimed but only if the current
5375 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
5376 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
5377 /// successful. It will generally be available in the next [`process_pending_events`] call.
5379 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
5380 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
5381 /// event matches your expectation. If you fail to do so and call this method, you may provide
5382 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5384 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5385 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5386 /// [`claim_funds_with_known_custom_tlvs`].
5388 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5389 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5390 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5391 /// [`process_pending_events`]: EventsProvider::process_pending_events
5392 /// [`create_inbound_payment`]: Self::create_inbound_payment
5393 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5394 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5395 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5396 self.claim_payment_internal(payment_preimage, false);
5399 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5400 /// even type numbers.
5404 /// You MUST check you've understood all even TLVs before using this to
5405 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5407 /// [`claim_funds`]: Self::claim_funds
5408 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5409 self.claim_payment_internal(payment_preimage, true);
5412 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5413 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).to_byte_array());
5415 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5418 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5419 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5420 let mut receiver_node_id = self.our_network_pubkey;
5421 for htlc in payment.htlcs.iter() {
5422 if htlc.prev_hop.phantom_shared_secret.is_some() {
5423 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5424 .expect("Failed to get node_id for phantom node recipient");
5425 receiver_node_id = phantom_pubkey;
5430 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5431 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5432 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5433 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5434 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5436 if dup_purpose.is_some() {
5437 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5438 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5442 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5443 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5444 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5445 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5446 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5447 mem::drop(claimable_payments);
5448 for htlc in payment.htlcs {
5449 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5450 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5451 let receiver = HTLCDestination::FailedPayment { payment_hash };
5452 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5461 debug_assert!(!sources.is_empty());
5463 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5464 // and when we got here we need to check that the amount we're about to claim matches the
5465 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5466 // the MPP parts all have the same `total_msat`.
5467 let mut claimable_amt_msat = 0;
5468 let mut prev_total_msat = None;
5469 let mut expected_amt_msat = None;
5470 let mut valid_mpp = true;
5471 let mut errs = Vec::new();
5472 let per_peer_state = self.per_peer_state.read().unwrap();
5473 for htlc in sources.iter() {
5474 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5475 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5476 debug_assert!(false);
5480 prev_total_msat = Some(htlc.total_msat);
5482 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5483 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5484 debug_assert!(false);
5488 expected_amt_msat = htlc.total_value_received;
5489 claimable_amt_msat += htlc.value;
5491 mem::drop(per_peer_state);
5492 if sources.is_empty() || expected_amt_msat.is_none() {
5493 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5494 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5497 if claimable_amt_msat != expected_amt_msat.unwrap() {
5498 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5499 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5500 expected_amt_msat.unwrap(), claimable_amt_msat);
5504 for htlc in sources.drain(..) {
5505 let prev_hop_chan_id = htlc.prev_hop.channel_id;
5506 if let Err((pk, err)) = self.claim_funds_from_hop(
5507 htlc.prev_hop, payment_preimage,
5508 |_, definitely_duplicate| {
5509 debug_assert!(!definitely_duplicate, "We shouldn't claim duplicatively from a payment");
5510 Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash })
5513 if let msgs::ErrorAction::IgnoreError = err.err.action {
5514 // We got a temporary failure updating monitor, but will claim the
5515 // HTLC when the monitor updating is restored (or on chain).
5516 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
5517 log_error!(logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5518 } else { errs.push((pk, err)); }
5523 for htlc in sources.drain(..) {
5524 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5525 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5526 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5527 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5528 let receiver = HTLCDestination::FailedPayment { payment_hash };
5529 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5531 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5534 // Now we can handle any errors which were generated.
5535 for (counterparty_node_id, err) in errs.drain(..) {
5536 let res: Result<(), _> = Err(err);
5537 let _ = handle_error!(self, res, counterparty_node_id);
5541 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>, bool) -> Option<MonitorUpdateCompletionAction>>(&self,
5542 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5543 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5544 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5546 // If we haven't yet run background events assume we're still deserializing and shouldn't
5547 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5548 // `BackgroundEvent`s.
5549 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5551 // As we may call handle_monitor_update_completion_actions in rather rare cases, check that
5552 // the required mutexes are not held before we start.
5553 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5554 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5557 let per_peer_state = self.per_peer_state.read().unwrap();
5558 let chan_id = prev_hop.channel_id;
5559 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5560 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5564 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5565 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5566 .map(|peer_mutex| peer_mutex.lock().unwrap())
5569 if peer_state_opt.is_some() {
5570 let mut peer_state_lock = peer_state_opt.unwrap();
5571 let peer_state = &mut *peer_state_lock;
5572 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5573 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5574 let counterparty_node_id = chan.context.get_counterparty_node_id();
5575 let logger = WithChannelContext::from(&self.logger, &chan.context);
5576 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &&logger);
5579 UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } => {
5580 if let Some(action) = completion_action(Some(htlc_value_msat), false) {
5581 log_trace!(logger, "Tracking monitor update completion action for channel {}: {:?}",
5583 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5586 handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5587 peer_state, per_peer_state, chan);
5589 // If we're running during init we cannot update a monitor directly -
5590 // they probably haven't actually been loaded yet. Instead, push the
5591 // monitor update as a background event.
5592 self.pending_background_events.lock().unwrap().push(
5593 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5594 counterparty_node_id,
5595 funding_txo: prev_hop.outpoint,
5596 channel_id: prev_hop.channel_id,
5597 update: monitor_update.clone(),
5601 UpdateFulfillCommitFetch::DuplicateClaim {} => {
5602 let action = if let Some(action) = completion_action(None, true) {
5607 mem::drop(peer_state_lock);
5609 log_trace!(logger, "Completing monitor update completion action for channel {} as claim was redundant: {:?}",
5611 let (node_id, _funding_outpoint, channel_id, blocker) =
5612 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5613 downstream_counterparty_node_id: node_id,
5614 downstream_funding_outpoint: funding_outpoint,
5615 blocking_action: blocker, downstream_channel_id: channel_id,
5617 (node_id, funding_outpoint, channel_id, blocker)
5619 debug_assert!(false,
5620 "Duplicate claims should always free another channel immediately");
5623 if let Some(peer_state_mtx) = per_peer_state.get(&node_id) {
5624 let mut peer_state = peer_state_mtx.lock().unwrap();
5625 if let Some(blockers) = peer_state
5626 .actions_blocking_raa_monitor_updates
5627 .get_mut(&channel_id)
5629 let mut found_blocker = false;
5630 blockers.retain(|iter| {
5631 // Note that we could actually be blocked, in
5632 // which case we need to only remove the one
5633 // blocker which was added duplicatively.
5634 let first_blocker = !found_blocker;
5635 if *iter == blocker { found_blocker = true; }
5636 *iter != blocker || !first_blocker
5638 debug_assert!(found_blocker);
5641 debug_assert!(false);
5650 let preimage_update = ChannelMonitorUpdate {
5651 update_id: CLOSED_CHANNEL_UPDATE_ID,
5652 counterparty_node_id: None,
5653 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5656 channel_id: Some(prev_hop.channel_id),
5660 // We update the ChannelMonitor on the backward link, after
5661 // receiving an `update_fulfill_htlc` from the forward link.
5662 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5663 if update_res != ChannelMonitorUpdateStatus::Completed {
5664 // TODO: This needs to be handled somehow - if we receive a monitor update
5665 // with a preimage we *must* somehow manage to propagate it to the upstream
5666 // channel, or we must have an ability to receive the same event and try
5667 // again on restart.
5668 log_error!(WithContext::from(&self.logger, None, Some(prev_hop.channel_id)),
5669 "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5670 payment_preimage, update_res);
5673 // If we're running during init we cannot update a monitor directly - they probably
5674 // haven't actually been loaded yet. Instead, push the monitor update as a background
5676 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5677 // channel is already closed) we need to ultimately handle the monitor update
5678 // completion action only after we've completed the monitor update. This is the only
5679 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5680 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5681 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5682 // complete the monitor update completion action from `completion_action`.
5683 self.pending_background_events.lock().unwrap().push(
5684 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5685 prev_hop.outpoint, prev_hop.channel_id, preimage_update,
5688 // Note that we do process the completion action here. This totally could be a
5689 // duplicate claim, but we have no way of knowing without interrogating the
5690 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5691 // generally always allowed to be duplicative (and it's specifically noted in
5692 // `PaymentForwarded`).
5693 self.handle_monitor_update_completion_actions(completion_action(None, false));
5697 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5698 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5701 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5702 forwarded_htlc_value_msat: Option<u64>, skimmed_fee_msat: Option<u64>, from_onchain: bool,
5703 startup_replay: bool, next_channel_counterparty_node_id: Option<PublicKey>,
5704 next_channel_outpoint: OutPoint, next_channel_id: ChannelId,
5707 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5708 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5709 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5710 if let Some(pubkey) = next_channel_counterparty_node_id {
5711 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5713 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5714 channel_funding_outpoint: next_channel_outpoint, channel_id: next_channel_id,
5715 counterparty_node_id: path.hops[0].pubkey,
5717 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5718 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5721 HTLCSource::PreviousHopData(hop_data) => {
5722 let prev_channel_id = hop_data.channel_id;
5723 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5724 #[cfg(debug_assertions)]
5725 let claiming_chan_funding_outpoint = hop_data.outpoint;
5726 #[cfg(debug_assertions)]
5727 let claiming_channel_id = hop_data.channel_id;
5728 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5729 |htlc_claim_value_msat, definitely_duplicate| {
5730 let chan_to_release =
5731 if let Some(node_id) = next_channel_counterparty_node_id {
5732 Some((node_id, next_channel_outpoint, next_channel_id, completed_blocker))
5734 // We can only get `None` here if we are processing a
5735 // `ChannelMonitor`-originated event, in which case we
5736 // don't care about ensuring we wake the downstream
5737 // channel's monitor updating - the channel is already
5742 if definitely_duplicate && startup_replay {
5743 // On startup we may get redundant claims which are related to
5744 // monitor updates still in flight. In that case, we shouldn't
5745 // immediately free, but instead let that monitor update complete
5746 // in the background.
5747 #[cfg(debug_assertions)] {
5748 let background_events = self.pending_background_events.lock().unwrap();
5749 // There should be a `BackgroundEvent` pending...
5750 assert!(background_events.iter().any(|ev| {
5752 // to apply a monitor update that blocked the claiming channel,
5753 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5754 funding_txo, update, ..
5756 if *funding_txo == claiming_chan_funding_outpoint {
5757 assert!(update.updates.iter().any(|upd|
5758 if let ChannelMonitorUpdateStep::PaymentPreimage {
5759 payment_preimage: update_preimage
5761 payment_preimage == *update_preimage
5767 // or the channel we'd unblock is already closed,
5768 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup(
5769 (funding_txo, _channel_id, monitor_update)
5771 if *funding_txo == next_channel_outpoint {
5772 assert_eq!(monitor_update.updates.len(), 1);
5774 monitor_update.updates[0],
5775 ChannelMonitorUpdateStep::ChannelForceClosed { .. }
5780 // or the monitor update has completed and will unblock
5781 // immediately once we get going.
5782 BackgroundEvent::MonitorUpdatesComplete {
5785 *channel_id == claiming_channel_id,
5787 }), "{:?}", *background_events);
5790 } else if definitely_duplicate {
5791 if let Some(other_chan) = chan_to_release {
5792 Some(MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5793 downstream_counterparty_node_id: other_chan.0,
5794 downstream_funding_outpoint: other_chan.1,
5795 downstream_channel_id: other_chan.2,
5796 blocking_action: other_chan.3,
5800 let total_fee_earned_msat = if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5801 if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5802 Some(claimed_htlc_value - forwarded_htlc_value)
5805 debug_assert!(skimmed_fee_msat <= total_fee_earned_msat,
5806 "skimmed_fee_msat must always be included in total_fee_earned_msat");
5807 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5808 event: events::Event::PaymentForwarded {
5809 total_fee_earned_msat,
5810 claim_from_onchain_tx: from_onchain,
5811 prev_channel_id: Some(prev_channel_id),
5812 next_channel_id: Some(next_channel_id),
5813 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5816 downstream_counterparty_and_funding_outpoint: chan_to_release,
5820 if let Err((pk, err)) = res {
5821 let result: Result<(), _> = Err(err);
5822 let _ = handle_error!(self, result, pk);
5828 /// Gets the node_id held by this ChannelManager
5829 pub fn get_our_node_id(&self) -> PublicKey {
5830 self.our_network_pubkey.clone()
5833 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5834 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5835 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5836 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
5838 for action in actions.into_iter() {
5840 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5841 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5842 if let Some(ClaimingPayment {
5844 payment_purpose: purpose,
5847 sender_intended_value: sender_intended_total_msat,
5849 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5853 receiver_node_id: Some(receiver_node_id),
5855 sender_intended_total_msat,
5859 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5860 event, downstream_counterparty_and_funding_outpoint
5862 self.pending_events.lock().unwrap().push_back((event, None));
5863 if let Some((node_id, funding_outpoint, channel_id, blocker)) = downstream_counterparty_and_funding_outpoint {
5864 self.handle_monitor_update_release(node_id, funding_outpoint, channel_id, Some(blocker));
5867 MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5868 downstream_counterparty_node_id, downstream_funding_outpoint, downstream_channel_id, blocking_action,
5870 self.handle_monitor_update_release(
5871 downstream_counterparty_node_id,
5872 downstream_funding_outpoint,
5873 downstream_channel_id,
5874 Some(blocking_action),
5881 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5882 /// update completion.
5883 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5884 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5885 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5886 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5887 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5888 -> Option<(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)> {
5889 let logger = WithChannelContext::from(&self.logger, &channel.context);
5890 log_trace!(logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5891 &channel.context.channel_id(),
5892 if raa.is_some() { "an" } else { "no" },
5893 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5894 if funding_broadcastable.is_some() { "" } else { "not " },
5895 if channel_ready.is_some() { "sending" } else { "without" },
5896 if announcement_sigs.is_some() { "sending" } else { "without" });
5898 let mut htlc_forwards = None;
5900 let counterparty_node_id = channel.context.get_counterparty_node_id();
5901 if !pending_forwards.is_empty() {
5902 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5903 channel.context.get_funding_txo().unwrap(), channel.context.channel_id(), channel.context.get_user_id(), pending_forwards));
5906 if let Some(msg) = channel_ready {
5907 send_channel_ready!(self, pending_msg_events, channel, msg);
5909 if let Some(msg) = announcement_sigs {
5910 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5911 node_id: counterparty_node_id,
5916 macro_rules! handle_cs { () => {
5917 if let Some(update) = commitment_update {
5918 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5919 node_id: counterparty_node_id,
5924 macro_rules! handle_raa { () => {
5925 if let Some(revoke_and_ack) = raa {
5926 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5927 node_id: counterparty_node_id,
5928 msg: revoke_and_ack,
5933 RAACommitmentOrder::CommitmentFirst => {
5937 RAACommitmentOrder::RevokeAndACKFirst => {
5943 if let Some(tx) = funding_broadcastable {
5944 log_info!(logger, "Broadcasting funding transaction with txid {}", tx.txid());
5945 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5949 let mut pending_events = self.pending_events.lock().unwrap();
5950 emit_channel_pending_event!(pending_events, channel);
5951 emit_channel_ready_event!(pending_events, channel);
5957 fn channel_monitor_updated(&self, funding_txo: &OutPoint, channel_id: &ChannelId, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5958 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5960 let counterparty_node_id = match counterparty_node_id {
5961 Some(cp_id) => cp_id.clone(),
5963 // TODO: Once we can rely on the counterparty_node_id from the
5964 // monitor event, this and the outpoint_to_peer map should be removed.
5965 let outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
5966 match outpoint_to_peer.get(funding_txo) {
5967 Some(cp_id) => cp_id.clone(),
5972 let per_peer_state = self.per_peer_state.read().unwrap();
5973 let mut peer_state_lock;
5974 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5975 if peer_state_mutex_opt.is_none() { return }
5976 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5977 let peer_state = &mut *peer_state_lock;
5979 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(channel_id) {
5982 let update_actions = peer_state.monitor_update_blocked_actions
5983 .remove(&channel_id).unwrap_or(Vec::new());
5984 mem::drop(peer_state_lock);
5985 mem::drop(per_peer_state);
5986 self.handle_monitor_update_completion_actions(update_actions);
5989 let remaining_in_flight =
5990 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5991 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5994 let logger = WithChannelContext::from(&self.logger, &channel.context);
5995 log_trace!(logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5996 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5997 remaining_in_flight);
5998 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
6001 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
6004 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
6006 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
6007 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
6010 /// The `user_channel_id` parameter will be provided back in
6011 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
6012 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
6014 /// Note that this method will return an error and reject the channel, if it requires support
6015 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
6016 /// used to accept such channels.
6018 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
6019 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
6020 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
6021 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
6024 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
6025 /// it as confirmed immediately.
6027 /// The `user_channel_id` parameter will be provided back in
6028 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
6029 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
6031 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
6032 /// and (if the counterparty agrees), enables forwarding of payments immediately.
6034 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
6035 /// transaction and blindly assumes that it will eventually confirm.
6037 /// If it does not confirm before we decide to close the channel, or if the funding transaction
6038 /// does not pay to the correct script the correct amount, *you will lose funds*.
6040 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
6041 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
6042 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
6043 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
6046 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
6048 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(*temporary_channel_id));
6049 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6051 let peers_without_funded_channels =
6052 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
6053 let per_peer_state = self.per_peer_state.read().unwrap();
6054 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6056 let err_str = format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id);
6057 log_error!(logger, "{}", err_str);
6059 APIError::ChannelUnavailable { err: err_str }
6061 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6062 let peer_state = &mut *peer_state_lock;
6063 let is_only_peer_channel = peer_state.total_channel_count() == 1;
6065 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
6066 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
6067 // that we can delay allocating the SCID until after we're sure that the checks below will
6069 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
6070 Some(unaccepted_channel) => {
6071 let best_block_height = self.best_block.read().unwrap().height();
6072 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6073 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
6074 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
6075 &self.logger, accept_0conf).map_err(|e| {
6076 let err_str = e.to_string();
6077 log_error!(logger, "{}", err_str);
6079 APIError::ChannelUnavailable { err: err_str }
6083 let err_str = "No such channel awaiting to be accepted.".to_owned();
6084 log_error!(logger, "{}", err_str);
6086 Err(APIError::APIMisuseError { err: err_str })
6091 // This should have been correctly configured by the call to InboundV1Channel::new.
6092 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
6093 } else if channel.context.get_channel_type().requires_zero_conf() {
6094 let send_msg_err_event = events::MessageSendEvent::HandleError {
6095 node_id: channel.context.get_counterparty_node_id(),
6096 action: msgs::ErrorAction::SendErrorMessage{
6097 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
6100 peer_state.pending_msg_events.push(send_msg_err_event);
6101 let err_str = "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned();
6102 log_error!(logger, "{}", err_str);
6104 return Err(APIError::APIMisuseError { err: err_str });
6106 // If this peer already has some channels, a new channel won't increase our number of peers
6107 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6108 // channels per-peer we can accept channels from a peer with existing ones.
6109 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
6110 let send_msg_err_event = events::MessageSendEvent::HandleError {
6111 node_id: channel.context.get_counterparty_node_id(),
6112 action: msgs::ErrorAction::SendErrorMessage{
6113 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
6116 peer_state.pending_msg_events.push(send_msg_err_event);
6117 let err_str = "Too many peers with unfunded channels, refusing to accept new ones".to_owned();
6118 log_error!(logger, "{}", err_str);
6120 return Err(APIError::APIMisuseError { err: err_str });
6124 // Now that we know we have a channel, assign an outbound SCID alias.
6125 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6126 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6128 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6129 node_id: channel.context.get_counterparty_node_id(),
6130 msg: channel.accept_inbound_channel(),
6133 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
6138 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
6139 /// or 0-conf channels.
6141 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
6142 /// non-0-conf channels we have with the peer.
6143 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
6144 where Filter: Fn(&PeerState<SP>) -> bool {
6145 let mut peers_without_funded_channels = 0;
6146 let best_block_height = self.best_block.read().unwrap().height();
6148 let peer_state_lock = self.per_peer_state.read().unwrap();
6149 for (_, peer_mtx) in peer_state_lock.iter() {
6150 let peer = peer_mtx.lock().unwrap();
6151 if !maybe_count_peer(&*peer) { continue; }
6152 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
6153 if num_unfunded_channels == peer.total_channel_count() {
6154 peers_without_funded_channels += 1;
6158 return peers_without_funded_channels;
6161 fn unfunded_channel_count(
6162 peer: &PeerState<SP>, best_block_height: u32
6164 let mut num_unfunded_channels = 0;
6165 for (_, phase) in peer.channel_by_id.iter() {
6167 ChannelPhase::Funded(chan) => {
6168 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
6169 // which have not yet had any confirmations on-chain.
6170 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
6171 chan.context.get_funding_tx_confirmations(best_block_height) == 0
6173 num_unfunded_channels += 1;
6176 ChannelPhase::UnfundedInboundV1(chan) => {
6177 if chan.context.minimum_depth().unwrap_or(1) != 0 {
6178 num_unfunded_channels += 1;
6181 ChannelPhase::UnfundedOutboundV1(_) => {
6182 // Outbound channels don't contribute to the unfunded count in the DoS context.
6187 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
6190 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
6191 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6192 // likely to be lost on restart!
6193 if msg.common_fields.chain_hash != self.chain_hash {
6194 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(),
6195 msg.common_fields.temporary_channel_id.clone()));
6198 if !self.default_configuration.accept_inbound_channels {
6199 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(),
6200 msg.common_fields.temporary_channel_id.clone()));
6203 // Get the number of peers with channels, but without funded ones. We don't care too much
6204 // about peers that never open a channel, so we filter by peers that have at least one
6205 // channel, and then limit the number of those with unfunded channels.
6206 let channeled_peers_without_funding =
6207 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
6209 let per_peer_state = self.per_peer_state.read().unwrap();
6210 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6212 debug_assert!(false);
6213 MsgHandleErrInternal::send_err_msg_no_close(
6214 format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id),
6215 msg.common_fields.temporary_channel_id.clone())
6217 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6218 let peer_state = &mut *peer_state_lock;
6220 // If this peer already has some channels, a new channel won't increase our number of peers
6221 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6222 // channels per-peer we can accept channels from a peer with existing ones.
6223 if peer_state.total_channel_count() == 0 &&
6224 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
6225 !self.default_configuration.manually_accept_inbound_channels
6227 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6228 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
6229 msg.common_fields.temporary_channel_id.clone()));
6232 let best_block_height = self.best_block.read().unwrap().height();
6233 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
6234 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6235 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
6236 msg.common_fields.temporary_channel_id.clone()));
6239 let channel_id = msg.common_fields.temporary_channel_id;
6240 let channel_exists = peer_state.has_channel(&channel_id);
6242 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6243 "temporary_channel_id collision for the same peer!".to_owned(),
6244 msg.common_fields.temporary_channel_id.clone()));
6247 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
6248 if self.default_configuration.manually_accept_inbound_channels {
6249 let channel_type = channel::channel_type_from_open_channel(
6250 &msg.common_fields, &peer_state.latest_features, &self.channel_type_features()
6252 MsgHandleErrInternal::from_chan_no_close(e, msg.common_fields.temporary_channel_id)
6254 let mut pending_events = self.pending_events.lock().unwrap();
6255 pending_events.push_back((events::Event::OpenChannelRequest {
6256 temporary_channel_id: msg.common_fields.temporary_channel_id.clone(),
6257 counterparty_node_id: counterparty_node_id.clone(),
6258 funding_satoshis: msg.common_fields.funding_satoshis,
6259 push_msat: msg.push_msat,
6262 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
6263 open_channel_msg: msg.clone(),
6264 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
6269 // Otherwise create the channel right now.
6270 let mut random_bytes = [0u8; 16];
6271 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
6272 let user_channel_id = u128::from_be_bytes(random_bytes);
6273 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6274 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
6275 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
6278 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.common_fields.temporary_channel_id));
6283 let channel_type = channel.context.get_channel_type();
6284 if channel_type.requires_zero_conf() {
6285 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6286 "No zero confirmation channels accepted".to_owned(),
6287 msg.common_fields.temporary_channel_id.clone()));
6289 if channel_type.requires_anchors_zero_fee_htlc_tx() {
6290 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6291 "No channels with anchor outputs accepted".to_owned(),
6292 msg.common_fields.temporary_channel_id.clone()));
6295 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6296 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6298 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6299 node_id: counterparty_node_id.clone(),
6300 msg: channel.accept_inbound_channel(),
6302 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
6306 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
6307 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6308 // likely to be lost on restart!
6309 let (value, output_script, user_id) = {
6310 let per_peer_state = self.per_peer_state.read().unwrap();
6311 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6313 debug_assert!(false);
6314 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.common_fields.temporary_channel_id)
6316 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6317 let peer_state = &mut *peer_state_lock;
6318 match peer_state.channel_by_id.entry(msg.common_fields.temporary_channel_id) {
6319 hash_map::Entry::Occupied(mut phase) => {
6320 match phase.get_mut() {
6321 ChannelPhase::UnfundedOutboundV1(chan) => {
6322 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
6323 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
6326 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.common_fields.temporary_channel_id));
6330 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.common_fields.temporary_channel_id))
6333 let mut pending_events = self.pending_events.lock().unwrap();
6334 pending_events.push_back((events::Event::FundingGenerationReady {
6335 temporary_channel_id: msg.common_fields.temporary_channel_id,
6336 counterparty_node_id: *counterparty_node_id,
6337 channel_value_satoshis: value,
6339 user_channel_id: user_id,
6344 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
6345 let best_block = *self.best_block.read().unwrap();
6347 let per_peer_state = self.per_peer_state.read().unwrap();
6348 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6350 debug_assert!(false);
6351 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)
6354 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6355 let peer_state = &mut *peer_state_lock;
6356 let (mut chan, funding_msg_opt, monitor) =
6357 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
6358 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
6359 let logger = WithChannelContext::from(&self.logger, &inbound_chan.context);
6360 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &&logger) {
6362 Err((inbound_chan, err)) => {
6363 // We've already removed this inbound channel from the map in `PeerState`
6364 // above so at this point we just need to clean up any lingering entries
6365 // concerning this channel as it is safe to do so.
6366 debug_assert!(matches!(err, ChannelError::Close(_)));
6367 // Really we should be returning the channel_id the peer expects based
6368 // on their funding info here, but they're horribly confused anyway, so
6369 // there's not a lot we can do to save them.
6370 return Err(convert_chan_phase_err!(self, err, &mut ChannelPhase::UnfundedInboundV1(inbound_chan), &msg.temporary_channel_id).1);
6374 Some(mut phase) => {
6375 let err_msg = format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id);
6376 let err = ChannelError::Close(err_msg);
6377 return Err(convert_chan_phase_err!(self, err, &mut phase, &msg.temporary_channel_id).1);
6379 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))
6382 let funded_channel_id = chan.context.channel_id();
6384 macro_rules! fail_chan { ($err: expr) => { {
6385 // Note that at this point we've filled in the funding outpoint on our
6386 // channel, but its actually in conflict with another channel. Thus, if
6387 // we call `convert_chan_phase_err` immediately (thus calling
6388 // `update_maps_on_chan_removal`), we'll remove the existing channel
6389 // from `outpoint_to_peer`. Thus, we must first unset the funding outpoint
6391 let err = ChannelError::Close($err.to_owned());
6392 chan.unset_funding_info(msg.temporary_channel_id);
6393 return Err(convert_chan_phase_err!(self, err, chan, &funded_channel_id, UNFUNDED_CHANNEL).1);
6396 match peer_state.channel_by_id.entry(funded_channel_id) {
6397 hash_map::Entry::Occupied(_) => {
6398 fail_chan!("Already had channel with the new channel_id");
6400 hash_map::Entry::Vacant(e) => {
6401 let mut outpoint_to_peer_lock = self.outpoint_to_peer.lock().unwrap();
6402 match outpoint_to_peer_lock.entry(monitor.get_funding_txo().0) {
6403 hash_map::Entry::Occupied(_) => {
6404 fail_chan!("The funding_created message had the same funding_txid as an existing channel - funding is not possible");
6406 hash_map::Entry::Vacant(i_e) => {
6407 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
6408 if let Ok(persist_state) = monitor_res {
6409 i_e.insert(chan.context.get_counterparty_node_id());
6410 mem::drop(outpoint_to_peer_lock);
6412 // There's no problem signing a counterparty's funding transaction if our monitor
6413 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
6414 // accepted payment from yet. We do, however, need to wait to send our channel_ready
6415 // until we have persisted our monitor.
6416 if let Some(msg) = funding_msg_opt {
6417 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6418 node_id: counterparty_node_id.clone(),
6423 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
6424 handle_new_monitor_update!(self, persist_state, peer_state_lock, peer_state,
6425 per_peer_state, chan, INITIAL_MONITOR);
6427 unreachable!("This must be a funded channel as we just inserted it.");
6431 let logger = WithChannelContext::from(&self.logger, &chan.context);
6432 log_error!(logger, "Persisting initial ChannelMonitor failed, implying the funding outpoint was duplicated");
6433 fail_chan!("Duplicate funding outpoint");
6441 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
6442 let best_block = *self.best_block.read().unwrap();
6443 let per_peer_state = self.per_peer_state.read().unwrap();
6444 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6446 debug_assert!(false);
6447 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6450 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6451 let peer_state = &mut *peer_state_lock;
6452 match peer_state.channel_by_id.entry(msg.channel_id) {
6453 hash_map::Entry::Occupied(chan_phase_entry) => {
6454 if matches!(chan_phase_entry.get(), ChannelPhase::UnfundedOutboundV1(_)) {
6455 let chan = if let ChannelPhase::UnfundedOutboundV1(chan) = chan_phase_entry.remove() { chan } else { unreachable!() };
6456 let logger = WithContext::from(
6458 Some(chan.context.get_counterparty_node_id()),
6459 Some(chan.context.channel_id())
6462 chan.funding_signed(&msg, best_block, &self.signer_provider, &&logger);
6464 Ok((mut chan, monitor)) => {
6465 if let Ok(persist_status) = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor) {
6466 // We really should be able to insert here without doing a second
6467 // lookup, but sadly rust stdlib doesn't currently allow keeping
6468 // the original Entry around with the value removed.
6469 let mut chan = peer_state.channel_by_id.entry(msg.channel_id).or_insert(ChannelPhase::Funded(chan));
6470 if let ChannelPhase::Funded(ref mut chan) = &mut chan {
6471 handle_new_monitor_update!(self, persist_status, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
6472 } else { unreachable!(); }
6475 let e = ChannelError::Close("Channel funding outpoint was a duplicate".to_owned());
6476 // We weren't able to watch the channel to begin with, so no
6477 // updates should be made on it. Previously, full_stack_target
6478 // found an (unreachable) panic when the monitor update contained
6479 // within `shutdown_finish` was applied.
6480 chan.unset_funding_info(msg.channel_id);
6481 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::Funded(chan), &msg.channel_id).1);
6485 debug_assert!(matches!(e, ChannelError::Close(_)),
6486 "We don't have a channel anymore, so the error better have expected close");
6487 // We've already removed this outbound channel from the map in
6488 // `PeerState` above so at this point we just need to clean up any
6489 // lingering entries concerning this channel as it is safe to do so.
6490 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::UnfundedOutboundV1(chan), &msg.channel_id).1);
6494 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
6497 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
6501 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
6502 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6503 // closing a channel), so any changes are likely to be lost on restart!
6504 let per_peer_state = self.per_peer_state.read().unwrap();
6505 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6507 debug_assert!(false);
6508 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6510 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6511 let peer_state = &mut *peer_state_lock;
6512 match peer_state.channel_by_id.entry(msg.channel_id) {
6513 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6514 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6515 let logger = WithChannelContext::from(&self.logger, &chan.context);
6516 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
6517 self.chain_hash, &self.default_configuration, &self.best_block.read().unwrap(), &&logger), chan_phase_entry);
6518 if let Some(announcement_sigs) = announcement_sigs_opt {
6519 log_trace!(logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
6520 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6521 node_id: counterparty_node_id.clone(),
6522 msg: announcement_sigs,
6524 } else if chan.context.is_usable() {
6525 // If we're sending an announcement_signatures, we'll send the (public)
6526 // channel_update after sending a channel_announcement when we receive our
6527 // counterparty's announcement_signatures. Thus, we only bother to send a
6528 // channel_update here if the channel is not public, i.e. we're not sending an
6529 // announcement_signatures.
6530 log_trace!(logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
6531 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6532 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6533 node_id: counterparty_node_id.clone(),
6540 let mut pending_events = self.pending_events.lock().unwrap();
6541 emit_channel_ready_event!(pending_events, chan);
6546 try_chan_phase_entry!(self, Err(ChannelError::Close(
6547 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
6550 hash_map::Entry::Vacant(_) => {
6551 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))
6556 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
6557 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
6558 let mut finish_shutdown = None;
6560 let per_peer_state = self.per_peer_state.read().unwrap();
6561 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6563 debug_assert!(false);
6564 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6566 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6567 let peer_state = &mut *peer_state_lock;
6568 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6569 let phase = chan_phase_entry.get_mut();
6571 ChannelPhase::Funded(chan) => {
6572 if !chan.received_shutdown() {
6573 let logger = WithChannelContext::from(&self.logger, &chan.context);
6574 log_info!(logger, "Received a shutdown message from our counterparty for channel {}{}.",
6576 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
6579 let funding_txo_opt = chan.context.get_funding_txo();
6580 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
6581 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
6582 dropped_htlcs = htlcs;
6584 if let Some(msg) = shutdown {
6585 // We can send the `shutdown` message before updating the `ChannelMonitor`
6586 // here as we don't need the monitor update to complete until we send a
6587 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
6588 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6589 node_id: *counterparty_node_id,
6593 // Update the monitor with the shutdown script if necessary.
6594 if let Some(monitor_update) = monitor_update_opt {
6595 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
6596 peer_state_lock, peer_state, per_peer_state, chan);
6599 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6600 let context = phase.context_mut();
6601 let logger = WithChannelContext::from(&self.logger, context);
6602 log_error!(logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6603 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6604 finish_shutdown = Some(chan.context_mut().force_shutdown(false, ClosureReason::CounterpartyCoopClosedUnfundedChannel));
6608 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))
6611 for htlc_source in dropped_htlcs.drain(..) {
6612 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6613 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6614 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6616 if let Some(shutdown_res) = finish_shutdown {
6617 self.finish_close_channel(shutdown_res);
6623 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6624 let per_peer_state = self.per_peer_state.read().unwrap();
6625 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6627 debug_assert!(false);
6628 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6630 let (tx, chan_option, shutdown_result) = {
6631 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6632 let peer_state = &mut *peer_state_lock;
6633 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6634 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6635 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6636 let (closing_signed, tx, shutdown_result) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6637 debug_assert_eq!(shutdown_result.is_some(), chan.is_shutdown());
6638 if let Some(msg) = closing_signed {
6639 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6640 node_id: counterparty_node_id.clone(),
6645 // We're done with this channel, we've got a signed closing transaction and
6646 // will send the closing_signed back to the remote peer upon return. This
6647 // also implies there are no pending HTLCs left on the channel, so we can
6648 // fully delete it from tracking (the channel monitor is still around to
6649 // watch for old state broadcasts)!
6650 (tx, Some(remove_channel_phase!(self, chan_phase_entry)), shutdown_result)
6651 } else { (tx, None, shutdown_result) }
6653 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6654 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6657 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))
6660 if let Some(broadcast_tx) = tx {
6661 let channel_id = chan_option.as_ref().map(|channel| channel.context().channel_id());
6662 log_info!(WithContext::from(&self.logger, Some(*counterparty_node_id), channel_id), "Broadcasting {}", log_tx!(broadcast_tx));
6663 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6665 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6666 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6667 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6668 let peer_state = &mut *peer_state_lock;
6669 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6674 mem::drop(per_peer_state);
6675 if let Some(shutdown_result) = shutdown_result {
6676 self.finish_close_channel(shutdown_result);
6681 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6682 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6683 //determine the state of the payment based on our response/if we forward anything/the time
6684 //we take to respond. We should take care to avoid allowing such an attack.
6686 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6687 //us repeatedly garbled in different ways, and compare our error messages, which are
6688 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6689 //but we should prevent it anyway.
6691 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6692 // closing a channel), so any changes are likely to be lost on restart!
6694 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
6695 let per_peer_state = self.per_peer_state.read().unwrap();
6696 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6698 debug_assert!(false);
6699 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6701 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6702 let peer_state = &mut *peer_state_lock;
6703 match peer_state.channel_by_id.entry(msg.channel_id) {
6704 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6705 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6706 let pending_forward_info = match decoded_hop_res {
6707 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6708 self.construct_pending_htlc_status(
6709 msg, counterparty_node_id, shared_secret, next_hop,
6710 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
6712 Err(e) => PendingHTLCStatus::Fail(e)
6714 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6715 if msg.blinding_point.is_some() {
6716 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(
6717 msgs::UpdateFailMalformedHTLC {
6718 channel_id: msg.channel_id,
6719 htlc_id: msg.htlc_id,
6720 sha256_of_onion: [0; 32],
6721 failure_code: INVALID_ONION_BLINDING,
6725 // If the update_add is completely bogus, the call will Err and we will close,
6726 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6727 // want to reject the new HTLC and fail it backwards instead of forwarding.
6728 match pending_forward_info {
6729 PendingHTLCStatus::Forward(PendingHTLCInfo {
6730 ref incoming_shared_secret, ref routing, ..
6732 let reason = if routing.blinded_failure().is_some() {
6733 HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32])
6734 } else if (error_code & 0x1000) != 0 {
6735 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6736 HTLCFailReason::reason(real_code, error_data)
6738 HTLCFailReason::from_failure_code(error_code)
6739 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6740 let msg = msgs::UpdateFailHTLC {
6741 channel_id: msg.channel_id,
6742 htlc_id: msg.htlc_id,
6745 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6747 _ => pending_forward_info
6750 let logger = WithChannelContext::from(&self.logger, &chan.context);
6751 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &&logger), chan_phase_entry);
6753 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6754 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6757 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))
6762 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6764 let (htlc_source, forwarded_htlc_value, skimmed_fee_msat) = {
6765 let per_peer_state = self.per_peer_state.read().unwrap();
6766 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6768 debug_assert!(false);
6769 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6771 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6772 let peer_state = &mut *peer_state_lock;
6773 match peer_state.channel_by_id.entry(msg.channel_id) {
6774 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6775 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6776 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6777 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6778 let logger = WithChannelContext::from(&self.logger, &chan.context);
6780 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
6782 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6783 .or_insert_with(Vec::new)
6784 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6786 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6787 // entry here, even though we *do* need to block the next RAA monitor update.
6788 // We do this instead in the `claim_funds_internal` by attaching a
6789 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6790 // outbound HTLC is claimed. This is guaranteed to all complete before we
6791 // process the RAA as messages are processed from single peers serially.
6792 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6795 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6796 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6799 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))
6802 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(),
6803 Some(forwarded_htlc_value), skimmed_fee_msat, false, false, Some(*counterparty_node_id),
6804 funding_txo, msg.channel_id
6810 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6811 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6812 // closing a channel), so any changes are likely to be lost on restart!
6813 let per_peer_state = self.per_peer_state.read().unwrap();
6814 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6816 debug_assert!(false);
6817 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6819 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6820 let peer_state = &mut *peer_state_lock;
6821 match peer_state.channel_by_id.entry(msg.channel_id) {
6822 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6823 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6824 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6826 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6827 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6830 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))
6835 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6836 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6837 // closing a channel), so any changes are likely to be lost on restart!
6838 let per_peer_state = self.per_peer_state.read().unwrap();
6839 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6841 debug_assert!(false);
6842 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6844 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6845 let peer_state = &mut *peer_state_lock;
6846 match peer_state.channel_by_id.entry(msg.channel_id) {
6847 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6848 if (msg.failure_code & 0x8000) == 0 {
6849 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6850 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6852 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6853 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);
6855 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6856 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6860 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))
6864 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6865 let per_peer_state = self.per_peer_state.read().unwrap();
6866 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6868 debug_assert!(false);
6869 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6871 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6872 let peer_state = &mut *peer_state_lock;
6873 match peer_state.channel_by_id.entry(msg.channel_id) {
6874 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6875 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6876 let logger = WithChannelContext::from(&self.logger, &chan.context);
6877 let funding_txo = chan.context.get_funding_txo();
6878 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &&logger), chan_phase_entry);
6879 if let Some(monitor_update) = monitor_update_opt {
6880 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6881 peer_state, per_peer_state, chan);
6885 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6886 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6889 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))
6894 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6895 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6896 let mut push_forward_event = false;
6897 let mut new_intercept_events = VecDeque::new();
6898 let mut failed_intercept_forwards = Vec::new();
6899 if !pending_forwards.is_empty() {
6900 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6901 let scid = match forward_info.routing {
6902 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6903 PendingHTLCRouting::Receive { .. } => 0,
6904 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6906 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6907 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6909 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6910 let forward_htlcs_empty = forward_htlcs.is_empty();
6911 match forward_htlcs.entry(scid) {
6912 hash_map::Entry::Occupied(mut entry) => {
6913 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6914 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info }));
6916 hash_map::Entry::Vacant(entry) => {
6917 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6918 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.chain_hash)
6920 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).to_byte_array());
6921 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6922 match pending_intercepts.entry(intercept_id) {
6923 hash_map::Entry::Vacant(entry) => {
6924 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6925 requested_next_hop_scid: scid,
6926 payment_hash: forward_info.payment_hash,
6927 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6928 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6931 entry.insert(PendingAddHTLCInfo {
6932 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info });
6934 hash_map::Entry::Occupied(_) => {
6935 let logger = WithContext::from(&self.logger, None, Some(prev_channel_id));
6936 log_info!(logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6937 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6938 short_channel_id: prev_short_channel_id,
6939 user_channel_id: Some(prev_user_channel_id),
6940 outpoint: prev_funding_outpoint,
6941 channel_id: prev_channel_id,
6942 htlc_id: prev_htlc_id,
6943 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6944 phantom_shared_secret: None,
6945 blinded_failure: forward_info.routing.blinded_failure(),
6948 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6949 HTLCFailReason::from_failure_code(0x4000 | 10),
6950 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6955 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6956 // payments are being processed.
6957 if forward_htlcs_empty {
6958 push_forward_event = true;
6960 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6961 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info })));
6968 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6969 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6972 if !new_intercept_events.is_empty() {
6973 let mut events = self.pending_events.lock().unwrap();
6974 events.append(&mut new_intercept_events);
6976 if push_forward_event { self.push_pending_forwards_ev() }
6980 fn push_pending_forwards_ev(&self) {
6981 let mut pending_events = self.pending_events.lock().unwrap();
6982 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6983 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6984 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6986 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6987 // events is done in batches and they are not removed until we're done processing each
6988 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6989 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6990 // payments will need an additional forwarding event before being claimed to make them look
6991 // real by taking more time.
6992 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6993 pending_events.push_back((Event::PendingHTLCsForwardable {
6994 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6999 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
7000 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
7001 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
7002 /// the [`ChannelMonitorUpdate`] in question.
7003 fn raa_monitor_updates_held(&self,
7004 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
7005 channel_funding_outpoint: OutPoint, channel_id: ChannelId, counterparty_node_id: PublicKey
7007 actions_blocking_raa_monitor_updates
7008 .get(&channel_id).map(|v| !v.is_empty()).unwrap_or(false)
7009 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
7010 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
7011 channel_funding_outpoint,
7013 counterparty_node_id,
7018 #[cfg(any(test, feature = "_test_utils"))]
7019 pub(crate) fn test_raa_monitor_updates_held(&self,
7020 counterparty_node_id: PublicKey, channel_id: ChannelId
7022 let per_peer_state = self.per_peer_state.read().unwrap();
7023 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
7024 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
7025 let peer_state = &mut *peer_state_lck;
7027 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
7028 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
7029 chan.context().get_funding_txo().unwrap(), channel_id, counterparty_node_id);
7035 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
7036 let htlcs_to_fail = {
7037 let per_peer_state = self.per_peer_state.read().unwrap();
7038 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
7040 debug_assert!(false);
7041 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7042 }).map(|mtx| mtx.lock().unwrap())?;
7043 let peer_state = &mut *peer_state_lock;
7044 match peer_state.channel_by_id.entry(msg.channel_id) {
7045 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7046 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7047 let logger = WithChannelContext::from(&self.logger, &chan.context);
7048 let funding_txo_opt = chan.context.get_funding_txo();
7049 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
7050 self.raa_monitor_updates_held(
7051 &peer_state.actions_blocking_raa_monitor_updates, funding_txo, msg.channel_id,
7052 *counterparty_node_id)
7054 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
7055 chan.revoke_and_ack(&msg, &self.fee_estimator, &&logger, mon_update_blocked), chan_phase_entry);
7056 if let Some(monitor_update) = monitor_update_opt {
7057 let funding_txo = funding_txo_opt
7058 .expect("Funding outpoint must have been set for RAA handling to succeed");
7059 handle_new_monitor_update!(self, funding_txo, monitor_update,
7060 peer_state_lock, peer_state, per_peer_state, chan);
7064 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7065 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
7068 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))
7071 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
7075 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
7076 let per_peer_state = self.per_peer_state.read().unwrap();
7077 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7079 debug_assert!(false);
7080 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7082 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7083 let peer_state = &mut *peer_state_lock;
7084 match peer_state.channel_by_id.entry(msg.channel_id) {
7085 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7086 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7087 let logger = WithChannelContext::from(&self.logger, &chan.context);
7088 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &&logger), chan_phase_entry);
7090 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7091 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
7094 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))
7099 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
7100 let per_peer_state = self.per_peer_state.read().unwrap();
7101 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7103 debug_assert!(false);
7104 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7106 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7107 let peer_state = &mut *peer_state_lock;
7108 match peer_state.channel_by_id.entry(msg.channel_id) {
7109 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7110 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7111 if !chan.context.is_usable() {
7112 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
7115 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7116 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
7117 &self.node_signer, self.chain_hash, self.best_block.read().unwrap().height(),
7118 msg, &self.default_configuration
7119 ), chan_phase_entry),
7120 // Note that announcement_signatures fails if the channel cannot be announced,
7121 // so get_channel_update_for_broadcast will never fail by the time we get here.
7122 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
7125 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7126 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
7129 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))
7134 /// Returns DoPersist if anything changed, otherwise either SkipPersistNoEvents or an Err.
7135 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
7136 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
7137 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
7139 // It's not a local channel
7140 return Ok(NotifyOption::SkipPersistNoEvents)
7143 let per_peer_state = self.per_peer_state.read().unwrap();
7144 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
7145 if peer_state_mutex_opt.is_none() {
7146 return Ok(NotifyOption::SkipPersistNoEvents)
7148 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7149 let peer_state = &mut *peer_state_lock;
7150 match peer_state.channel_by_id.entry(chan_id) {
7151 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7152 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7153 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
7154 if chan.context.should_announce() {
7155 // If the announcement is about a channel of ours which is public, some
7156 // other peer may simply be forwarding all its gossip to us. Don't provide
7157 // a scary-looking error message and return Ok instead.
7158 return Ok(NotifyOption::SkipPersistNoEvents);
7160 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));
7162 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
7163 let msg_from_node_one = msg.contents.flags & 1 == 0;
7164 if were_node_one == msg_from_node_one {
7165 return Ok(NotifyOption::SkipPersistNoEvents);
7167 let logger = WithChannelContext::from(&self.logger, &chan.context);
7168 log_debug!(logger, "Received channel_update {:?} for channel {}.", msg, chan_id);
7169 let did_change = try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
7170 // If nothing changed after applying their update, we don't need to bother
7173 return Ok(NotifyOption::SkipPersistNoEvents);
7177 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7178 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
7181 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersistNoEvents)
7183 Ok(NotifyOption::DoPersist)
7186 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<NotifyOption, MsgHandleErrInternal> {
7188 let need_lnd_workaround = {
7189 let per_peer_state = self.per_peer_state.read().unwrap();
7191 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7193 debug_assert!(false);
7194 MsgHandleErrInternal::send_err_msg_no_close(
7195 format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id),
7199 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
7200 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7201 let peer_state = &mut *peer_state_lock;
7202 match peer_state.channel_by_id.entry(msg.channel_id) {
7203 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7204 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7205 // Currently, we expect all holding cell update_adds to be dropped on peer
7206 // disconnect, so Channel's reestablish will never hand us any holding cell
7207 // freed HTLCs to fail backwards. If in the future we no longer drop pending
7208 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
7209 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
7210 msg, &&logger, &self.node_signer, self.chain_hash,
7211 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
7212 let mut channel_update = None;
7213 if let Some(msg) = responses.shutdown_msg {
7214 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7215 node_id: counterparty_node_id.clone(),
7218 } else if chan.context.is_usable() {
7219 // If the channel is in a usable state (ie the channel is not being shut
7220 // down), send a unicast channel_update to our counterparty to make sure
7221 // they have the latest channel parameters.
7222 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
7223 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
7224 node_id: chan.context.get_counterparty_node_id(),
7229 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
7230 htlc_forwards = self.handle_channel_resumption(
7231 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
7232 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
7233 if let Some(upd) = channel_update {
7234 peer_state.pending_msg_events.push(upd);
7238 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7239 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
7242 hash_map::Entry::Vacant(_) => {
7243 log_debug!(logger, "Sending bogus ChannelReestablish for unknown channel {} to force channel closure",
7245 // Unfortunately, lnd doesn't force close on errors
7246 // (https://github.com/lightningnetwork/lnd/blob/abb1e3463f3a83bbb843d5c399869dbe930ad94f/htlcswitch/link.go#L2119).
7247 // One of the few ways to get an lnd counterparty to force close is by
7248 // replicating what they do when restoring static channel backups (SCBs). They
7249 // send an invalid `ChannelReestablish` with `0` commitment numbers and an
7250 // invalid `your_last_per_commitment_secret`.
7252 // Since we received a `ChannelReestablish` for a channel that doesn't exist, we
7253 // can assume it's likely the channel closed from our point of view, but it
7254 // remains open on the counterparty's side. By sending this bogus
7255 // `ChannelReestablish` message now as a response to theirs, we trigger them to
7256 // force close broadcasting their latest state. If the closing transaction from
7257 // our point of view remains unconfirmed, it'll enter a race with the
7258 // counterparty's to-be-broadcast latest commitment transaction.
7259 peer_state.pending_msg_events.push(MessageSendEvent::SendChannelReestablish {
7260 node_id: *counterparty_node_id,
7261 msg: msgs::ChannelReestablish {
7262 channel_id: msg.channel_id,
7263 next_local_commitment_number: 0,
7264 next_remote_commitment_number: 0,
7265 your_last_per_commitment_secret: [1u8; 32],
7266 my_current_per_commitment_point: PublicKey::from_slice(&[2u8; 33]).unwrap(),
7267 next_funding_txid: None,
7270 return Err(MsgHandleErrInternal::send_err_msg_no_close(
7271 format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
7272 counterparty_node_id), msg.channel_id)
7278 let mut persist = NotifyOption::SkipPersistHandleEvents;
7279 if let Some(forwards) = htlc_forwards {
7280 self.forward_htlcs(&mut [forwards][..]);
7281 persist = NotifyOption::DoPersist;
7284 if let Some(channel_ready_msg) = need_lnd_workaround {
7285 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
7290 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
7291 fn process_pending_monitor_events(&self) -> bool {
7292 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
7294 let mut failed_channels = Vec::new();
7295 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
7296 let has_pending_monitor_events = !pending_monitor_events.is_empty();
7297 for (funding_outpoint, channel_id, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
7298 for monitor_event in monitor_events.drain(..) {
7299 match monitor_event {
7300 MonitorEvent::HTLCEvent(htlc_update) => {
7301 let logger = WithContext::from(&self.logger, counterparty_node_id, Some(channel_id));
7302 if let Some(preimage) = htlc_update.payment_preimage {
7303 log_trace!(logger, "Claiming HTLC with preimage {} from our monitor", preimage);
7304 self.claim_funds_internal(htlc_update.source, preimage,
7305 htlc_update.htlc_value_satoshis.map(|v| v * 1000), None, true,
7306 false, counterparty_node_id, funding_outpoint, channel_id);
7308 log_trace!(logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
7309 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id };
7310 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7311 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
7314 MonitorEvent::HolderForceClosed(_funding_outpoint) => {
7315 let counterparty_node_id_opt = match counterparty_node_id {
7316 Some(cp_id) => Some(cp_id),
7318 // TODO: Once we can rely on the counterparty_node_id from the
7319 // monitor event, this and the outpoint_to_peer map should be removed.
7320 let outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
7321 outpoint_to_peer.get(&funding_outpoint).cloned()
7324 if let Some(counterparty_node_id) = counterparty_node_id_opt {
7325 let per_peer_state = self.per_peer_state.read().unwrap();
7326 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7327 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7328 let peer_state = &mut *peer_state_lock;
7329 let pending_msg_events = &mut peer_state.pending_msg_events;
7330 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id) {
7331 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
7332 failed_channels.push(chan.context.force_shutdown(false, ClosureReason::HolderForceClosed));
7333 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7334 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7338 pending_msg_events.push(events::MessageSendEvent::HandleError {
7339 node_id: chan.context.get_counterparty_node_id(),
7340 action: msgs::ErrorAction::DisconnectPeer {
7341 msg: Some(msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() })
7349 MonitorEvent::Completed { funding_txo, channel_id, monitor_update_id } => {
7350 self.channel_monitor_updated(&funding_txo, &channel_id, monitor_update_id, counterparty_node_id.as_ref());
7356 for failure in failed_channels.drain(..) {
7357 self.finish_close_channel(failure);
7360 has_pending_monitor_events
7363 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
7364 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
7365 /// update events as a separate process method here.
7367 pub fn process_monitor_events(&self) {
7368 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7369 self.process_pending_monitor_events();
7372 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
7373 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
7374 /// update was applied.
7375 fn check_free_holding_cells(&self) -> bool {
7376 let mut has_monitor_update = false;
7377 let mut failed_htlcs = Vec::new();
7379 // Walk our list of channels and find any that need to update. Note that when we do find an
7380 // update, if it includes actions that must be taken afterwards, we have to drop the
7381 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
7382 // manage to go through all our peers without finding a single channel to update.
7384 let per_peer_state = self.per_peer_state.read().unwrap();
7385 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7387 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7388 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
7389 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
7390 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
7392 let counterparty_node_id = chan.context.get_counterparty_node_id();
7393 let funding_txo = chan.context.get_funding_txo();
7394 let (monitor_opt, holding_cell_failed_htlcs) =
7395 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &&WithChannelContext::from(&self.logger, &chan.context));
7396 if !holding_cell_failed_htlcs.is_empty() {
7397 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
7399 if let Some(monitor_update) = monitor_opt {
7400 has_monitor_update = true;
7402 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
7403 peer_state_lock, peer_state, per_peer_state, chan);
7404 continue 'peer_loop;
7413 let has_update = has_monitor_update || !failed_htlcs.is_empty();
7414 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
7415 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
7421 /// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
7422 /// is (temporarily) unavailable, and the operation should be retried later.
7424 /// This method allows for that retry - either checking for any signer-pending messages to be
7425 /// attempted in every channel, or in the specifically provided channel.
7427 /// [`ChannelSigner`]: crate::sign::ChannelSigner
7428 #[cfg(async_signing)]
7429 pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
7430 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7432 let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
7433 let node_id = phase.context().get_counterparty_node_id();
7435 ChannelPhase::Funded(chan) => {
7436 let msgs = chan.signer_maybe_unblocked(&self.logger);
7437 if let Some(updates) = msgs.commitment_update {
7438 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
7443 if let Some(msg) = msgs.funding_signed {
7444 pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
7449 if let Some(msg) = msgs.channel_ready {
7450 send_channel_ready!(self, pending_msg_events, chan, msg);
7453 ChannelPhase::UnfundedOutboundV1(chan) => {
7454 if let Some(msg) = chan.signer_maybe_unblocked(&self.logger) {
7455 pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
7461 ChannelPhase::UnfundedInboundV1(_) => {},
7465 let per_peer_state = self.per_peer_state.read().unwrap();
7466 if let Some((counterparty_node_id, channel_id)) = channel_opt {
7467 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7468 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7469 let peer_state = &mut *peer_state_lock;
7470 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
7471 unblock_chan(chan, &mut peer_state.pending_msg_events);
7475 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7476 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7477 let peer_state = &mut *peer_state_lock;
7478 for (_, chan) in peer_state.channel_by_id.iter_mut() {
7479 unblock_chan(chan, &mut peer_state.pending_msg_events);
7485 /// Check whether any channels have finished removing all pending updates after a shutdown
7486 /// exchange and can now send a closing_signed.
7487 /// Returns whether any closing_signed messages were generated.
7488 fn maybe_generate_initial_closing_signed(&self) -> bool {
7489 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
7490 let mut has_update = false;
7491 let mut shutdown_results = Vec::new();
7493 let per_peer_state = self.per_peer_state.read().unwrap();
7495 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7496 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7497 let peer_state = &mut *peer_state_lock;
7498 let pending_msg_events = &mut peer_state.pending_msg_events;
7499 peer_state.channel_by_id.retain(|channel_id, phase| {
7501 ChannelPhase::Funded(chan) => {
7502 let logger = WithChannelContext::from(&self.logger, &chan.context);
7503 match chan.maybe_propose_closing_signed(&self.fee_estimator, &&logger) {
7504 Ok((msg_opt, tx_opt, shutdown_result_opt)) => {
7505 if let Some(msg) = msg_opt {
7507 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
7508 node_id: chan.context.get_counterparty_node_id(), msg,
7511 debug_assert_eq!(shutdown_result_opt.is_some(), chan.is_shutdown());
7512 if let Some(shutdown_result) = shutdown_result_opt {
7513 shutdown_results.push(shutdown_result);
7515 if let Some(tx) = tx_opt {
7516 // We're done with this channel. We got a closing_signed and sent back
7517 // a closing_signed with a closing transaction to broadcast.
7518 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7519 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7524 log_info!(logger, "Broadcasting {}", log_tx!(tx));
7525 self.tx_broadcaster.broadcast_transactions(&[&tx]);
7526 update_maps_on_chan_removal!(self, &chan.context);
7532 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
7533 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
7538 _ => true, // Retain unfunded channels if present.
7544 for (counterparty_node_id, err) in handle_errors.drain(..) {
7545 let _ = handle_error!(self, err, counterparty_node_id);
7548 for shutdown_result in shutdown_results.drain(..) {
7549 self.finish_close_channel(shutdown_result);
7555 /// Handle a list of channel failures during a block_connected or block_disconnected call,
7556 /// pushing the channel monitor update (if any) to the background events queue and removing the
7558 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
7559 for mut failure in failed_channels.drain(..) {
7560 // Either a commitment transactions has been confirmed on-chain or
7561 // Channel::block_disconnected detected that the funding transaction has been
7562 // reorganized out of the main chain.
7563 // We cannot broadcast our latest local state via monitor update (as
7564 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
7565 // so we track the update internally and handle it when the user next calls
7566 // timer_tick_occurred, guaranteeing we're running normally.
7567 if let Some((counterparty_node_id, funding_txo, channel_id, update)) = failure.monitor_update.take() {
7568 assert_eq!(update.updates.len(), 1);
7569 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
7570 assert!(should_broadcast);
7571 } else { unreachable!(); }
7572 self.pending_background_events.lock().unwrap().push(
7573 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
7574 counterparty_node_id, funding_txo, update, channel_id,
7577 self.finish_close_channel(failure);
7581 /// Creates an [`OfferBuilder`] such that the [`Offer`] it builds is recognized by the
7582 /// [`ChannelManager`] when handling [`InvoiceRequest`] messages for the offer. The offer will
7583 /// not have an expiration unless otherwise set on the builder.
7587 /// Uses [`MessageRouter::create_blinded_paths`] to construct a [`BlindedPath`] for the offer.
7588 /// However, if one is not found, uses a one-hop [`BlindedPath`] with
7589 /// [`ChannelManager::get_our_node_id`] as the introduction node instead. In the latter case,
7590 /// the node must be announced, otherwise, there is no way to find a path to the introduction in
7591 /// order to send the [`InvoiceRequest`].
7593 /// Also, uses a derived signing pubkey in the offer for recipient privacy.
7597 /// Requires a direct connection to the introduction node in the responding [`InvoiceRequest`]'s
7602 /// Errors if the parameterized [`Router`] is unable to create a blinded path for the offer.
7604 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7606 /// [`Offer`]: crate::offers::offer::Offer
7607 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7608 pub fn create_offer_builder(
7609 &self, description: String
7610 ) -> Result<OfferBuilder<DerivedMetadata, secp256k1::All>, Bolt12SemanticError> {
7611 let node_id = self.get_our_node_id();
7612 let expanded_key = &self.inbound_payment_key;
7613 let entropy = &*self.entropy_source;
7614 let secp_ctx = &self.secp_ctx;
7616 let path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7617 let builder = OfferBuilder::deriving_signing_pubkey(
7618 description, node_id, expanded_key, entropy, secp_ctx
7620 .chain_hash(self.chain_hash)
7626 /// Creates a [`RefundBuilder`] such that the [`Refund`] it builds is recognized by the
7627 /// [`ChannelManager`] when handling [`Bolt12Invoice`] messages for the refund.
7631 /// The provided `payment_id` is used to ensure that only one invoice is paid for the refund.
7632 /// See [Avoiding Duplicate Payments] for other requirements once the payment has been sent.
7634 /// The builder will have the provided expiration set. Any changes to the expiration on the
7635 /// returned builder will not be honored by [`ChannelManager`]. For `no-std`, the highest seen
7636 /// block time minus two hours is used for the current time when determining if the refund has
7639 /// To revoke the refund, use [`ChannelManager::abandon_payment`] prior to receiving the
7640 /// invoice. If abandoned, or an invoice isn't received before expiration, the payment will fail
7641 /// with an [`Event::InvoiceRequestFailed`].
7643 /// If `max_total_routing_fee_msat` is not specified, The default from
7644 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7648 /// Uses [`MessageRouter::create_blinded_paths`] to construct a [`BlindedPath`] for the refund.
7649 /// However, if one is not found, uses a one-hop [`BlindedPath`] with
7650 /// [`ChannelManager::get_our_node_id`] as the introduction node instead. In the latter case,
7651 /// the node must be announced, otherwise, there is no way to find a path to the introduction in
7652 /// order to send the [`Bolt12Invoice`].
7654 /// Also, uses a derived payer id in the refund for payer privacy.
7658 /// Requires a direct connection to an introduction node in the responding
7659 /// [`Bolt12Invoice::payment_paths`].
7664 /// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
7665 /// - `amount_msats` is invalid, or
7666 /// - the parameterized [`Router`] is unable to create a blinded path for the refund.
7668 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7670 /// [`Refund`]: crate::offers::refund::Refund
7671 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7672 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7673 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7674 pub fn create_refund_builder(
7675 &self, description: String, amount_msats: u64, absolute_expiry: Duration,
7676 payment_id: PaymentId, retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
7677 ) -> Result<RefundBuilder<secp256k1::All>, Bolt12SemanticError> {
7678 let node_id = self.get_our_node_id();
7679 let expanded_key = &self.inbound_payment_key;
7680 let entropy = &*self.entropy_source;
7681 let secp_ctx = &self.secp_ctx;
7683 let path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7684 let builder = RefundBuilder::deriving_payer_id(
7685 description, node_id, expanded_key, entropy, secp_ctx, amount_msats, payment_id
7687 .chain_hash(self.chain_hash)
7688 .absolute_expiry(absolute_expiry)
7691 let expiration = StaleExpiration::AbsoluteTimeout(absolute_expiry);
7692 self.pending_outbound_payments
7693 .add_new_awaiting_invoice(
7694 payment_id, expiration, retry_strategy, max_total_routing_fee_msat,
7696 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7701 /// Pays for an [`Offer`] using the given parameters by creating an [`InvoiceRequest`] and
7702 /// enqueuing it to be sent via an onion message. [`ChannelManager`] will pay the actual
7703 /// [`Bolt12Invoice`] once it is received.
7705 /// Uses [`InvoiceRequestBuilder`] such that the [`InvoiceRequest`] it builds is recognized by
7706 /// the [`ChannelManager`] when handling a [`Bolt12Invoice`] message in response to the request.
7707 /// The optional parameters are used in the builder, if `Some`:
7708 /// - `quantity` for [`InvoiceRequest::quantity`] which must be set if
7709 /// [`Offer::expects_quantity`] is `true`.
7710 /// - `amount_msats` if overpaying what is required for the given `quantity` is desired, and
7711 /// - `payer_note` for [`InvoiceRequest::payer_note`].
7713 /// If `max_total_routing_fee_msat` is not specified, The default from
7714 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7718 /// The provided `payment_id` is used to ensure that only one invoice is paid for the request
7719 /// when received. See [Avoiding Duplicate Payments] for other requirements once the payment has
7722 /// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
7723 /// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
7724 /// payment will fail with an [`Event::InvoiceRequestFailed`].
7728 /// Uses a one-hop [`BlindedPath`] for the reply path with [`ChannelManager::get_our_node_id`]
7729 /// as the introduction node and a derived payer id for payer privacy. As such, currently, the
7730 /// node must be announced. Otherwise, there is no way to find a path to the introduction node
7731 /// in order to send the [`Bolt12Invoice`].
7735 /// Requires a direct connection to an introduction node in [`Offer::paths`] or to
7736 /// [`Offer::signing_pubkey`], if empty. A similar restriction applies to the responding
7737 /// [`Bolt12Invoice::payment_paths`].
7742 /// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
7743 /// - the provided parameters are invalid for the offer,
7744 /// - the parameterized [`Router`] is unable to create a blinded reply path for the invoice
7747 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7748 /// [`InvoiceRequest::quantity`]: crate::offers::invoice_request::InvoiceRequest::quantity
7749 /// [`InvoiceRequest::payer_note`]: crate::offers::invoice_request::InvoiceRequest::payer_note
7750 /// [`InvoiceRequestBuilder`]: crate::offers::invoice_request::InvoiceRequestBuilder
7751 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7752 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7753 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7754 pub fn pay_for_offer(
7755 &self, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>,
7756 payer_note: Option<String>, payment_id: PaymentId, retry_strategy: Retry,
7757 max_total_routing_fee_msat: Option<u64>
7758 ) -> Result<(), Bolt12SemanticError> {
7759 let expanded_key = &self.inbound_payment_key;
7760 let entropy = &*self.entropy_source;
7761 let secp_ctx = &self.secp_ctx;
7764 .request_invoice_deriving_payer_id(expanded_key, entropy, secp_ctx, payment_id)?
7765 .chain_hash(self.chain_hash)?;
7766 let builder = match quantity {
7768 Some(quantity) => builder.quantity(quantity)?,
7770 let builder = match amount_msats {
7772 Some(amount_msats) => builder.amount_msats(amount_msats)?,
7774 let builder = match payer_note {
7776 Some(payer_note) => builder.payer_note(payer_note),
7778 let invoice_request = builder.build_and_sign()?;
7779 let reply_path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7781 let expiration = StaleExpiration::TimerTicks(1);
7782 self.pending_outbound_payments
7783 .add_new_awaiting_invoice(
7784 payment_id, expiration, retry_strategy, max_total_routing_fee_msat
7786 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7788 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7789 if offer.paths().is_empty() {
7790 let message = new_pending_onion_message(
7791 OffersMessage::InvoiceRequest(invoice_request),
7792 Destination::Node(offer.signing_pubkey()),
7795 pending_offers_messages.push(message);
7797 // Send as many invoice requests as there are paths in the offer (with an upper bound).
7798 // Using only one path could result in a failure if the path no longer exists. But only
7799 // one invoice for a given payment id will be paid, even if more than one is received.
7800 const REQUEST_LIMIT: usize = 10;
7801 for path in offer.paths().into_iter().take(REQUEST_LIMIT) {
7802 let message = new_pending_onion_message(
7803 OffersMessage::InvoiceRequest(invoice_request.clone()),
7804 Destination::BlindedPath(path.clone()),
7805 Some(reply_path.clone()),
7807 pending_offers_messages.push(message);
7814 /// Creates a [`Bolt12Invoice`] for a [`Refund`] and enqueues it to be sent via an onion
7817 /// The resulting invoice uses a [`PaymentHash`] recognized by the [`ChannelManager`] and a
7818 /// [`BlindedPath`] containing the [`PaymentSecret`] needed to reconstruct the corresponding
7819 /// [`PaymentPreimage`].
7823 /// Requires a direct connection to an introduction node in [`Refund::paths`] or to
7824 /// [`Refund::payer_id`], if empty. This request is best effort; an invoice will be sent to each
7825 /// node meeting the aforementioned criteria, but there's no guarantee that they will be
7826 /// received and no retries will be made.
7830 /// Errors if the parameterized [`Router`] is unable to create a blinded payment path or reply
7831 /// path for the invoice.
7833 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7834 pub fn request_refund_payment(&self, refund: &Refund) -> Result<(), Bolt12SemanticError> {
7835 let expanded_key = &self.inbound_payment_key;
7836 let entropy = &*self.entropy_source;
7837 let secp_ctx = &self.secp_ctx;
7839 let amount_msats = refund.amount_msats();
7840 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
7842 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
7843 Ok((payment_hash, payment_secret)) => {
7844 let payment_paths = self.create_blinded_payment_paths(amount_msats, payment_secret)
7845 .map_err(|_| Bolt12SemanticError::MissingPaths)?;
7847 #[cfg(feature = "std")]
7848 let builder = refund.respond_using_derived_keys(
7849 payment_paths, payment_hash, expanded_key, entropy
7851 #[cfg(not(feature = "std"))]
7852 let created_at = Duration::from_secs(
7853 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
7855 #[cfg(not(feature = "std"))]
7856 let builder = refund.respond_using_derived_keys_no_std(
7857 payment_paths, payment_hash, created_at, expanded_key, entropy
7859 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
7860 let reply_path = self.create_blinded_path()
7861 .map_err(|_| Bolt12SemanticError::MissingPaths)?;
7863 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7864 if refund.paths().is_empty() {
7865 let message = new_pending_onion_message(
7866 OffersMessage::Invoice(invoice),
7867 Destination::Node(refund.payer_id()),
7870 pending_offers_messages.push(message);
7872 for path in refund.paths() {
7873 let message = new_pending_onion_message(
7874 OffersMessage::Invoice(invoice.clone()),
7875 Destination::BlindedPath(path.clone()),
7876 Some(reply_path.clone()),
7878 pending_offers_messages.push(message);
7884 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
7888 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
7891 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
7892 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
7894 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
7895 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
7896 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
7897 /// passed directly to [`claim_funds`].
7899 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
7901 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7902 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7906 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7907 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7909 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7911 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7912 /// on versions of LDK prior to 0.0.114.
7914 /// [`claim_funds`]: Self::claim_funds
7915 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7916 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
7917 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
7918 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
7919 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
7920 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
7921 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
7922 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
7923 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7924 min_final_cltv_expiry_delta)
7927 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
7928 /// stored external to LDK.
7930 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
7931 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
7932 /// the `min_value_msat` provided here, if one is provided.
7934 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
7935 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
7938 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
7939 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
7940 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
7941 /// sender "proof-of-payment" unless they have paid the required amount.
7943 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
7944 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
7945 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
7946 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
7947 /// invoices when no timeout is set.
7949 /// Note that we use block header time to time-out pending inbound payments (with some margin
7950 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
7951 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
7952 /// If you need exact expiry semantics, you should enforce them upon receipt of
7953 /// [`PaymentClaimable`].
7955 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
7956 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
7958 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7959 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7963 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7964 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7966 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7968 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7969 /// on versions of LDK prior to 0.0.114.
7971 /// [`create_inbound_payment`]: Self::create_inbound_payment
7972 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7973 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
7974 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
7975 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
7976 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7977 min_final_cltv_expiry)
7980 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
7981 /// previously returned from [`create_inbound_payment`].
7983 /// [`create_inbound_payment`]: Self::create_inbound_payment
7984 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
7985 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
7988 /// Creates a blinded path by delegating to [`MessageRouter::create_blinded_paths`].
7990 /// Errors if the `MessageRouter` errors or returns an empty `Vec`.
7991 fn create_blinded_path(&self) -> Result<BlindedPath, ()> {
7992 let recipient = self.get_our_node_id();
7993 let secp_ctx = &self.secp_ctx;
7995 let peers = self.per_peer_state.read().unwrap()
7997 .filter(|(_, peer)| peer.lock().unwrap().latest_features.supports_onion_messages())
7998 .map(|(node_id, _)| *node_id)
7999 .collect::<Vec<_>>();
8002 .create_blinded_paths(recipient, peers, secp_ctx)
8003 .and_then(|paths| paths.into_iter().next().ok_or(()))
8006 /// Creates multi-hop blinded payment paths for the given `amount_msats` by delegating to
8007 /// [`Router::create_blinded_payment_paths`].
8008 fn create_blinded_payment_paths(
8009 &self, amount_msats: u64, payment_secret: PaymentSecret
8010 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
8011 let secp_ctx = &self.secp_ctx;
8013 let first_hops = self.list_usable_channels();
8014 let payee_node_id = self.get_our_node_id();
8015 let max_cltv_expiry = self.best_block.read().unwrap().height() + CLTV_FAR_FAR_AWAY
8016 + LATENCY_GRACE_PERIOD_BLOCKS;
8017 let payee_tlvs = ReceiveTlvs {
8019 payment_constraints: PaymentConstraints {
8021 htlc_minimum_msat: 1,
8024 self.router.create_blinded_payment_paths(
8025 payee_node_id, first_hops, payee_tlvs, amount_msats, secp_ctx
8029 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
8030 /// are used when constructing the phantom invoice's route hints.
8032 /// [phantom node payments]: crate::sign::PhantomKeysManager
8033 pub fn get_phantom_scid(&self) -> u64 {
8034 let best_block_height = self.best_block.read().unwrap().height();
8035 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
8037 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
8038 // Ensure the generated scid doesn't conflict with a real channel.
8039 match short_to_chan_info.get(&scid_candidate) {
8040 Some(_) => continue,
8041 None => return scid_candidate
8046 /// Gets route hints for use in receiving [phantom node payments].
8048 /// [phantom node payments]: crate::sign::PhantomKeysManager
8049 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
8051 channels: self.list_usable_channels(),
8052 phantom_scid: self.get_phantom_scid(),
8053 real_node_pubkey: self.get_our_node_id(),
8057 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
8058 /// used when constructing the route hints for HTLCs intended to be intercepted. See
8059 /// [`ChannelManager::forward_intercepted_htlc`].
8061 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
8062 /// times to get a unique scid.
8063 pub fn get_intercept_scid(&self) -> u64 {
8064 let best_block_height = self.best_block.read().unwrap().height();
8065 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
8067 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
8068 // Ensure the generated scid doesn't conflict with a real channel.
8069 if short_to_chan_info.contains_key(&scid_candidate) { continue }
8070 return scid_candidate
8074 /// Gets inflight HTLC information by processing pending outbound payments that are in
8075 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
8076 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
8077 let mut inflight_htlcs = InFlightHtlcs::new();
8079 let per_peer_state = self.per_peer_state.read().unwrap();
8080 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8081 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8082 let peer_state = &mut *peer_state_lock;
8083 for chan in peer_state.channel_by_id.values().filter_map(
8084 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
8086 for (htlc_source, _) in chan.inflight_htlc_sources() {
8087 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
8088 inflight_htlcs.process_path(path, self.get_our_node_id());
8097 #[cfg(any(test, feature = "_test_utils"))]
8098 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
8099 let events = core::cell::RefCell::new(Vec::new());
8100 let event_handler = |event: events::Event| events.borrow_mut().push(event);
8101 self.process_pending_events(&event_handler);
8105 #[cfg(feature = "_test_utils")]
8106 pub fn push_pending_event(&self, event: events::Event) {
8107 let mut events = self.pending_events.lock().unwrap();
8108 events.push_back((event, None));
8112 pub fn pop_pending_event(&self) -> Option<events::Event> {
8113 let mut events = self.pending_events.lock().unwrap();
8114 events.pop_front().map(|(e, _)| e)
8118 pub fn has_pending_payments(&self) -> bool {
8119 self.pending_outbound_payments.has_pending_payments()
8123 pub fn clear_pending_payments(&self) {
8124 self.pending_outbound_payments.clear_pending_payments()
8127 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
8128 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
8129 /// operation. It will double-check that nothing *else* is also blocking the same channel from
8130 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
8131 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey,
8132 channel_funding_outpoint: OutPoint, channel_id: ChannelId,
8133 mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
8135 let logger = WithContext::from(
8136 &self.logger, Some(counterparty_node_id), Some(channel_id),
8139 let per_peer_state = self.per_peer_state.read().unwrap();
8140 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
8141 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
8142 let peer_state = &mut *peer_state_lck;
8143 if let Some(blocker) = completed_blocker.take() {
8144 // Only do this on the first iteration of the loop.
8145 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
8146 .get_mut(&channel_id)
8148 blockers.retain(|iter| iter != &blocker);
8152 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
8153 channel_funding_outpoint, channel_id, counterparty_node_id) {
8154 // Check that, while holding the peer lock, we don't have anything else
8155 // blocking monitor updates for this channel. If we do, release the monitor
8156 // update(s) when those blockers complete.
8157 log_trace!(logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
8162 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(
8164 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
8165 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
8166 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
8167 log_debug!(logger, "Unlocking monitor updating for channel {} and updating monitor",
8169 handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
8170 peer_state_lck, peer_state, per_peer_state, chan);
8171 if further_update_exists {
8172 // If there are more `ChannelMonitorUpdate`s to process, restart at the
8177 log_trace!(logger, "Unlocked monitor updating for channel {} without monitors to update",
8184 "Got a release post-RAA monitor update for peer {} but the channel is gone",
8185 log_pubkey!(counterparty_node_id));
8191 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
8192 for action in actions {
8194 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
8195 channel_funding_outpoint, channel_id, counterparty_node_id
8197 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, channel_id, None);
8203 /// Processes any events asynchronously in the order they were generated since the last call
8204 /// using the given event handler.
8206 /// See the trait-level documentation of [`EventsProvider`] for requirements.
8207 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
8211 process_events_body!(self, ev, { handler(ev).await });
8215 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>
8217 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8218 T::Target: BroadcasterInterface,
8219 ES::Target: EntropySource,
8220 NS::Target: NodeSigner,
8221 SP::Target: SignerProvider,
8222 F::Target: FeeEstimator,
8226 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
8227 /// The returned array will contain `MessageSendEvent`s for different peers if
8228 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
8229 /// is always placed next to each other.
8231 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
8232 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
8233 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
8234 /// will randomly be placed first or last in the returned array.
8236 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
8237 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
8238 /// the `MessageSendEvent`s to the specific peer they were generated under.
8239 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
8240 let events = RefCell::new(Vec::new());
8241 PersistenceNotifierGuard::optionally_notify(self, || {
8242 let mut result = NotifyOption::SkipPersistNoEvents;
8244 // TODO: This behavior should be documented. It's unintuitive that we query
8245 // ChannelMonitors when clearing other events.
8246 if self.process_pending_monitor_events() {
8247 result = NotifyOption::DoPersist;
8250 if self.check_free_holding_cells() {
8251 result = NotifyOption::DoPersist;
8253 if self.maybe_generate_initial_closing_signed() {
8254 result = NotifyOption::DoPersist;
8257 let mut pending_events = Vec::new();
8258 let per_peer_state = self.per_peer_state.read().unwrap();
8259 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8260 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8261 let peer_state = &mut *peer_state_lock;
8262 if peer_state.pending_msg_events.len() > 0 {
8263 pending_events.append(&mut peer_state.pending_msg_events);
8267 if !pending_events.is_empty() {
8268 events.replace(pending_events);
8277 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>
8279 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8280 T::Target: BroadcasterInterface,
8281 ES::Target: EntropySource,
8282 NS::Target: NodeSigner,
8283 SP::Target: SignerProvider,
8284 F::Target: FeeEstimator,
8288 /// Processes events that must be periodically handled.
8290 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
8291 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
8292 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
8294 process_events_body!(self, ev, handler.handle_event(ev));
8298 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>
8300 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8301 T::Target: BroadcasterInterface,
8302 ES::Target: EntropySource,
8303 NS::Target: NodeSigner,
8304 SP::Target: SignerProvider,
8305 F::Target: FeeEstimator,
8309 fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
8311 let best_block = self.best_block.read().unwrap();
8312 assert_eq!(best_block.block_hash(), header.prev_blockhash,
8313 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
8314 assert_eq!(best_block.height(), height - 1,
8315 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
8318 self.transactions_confirmed(header, txdata, height);
8319 self.best_block_updated(header, height);
8322 fn block_disconnected(&self, header: &Header, height: u32) {
8323 let _persistence_guard =
8324 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8325 self, || -> NotifyOption { NotifyOption::DoPersist });
8326 let new_height = height - 1;
8328 let mut best_block = self.best_block.write().unwrap();
8329 assert_eq!(best_block.block_hash(), header.block_hash(),
8330 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
8331 assert_eq!(best_block.height(), height,
8332 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
8333 *best_block = BestBlock::new(header.prev_blockhash, new_height)
8336 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, &&WithChannelContext::from(&self.logger, &channel.context)));
8340 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>
8342 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8343 T::Target: BroadcasterInterface,
8344 ES::Target: EntropySource,
8345 NS::Target: NodeSigner,
8346 SP::Target: SignerProvider,
8347 F::Target: FeeEstimator,
8351 fn transactions_confirmed(&self, header: &Header, txdata: &TransactionData, height: u32) {
8352 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8353 // during initialization prior to the chain_monitor being fully configured in some cases.
8354 // See the docs for `ChannelManagerReadArgs` for more.
8356 let block_hash = header.block_hash();
8357 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
8359 let _persistence_guard =
8360 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8361 self, || -> NotifyOption { NotifyOption::DoPersist });
8362 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.chain_hash, &self.node_signer, &self.default_configuration, &&WithChannelContext::from(&self.logger, &channel.context))
8363 .map(|(a, b)| (a, Vec::new(), b)));
8365 let last_best_block_height = self.best_block.read().unwrap().height();
8366 if height < last_best_block_height {
8367 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
8368 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, &&WithChannelContext::from(&self.logger, &channel.context)));
8372 fn best_block_updated(&self, header: &Header, height: u32) {
8373 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8374 // during initialization prior to the chain_monitor being fully configured in some cases.
8375 // See the docs for `ChannelManagerReadArgs` for more.
8377 let block_hash = header.block_hash();
8378 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
8380 let _persistence_guard =
8381 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8382 self, || -> NotifyOption { NotifyOption::DoPersist });
8383 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
8385 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.chain_hash, &self.node_signer, &self.default_configuration, &&WithChannelContext::from(&self.logger, &channel.context)));
8387 macro_rules! max_time {
8388 ($timestamp: expr) => {
8390 // Update $timestamp to be the max of its current value and the block
8391 // timestamp. This should keep us close to the current time without relying on
8392 // having an explicit local time source.
8393 // Just in case we end up in a race, we loop until we either successfully
8394 // update $timestamp or decide we don't need to.
8395 let old_serial = $timestamp.load(Ordering::Acquire);
8396 if old_serial >= header.time as usize { break; }
8397 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
8403 max_time!(self.highest_seen_timestamp);
8404 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
8405 payment_secrets.retain(|_, inbound_payment| {
8406 inbound_payment.expiry_time > header.time as u64
8410 fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
8411 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
8412 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
8413 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8414 let peer_state = &mut *peer_state_lock;
8415 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
8416 let txid_opt = chan.context.get_funding_txo();
8417 let height_opt = chan.context.get_funding_tx_confirmation_height();
8418 let hash_opt = chan.context.get_funding_tx_confirmed_in();
8419 if let (Some(funding_txo), Some(conf_height), Some(block_hash)) = (txid_opt, height_opt, hash_opt) {
8420 res.push((funding_txo.txid, conf_height, Some(block_hash)));
8427 fn transaction_unconfirmed(&self, txid: &Txid) {
8428 let _persistence_guard =
8429 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8430 self, || -> NotifyOption { NotifyOption::DoPersist });
8431 self.do_chain_event(None, |channel| {
8432 if let Some(funding_txo) = channel.context.get_funding_txo() {
8433 if funding_txo.txid == *txid {
8434 channel.funding_transaction_unconfirmed(&&WithChannelContext::from(&self.logger, &channel.context)).map(|()| (None, Vec::new(), None))
8435 } else { Ok((None, Vec::new(), None)) }
8436 } else { Ok((None, Vec::new(), None)) }
8441 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>
8443 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8444 T::Target: BroadcasterInterface,
8445 ES::Target: EntropySource,
8446 NS::Target: NodeSigner,
8447 SP::Target: SignerProvider,
8448 F::Target: FeeEstimator,
8452 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
8453 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
8455 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
8456 (&self, height_opt: Option<u32>, f: FN) {
8457 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8458 // during initialization prior to the chain_monitor being fully configured in some cases.
8459 // See the docs for `ChannelManagerReadArgs` for more.
8461 let mut failed_channels = Vec::new();
8462 let mut timed_out_htlcs = Vec::new();
8464 let per_peer_state = self.per_peer_state.read().unwrap();
8465 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8466 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8467 let peer_state = &mut *peer_state_lock;
8468 let pending_msg_events = &mut peer_state.pending_msg_events;
8469 peer_state.channel_by_id.retain(|_, phase| {
8471 // Retain unfunded channels.
8472 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
8473 ChannelPhase::Funded(channel) => {
8474 let res = f(channel);
8475 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
8476 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
8477 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
8478 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
8479 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
8481 let logger = WithChannelContext::from(&self.logger, &channel.context);
8482 if let Some(channel_ready) = channel_ready_opt {
8483 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
8484 if channel.context.is_usable() {
8485 log_trace!(logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
8486 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
8487 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
8488 node_id: channel.context.get_counterparty_node_id(),
8493 log_trace!(logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
8498 let mut pending_events = self.pending_events.lock().unwrap();
8499 emit_channel_ready_event!(pending_events, channel);
8502 if let Some(announcement_sigs) = announcement_sigs {
8503 log_trace!(logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
8504 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
8505 node_id: channel.context.get_counterparty_node_id(),
8506 msg: announcement_sigs,
8508 if let Some(height) = height_opt {
8509 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.chain_hash, height, &self.default_configuration) {
8510 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
8512 // Note that announcement_signatures fails if the channel cannot be announced,
8513 // so get_channel_update_for_broadcast will never fail by the time we get here.
8514 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
8519 if channel.is_our_channel_ready() {
8520 if let Some(real_scid) = channel.context.get_short_channel_id() {
8521 // If we sent a 0conf channel_ready, and now have an SCID, we add it
8522 // to the short_to_chan_info map here. Note that we check whether we
8523 // can relay using the real SCID at relay-time (i.e.
8524 // enforce option_scid_alias then), and if the funding tx is ever
8525 // un-confirmed we force-close the channel, ensuring short_to_chan_info
8526 // is always consistent.
8527 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
8528 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8529 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
8530 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
8531 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
8534 } else if let Err(reason) = res {
8535 update_maps_on_chan_removal!(self, &channel.context);
8536 // It looks like our counterparty went on-chain or funding transaction was
8537 // reorged out of the main chain. Close the channel.
8538 let reason_message = format!("{}", reason);
8539 failed_channels.push(channel.context.force_shutdown(true, reason));
8540 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
8541 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
8545 pending_msg_events.push(events::MessageSendEvent::HandleError {
8546 node_id: channel.context.get_counterparty_node_id(),
8547 action: msgs::ErrorAction::DisconnectPeer {
8548 msg: Some(msgs::ErrorMessage {
8549 channel_id: channel.context.channel_id(),
8550 data: reason_message,
8563 if let Some(height) = height_opt {
8564 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
8565 payment.htlcs.retain(|htlc| {
8566 // If height is approaching the number of blocks we think it takes us to get
8567 // our commitment transaction confirmed before the HTLC expires, plus the
8568 // number of blocks we generally consider it to take to do a commitment update,
8569 // just give up on it and fail the HTLC.
8570 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
8571 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
8572 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
8574 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
8575 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
8576 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
8580 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
8583 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
8584 intercepted_htlcs.retain(|_, htlc| {
8585 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
8586 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
8587 short_channel_id: htlc.prev_short_channel_id,
8588 user_channel_id: Some(htlc.prev_user_channel_id),
8589 htlc_id: htlc.prev_htlc_id,
8590 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
8591 phantom_shared_secret: None,
8592 outpoint: htlc.prev_funding_outpoint,
8593 channel_id: htlc.prev_channel_id,
8594 blinded_failure: htlc.forward_info.routing.blinded_failure(),
8597 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
8598 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
8599 _ => unreachable!(),
8601 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
8602 HTLCFailReason::from_failure_code(0x2000 | 2),
8603 HTLCDestination::InvalidForward { requested_forward_scid }));
8604 let logger = WithContext::from(
8605 &self.logger, None, Some(htlc.prev_channel_id)
8607 log_trace!(logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
8613 self.handle_init_event_channel_failures(failed_channels);
8615 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
8616 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
8620 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
8621 /// may have events that need processing.
8623 /// In order to check if this [`ChannelManager`] needs persisting, call
8624 /// [`Self::get_and_clear_needs_persistence`].
8626 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
8627 /// [`ChannelManager`] and should instead register actions to be taken later.
8628 pub fn get_event_or_persistence_needed_future(&self) -> Future {
8629 self.event_persist_notifier.get_future()
8632 /// Returns true if this [`ChannelManager`] needs to be persisted.
8633 pub fn get_and_clear_needs_persistence(&self) -> bool {
8634 self.needs_persist_flag.swap(false, Ordering::AcqRel)
8637 #[cfg(any(test, feature = "_test_utils"))]
8638 pub fn get_event_or_persist_condvar_value(&self) -> bool {
8639 self.event_persist_notifier.notify_pending()
8642 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
8643 /// [`chain::Confirm`] interfaces.
8644 pub fn current_best_block(&self) -> BestBlock {
8645 self.best_block.read().unwrap().clone()
8648 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
8649 /// [`ChannelManager`].
8650 pub fn node_features(&self) -> NodeFeatures {
8651 provided_node_features(&self.default_configuration)
8654 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
8655 /// [`ChannelManager`].
8657 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8658 /// or not. Thus, this method is not public.
8659 #[cfg(any(feature = "_test_utils", test))]
8660 pub fn bolt11_invoice_features(&self) -> Bolt11InvoiceFeatures {
8661 provided_bolt11_invoice_features(&self.default_configuration)
8664 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
8665 /// [`ChannelManager`].
8666 fn bolt12_invoice_features(&self) -> Bolt12InvoiceFeatures {
8667 provided_bolt12_invoice_features(&self.default_configuration)
8670 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
8671 /// [`ChannelManager`].
8672 pub fn channel_features(&self) -> ChannelFeatures {
8673 provided_channel_features(&self.default_configuration)
8676 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
8677 /// [`ChannelManager`].
8678 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
8679 provided_channel_type_features(&self.default_configuration)
8682 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
8683 /// [`ChannelManager`].
8684 pub fn init_features(&self) -> InitFeatures {
8685 provided_init_features(&self.default_configuration)
8689 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8690 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
8692 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8693 T::Target: BroadcasterInterface,
8694 ES::Target: EntropySource,
8695 NS::Target: NodeSigner,
8696 SP::Target: SignerProvider,
8697 F::Target: FeeEstimator,
8701 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
8702 // Note that we never need to persist the updated ChannelManager for an inbound
8703 // open_channel message - pre-funded channels are never written so there should be no
8704 // change to the contents.
8705 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8706 let res = self.internal_open_channel(counterparty_node_id, msg);
8707 let persist = match &res {
8708 Err(e) if e.closes_channel() => {
8709 debug_assert!(false, "We shouldn't close a new channel");
8710 NotifyOption::DoPersist
8712 _ => NotifyOption::SkipPersistHandleEvents,
8714 let _ = handle_error!(self, res, *counterparty_node_id);
8719 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
8720 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8721 "Dual-funded channels not supported".to_owned(),
8722 msg.common_fields.temporary_channel_id.clone())), *counterparty_node_id);
8725 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
8726 // Note that we never need to persist the updated ChannelManager for an inbound
8727 // accept_channel message - pre-funded channels are never written so there should be no
8728 // change to the contents.
8729 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8730 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
8731 NotifyOption::SkipPersistHandleEvents
8735 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
8736 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8737 "Dual-funded channels not supported".to_owned(),
8738 msg.common_fields.temporary_channel_id.clone())), *counterparty_node_id);
8741 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
8742 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8743 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
8746 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
8747 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8748 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
8751 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
8752 // Note that we never need to persist the updated ChannelManager for an inbound
8753 // channel_ready message - while the channel's state will change, any channel_ready message
8754 // will ultimately be re-sent on startup and the `ChannelMonitor` won't be updated so we
8755 // will not force-close the channel on startup.
8756 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8757 let res = self.internal_channel_ready(counterparty_node_id, msg);
8758 let persist = match &res {
8759 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8760 _ => NotifyOption::SkipPersistHandleEvents,
8762 let _ = handle_error!(self, res, *counterparty_node_id);
8767 fn handle_stfu(&self, counterparty_node_id: &PublicKey, msg: &msgs::Stfu) {
8768 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8769 "Quiescence not supported".to_owned(),
8770 msg.channel_id.clone())), *counterparty_node_id);
8773 fn handle_splice(&self, counterparty_node_id: &PublicKey, msg: &msgs::Splice) {
8774 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8775 "Splicing not supported".to_owned(),
8776 msg.channel_id.clone())), *counterparty_node_id);
8779 fn handle_splice_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceAck) {
8780 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8781 "Splicing not supported (splice_ack)".to_owned(),
8782 msg.channel_id.clone())), *counterparty_node_id);
8785 fn handle_splice_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
8786 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8787 "Splicing not supported (splice_locked)".to_owned(),
8788 msg.channel_id.clone())), *counterparty_node_id);
8791 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
8792 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8793 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
8796 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
8797 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8798 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
8801 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
8802 // Note that we never need to persist the updated ChannelManager for an inbound
8803 // update_add_htlc message - the message itself doesn't change our channel state only the
8804 // `commitment_signed` message afterwards will.
8805 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8806 let res = self.internal_update_add_htlc(counterparty_node_id, msg);
8807 let persist = match &res {
8808 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8809 Err(_) => NotifyOption::SkipPersistHandleEvents,
8810 Ok(()) => NotifyOption::SkipPersistNoEvents,
8812 let _ = handle_error!(self, res, *counterparty_node_id);
8817 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
8818 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8819 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
8822 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
8823 // Note that we never need to persist the updated ChannelManager for an inbound
8824 // update_fail_htlc message - the message itself doesn't change our channel state only the
8825 // `commitment_signed` message afterwards will.
8826 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8827 let res = self.internal_update_fail_htlc(counterparty_node_id, msg);
8828 let persist = match &res {
8829 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8830 Err(_) => NotifyOption::SkipPersistHandleEvents,
8831 Ok(()) => NotifyOption::SkipPersistNoEvents,
8833 let _ = handle_error!(self, res, *counterparty_node_id);
8838 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
8839 // Note that we never need to persist the updated ChannelManager for an inbound
8840 // update_fail_malformed_htlc message - the message itself doesn't change our channel state
8841 // only the `commitment_signed` message afterwards will.
8842 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8843 let res = self.internal_update_fail_malformed_htlc(counterparty_node_id, msg);
8844 let persist = match &res {
8845 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8846 Err(_) => NotifyOption::SkipPersistHandleEvents,
8847 Ok(()) => NotifyOption::SkipPersistNoEvents,
8849 let _ = handle_error!(self, res, *counterparty_node_id);
8854 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
8855 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8856 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
8859 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
8860 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8861 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
8864 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
8865 // Note that we never need to persist the updated ChannelManager for an inbound
8866 // update_fee message - the message itself doesn't change our channel state only the
8867 // `commitment_signed` message afterwards will.
8868 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8869 let res = self.internal_update_fee(counterparty_node_id, msg);
8870 let persist = match &res {
8871 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8872 Err(_) => NotifyOption::SkipPersistHandleEvents,
8873 Ok(()) => NotifyOption::SkipPersistNoEvents,
8875 let _ = handle_error!(self, res, *counterparty_node_id);
8880 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
8881 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8882 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
8885 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
8886 PersistenceNotifierGuard::optionally_notify(self, || {
8887 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
8890 NotifyOption::DoPersist
8895 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
8896 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8897 let res = self.internal_channel_reestablish(counterparty_node_id, msg);
8898 let persist = match &res {
8899 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8900 Err(_) => NotifyOption::SkipPersistHandleEvents,
8901 Ok(persist) => *persist,
8903 let _ = handle_error!(self, res, *counterparty_node_id);
8908 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
8909 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(
8910 self, || NotifyOption::SkipPersistHandleEvents);
8911 let mut failed_channels = Vec::new();
8912 let mut per_peer_state = self.per_peer_state.write().unwrap();
8915 WithContext::from(&self.logger, Some(*counterparty_node_id), None),
8916 "Marking channels with {} disconnected and generating channel_updates.",
8917 log_pubkey!(counterparty_node_id)
8919 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8920 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8921 let peer_state = &mut *peer_state_lock;
8922 let pending_msg_events = &mut peer_state.pending_msg_events;
8923 peer_state.channel_by_id.retain(|_, phase| {
8924 let context = match phase {
8925 ChannelPhase::Funded(chan) => {
8926 let logger = WithChannelContext::from(&self.logger, &chan.context);
8927 if chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok() {
8928 // We only retain funded channels that are not shutdown.
8933 // We retain UnfundedOutboundV1 channel for some time in case
8934 // peer unexpectedly disconnects, and intends to reconnect again.
8935 ChannelPhase::UnfundedOutboundV1(_) => {
8938 // Unfunded inbound channels will always be removed.
8939 ChannelPhase::UnfundedInboundV1(chan) => {
8943 // Clean up for removal.
8944 update_maps_on_chan_removal!(self, &context);
8945 failed_channels.push(context.force_shutdown(false, ClosureReason::DisconnectedPeer));
8948 // Note that we don't bother generating any events for pre-accept channels -
8949 // they're not considered "channels" yet from the PoV of our events interface.
8950 peer_state.inbound_channel_request_by_id.clear();
8951 pending_msg_events.retain(|msg| {
8953 // V1 Channel Establishment
8954 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
8955 &events::MessageSendEvent::SendOpenChannel { .. } => false,
8956 &events::MessageSendEvent::SendFundingCreated { .. } => false,
8957 &events::MessageSendEvent::SendFundingSigned { .. } => false,
8958 // V2 Channel Establishment
8959 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
8960 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
8961 // Common Channel Establishment
8962 &events::MessageSendEvent::SendChannelReady { .. } => false,
8963 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
8965 &events::MessageSendEvent::SendStfu { .. } => false,
8967 &events::MessageSendEvent::SendSplice { .. } => false,
8968 &events::MessageSendEvent::SendSpliceAck { .. } => false,
8969 &events::MessageSendEvent::SendSpliceLocked { .. } => false,
8970 // Interactive Transaction Construction
8971 &events::MessageSendEvent::SendTxAddInput { .. } => false,
8972 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
8973 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
8974 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
8975 &events::MessageSendEvent::SendTxComplete { .. } => false,
8976 &events::MessageSendEvent::SendTxSignatures { .. } => false,
8977 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
8978 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
8979 &events::MessageSendEvent::SendTxAbort { .. } => false,
8980 // Channel Operations
8981 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
8982 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
8983 &events::MessageSendEvent::SendClosingSigned { .. } => false,
8984 &events::MessageSendEvent::SendShutdown { .. } => false,
8985 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
8986 &events::MessageSendEvent::HandleError { .. } => false,
8988 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
8989 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
8990 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
8991 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
8992 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
8993 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
8994 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
8995 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
8996 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
8999 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
9000 peer_state.is_connected = false;
9001 peer_state.ok_to_remove(true)
9002 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
9005 per_peer_state.remove(counterparty_node_id);
9007 mem::drop(per_peer_state);
9009 for failure in failed_channels.drain(..) {
9010 self.finish_close_channel(failure);
9014 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
9015 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), None);
9016 if !init_msg.features.supports_static_remote_key() {
9017 log_debug!(logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
9021 let mut res = Ok(());
9023 PersistenceNotifierGuard::optionally_notify(self, || {
9024 // If we have too many peers connected which don't have funded channels, disconnect the
9025 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
9026 // unfunded channels taking up space in memory for disconnected peers, we still let new
9027 // peers connect, but we'll reject new channels from them.
9028 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
9029 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
9032 let mut peer_state_lock = self.per_peer_state.write().unwrap();
9033 match peer_state_lock.entry(counterparty_node_id.clone()) {
9034 hash_map::Entry::Vacant(e) => {
9035 if inbound_peer_limited {
9037 return NotifyOption::SkipPersistNoEvents;
9039 e.insert(Mutex::new(PeerState {
9040 channel_by_id: new_hash_map(),
9041 inbound_channel_request_by_id: new_hash_map(),
9042 latest_features: init_msg.features.clone(),
9043 pending_msg_events: Vec::new(),
9044 in_flight_monitor_updates: BTreeMap::new(),
9045 monitor_update_blocked_actions: BTreeMap::new(),
9046 actions_blocking_raa_monitor_updates: BTreeMap::new(),
9050 hash_map::Entry::Occupied(e) => {
9051 let mut peer_state = e.get().lock().unwrap();
9052 peer_state.latest_features = init_msg.features.clone();
9054 let best_block_height = self.best_block.read().unwrap().height();
9055 if inbound_peer_limited &&
9056 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
9057 peer_state.channel_by_id.len()
9060 return NotifyOption::SkipPersistNoEvents;
9063 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
9064 peer_state.is_connected = true;
9069 log_debug!(logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
9071 let per_peer_state = self.per_peer_state.read().unwrap();
9072 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
9073 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9074 let peer_state = &mut *peer_state_lock;
9075 let pending_msg_events = &mut peer_state.pending_msg_events;
9077 for (_, phase) in peer_state.channel_by_id.iter_mut() {
9079 ChannelPhase::Funded(chan) => {
9080 let logger = WithChannelContext::from(&self.logger, &chan.context);
9081 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
9082 node_id: chan.context.get_counterparty_node_id(),
9083 msg: chan.get_channel_reestablish(&&logger),
9087 ChannelPhase::UnfundedOutboundV1(chan) => {
9088 pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
9089 node_id: chan.context.get_counterparty_node_id(),
9090 msg: chan.get_open_channel(self.chain_hash),
9094 ChannelPhase::UnfundedInboundV1(_) => {
9095 // Since unfunded inbound channel maps are cleared upon disconnecting a peer,
9096 // they are not persisted and won't be recovered after a crash.
9097 // Therefore, they shouldn't exist at this point.
9098 debug_assert!(false);
9104 return NotifyOption::SkipPersistHandleEvents;
9105 //TODO: Also re-broadcast announcement_signatures
9110 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
9111 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
9113 match &msg.data as &str {
9114 "cannot co-op close channel w/ active htlcs"|
9115 "link failed to shutdown" =>
9117 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
9118 // send one while HTLCs are still present. The issue is tracked at
9119 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
9120 // to fix it but none so far have managed to land upstream. The issue appears to be
9121 // very low priority for the LND team despite being marked "P1".
9122 // We're not going to bother handling this in a sensible way, instead simply
9123 // repeating the Shutdown message on repeat until morale improves.
9124 if !msg.channel_id.is_zero() {
9125 let per_peer_state = self.per_peer_state.read().unwrap();
9126 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9127 if peer_state_mutex_opt.is_none() { return; }
9128 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
9129 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
9130 if let Some(msg) = chan.get_outbound_shutdown() {
9131 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
9132 node_id: *counterparty_node_id,
9136 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
9137 node_id: *counterparty_node_id,
9138 action: msgs::ErrorAction::SendWarningMessage {
9139 msg: msgs::WarningMessage {
9140 channel_id: msg.channel_id,
9141 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
9143 log_level: Level::Trace,
9153 if msg.channel_id.is_zero() {
9154 let channel_ids: Vec<ChannelId> = {
9155 let per_peer_state = self.per_peer_state.read().unwrap();
9156 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9157 if peer_state_mutex_opt.is_none() { return; }
9158 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
9159 let peer_state = &mut *peer_state_lock;
9160 // Note that we don't bother generating any events for pre-accept channels -
9161 // they're not considered "channels" yet from the PoV of our events interface.
9162 peer_state.inbound_channel_request_by_id.clear();
9163 peer_state.channel_by_id.keys().cloned().collect()
9165 for channel_id in channel_ids {
9166 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
9167 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
9171 // First check if we can advance the channel type and try again.
9172 let per_peer_state = self.per_peer_state.read().unwrap();
9173 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9174 if peer_state_mutex_opt.is_none() { return; }
9175 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
9176 let peer_state = &mut *peer_state_lock;
9177 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
9178 if let Ok(msg) = chan.maybe_handle_error_without_close(self.chain_hash, &self.fee_estimator) {
9179 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
9180 node_id: *counterparty_node_id,
9188 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
9189 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
9193 fn provided_node_features(&self) -> NodeFeatures {
9194 provided_node_features(&self.default_configuration)
9197 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
9198 provided_init_features(&self.default_configuration)
9201 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
9202 Some(vec![self.chain_hash])
9205 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
9206 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9207 "Dual-funded channels not supported".to_owned(),
9208 msg.channel_id.clone())), *counterparty_node_id);
9211 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
9212 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9213 "Dual-funded channels not supported".to_owned(),
9214 msg.channel_id.clone())), *counterparty_node_id);
9217 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
9218 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9219 "Dual-funded channels not supported".to_owned(),
9220 msg.channel_id.clone())), *counterparty_node_id);
9223 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
9224 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9225 "Dual-funded channels not supported".to_owned(),
9226 msg.channel_id.clone())), *counterparty_node_id);
9229 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
9230 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9231 "Dual-funded channels not supported".to_owned(),
9232 msg.channel_id.clone())), *counterparty_node_id);
9235 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
9236 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9237 "Dual-funded channels not supported".to_owned(),
9238 msg.channel_id.clone())), *counterparty_node_id);
9241 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
9242 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9243 "Dual-funded channels not supported".to_owned(),
9244 msg.channel_id.clone())), *counterparty_node_id);
9247 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
9248 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9249 "Dual-funded channels not supported".to_owned(),
9250 msg.channel_id.clone())), *counterparty_node_id);
9253 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
9254 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9255 "Dual-funded channels not supported".to_owned(),
9256 msg.channel_id.clone())), *counterparty_node_id);
9260 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9261 OffersMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
9263 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9264 T::Target: BroadcasterInterface,
9265 ES::Target: EntropySource,
9266 NS::Target: NodeSigner,
9267 SP::Target: SignerProvider,
9268 F::Target: FeeEstimator,
9272 fn handle_message(&self, message: OffersMessage) -> Option<OffersMessage> {
9273 let secp_ctx = &self.secp_ctx;
9274 let expanded_key = &self.inbound_payment_key;
9277 OffersMessage::InvoiceRequest(invoice_request) => {
9278 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
9281 Ok(amount_msats) => amount_msats,
9282 Err(error) => return Some(OffersMessage::InvoiceError(error.into())),
9284 let invoice_request = match invoice_request.verify(expanded_key, secp_ctx) {
9285 Ok(invoice_request) => invoice_request,
9287 let error = Bolt12SemanticError::InvalidMetadata;
9288 return Some(OffersMessage::InvoiceError(error.into()));
9292 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
9293 let (payment_hash, payment_secret) = match self.create_inbound_payment(
9294 Some(amount_msats), relative_expiry, None
9296 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
9298 let error = Bolt12SemanticError::InvalidAmount;
9299 return Some(OffersMessage::InvoiceError(error.into()));
9303 let payment_paths = match self.create_blinded_payment_paths(
9304 amount_msats, payment_secret
9306 Ok(payment_paths) => payment_paths,
9308 let error = Bolt12SemanticError::MissingPaths;
9309 return Some(OffersMessage::InvoiceError(error.into()));
9313 #[cfg(not(feature = "std"))]
9314 let created_at = Duration::from_secs(
9315 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9318 if invoice_request.keys.is_some() {
9319 #[cfg(feature = "std")]
9320 let builder = invoice_request.respond_using_derived_keys(
9321 payment_paths, payment_hash
9323 #[cfg(not(feature = "std"))]
9324 let builder = invoice_request.respond_using_derived_keys_no_std(
9325 payment_paths, payment_hash, created_at
9327 match builder.and_then(|b| b.allow_mpp().build_and_sign(secp_ctx)) {
9328 Ok(invoice) => Some(OffersMessage::Invoice(invoice)),
9329 Err(error) => Some(OffersMessage::InvoiceError(error.into())),
9332 #[cfg(feature = "std")]
9333 let builder = invoice_request.respond_with(payment_paths, payment_hash);
9334 #[cfg(not(feature = "std"))]
9335 let builder = invoice_request.respond_with_no_std(
9336 payment_paths, payment_hash, created_at
9338 let response = builder.and_then(|builder| builder.allow_mpp().build())
9339 .map_err(|e| OffersMessage::InvoiceError(e.into()))
9341 match invoice.sign(|invoice| self.node_signer.sign_bolt12_invoice(invoice)) {
9342 Ok(invoice) => Ok(OffersMessage::Invoice(invoice)),
9343 Err(SignError::Signing(())) => Err(OffersMessage::InvoiceError(
9344 InvoiceError::from_string("Failed signing invoice".to_string())
9346 Err(SignError::Verification(_)) => Err(OffersMessage::InvoiceError(
9347 InvoiceError::from_string("Failed invoice signature verification".to_string())
9351 Ok(invoice) => Some(invoice),
9352 Err(error) => Some(error),
9356 OffersMessage::Invoice(invoice) => {
9357 match invoice.verify(expanded_key, secp_ctx) {
9359 Some(OffersMessage::InvoiceError(InvoiceError::from_string("Unrecognized invoice".to_owned())))
9361 Ok(_) if invoice.invoice_features().requires_unknown_bits_from(&self.bolt12_invoice_features()) => {
9362 Some(OffersMessage::InvoiceError(Bolt12SemanticError::UnknownRequiredFeatures.into()))
9365 if let Err(e) = self.send_payment_for_bolt12_invoice(&invoice, payment_id) {
9366 log_trace!(self.logger, "Failed paying invoice: {:?}", e);
9367 Some(OffersMessage::InvoiceError(InvoiceError::from_string(format!("{:?}", e))))
9374 OffersMessage::InvoiceError(invoice_error) => {
9375 log_trace!(self.logger, "Received invoice_error: {}", invoice_error);
9381 fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> {
9382 core::mem::take(&mut self.pending_offers_messages.lock().unwrap())
9386 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
9387 /// [`ChannelManager`].
9388 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
9389 let mut node_features = provided_init_features(config).to_context();
9390 node_features.set_keysend_optional();
9394 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
9395 /// [`ChannelManager`].
9397 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
9398 /// or not. Thus, this method is not public.
9399 #[cfg(any(feature = "_test_utils", test))]
9400 pub(crate) fn provided_bolt11_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
9401 provided_init_features(config).to_context()
9404 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
9405 /// [`ChannelManager`].
9406 pub(crate) fn provided_bolt12_invoice_features(config: &UserConfig) -> Bolt12InvoiceFeatures {
9407 provided_init_features(config).to_context()
9410 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
9411 /// [`ChannelManager`].
9412 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
9413 provided_init_features(config).to_context()
9416 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
9417 /// [`ChannelManager`].
9418 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
9419 ChannelTypeFeatures::from_init(&provided_init_features(config))
9422 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
9423 /// [`ChannelManager`].
9424 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
9425 // Note that if new features are added here which other peers may (eventually) require, we
9426 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
9427 // [`ErroringMessageHandler`].
9428 let mut features = InitFeatures::empty();
9429 features.set_data_loss_protect_required();
9430 features.set_upfront_shutdown_script_optional();
9431 features.set_variable_length_onion_required();
9432 features.set_static_remote_key_required();
9433 features.set_payment_secret_required();
9434 features.set_basic_mpp_optional();
9435 features.set_wumbo_optional();
9436 features.set_shutdown_any_segwit_optional();
9437 features.set_channel_type_optional();
9438 features.set_scid_privacy_optional();
9439 features.set_zero_conf_optional();
9440 features.set_route_blinding_optional();
9441 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
9442 features.set_anchors_zero_fee_htlc_tx_optional();
9447 const SERIALIZATION_VERSION: u8 = 1;
9448 const MIN_SERIALIZATION_VERSION: u8 = 1;
9450 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
9451 (2, fee_base_msat, required),
9452 (4, fee_proportional_millionths, required),
9453 (6, cltv_expiry_delta, required),
9456 impl_writeable_tlv_based!(ChannelCounterparty, {
9457 (2, node_id, required),
9458 (4, features, required),
9459 (6, unspendable_punishment_reserve, required),
9460 (8, forwarding_info, option),
9461 (9, outbound_htlc_minimum_msat, option),
9462 (11, outbound_htlc_maximum_msat, option),
9465 impl Writeable for ChannelDetails {
9466 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9467 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9468 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9469 let user_channel_id_low = self.user_channel_id as u64;
9470 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
9471 write_tlv_fields!(writer, {
9472 (1, self.inbound_scid_alias, option),
9473 (2, self.channel_id, required),
9474 (3, self.channel_type, option),
9475 (4, self.counterparty, required),
9476 (5, self.outbound_scid_alias, option),
9477 (6, self.funding_txo, option),
9478 (7, self.config, option),
9479 (8, self.short_channel_id, option),
9480 (9, self.confirmations, option),
9481 (10, self.channel_value_satoshis, required),
9482 (12, self.unspendable_punishment_reserve, option),
9483 (14, user_channel_id_low, required),
9484 (16, self.balance_msat, required),
9485 (18, self.outbound_capacity_msat, required),
9486 (19, self.next_outbound_htlc_limit_msat, required),
9487 (20, self.inbound_capacity_msat, required),
9488 (21, self.next_outbound_htlc_minimum_msat, required),
9489 (22, self.confirmations_required, option),
9490 (24, self.force_close_spend_delay, option),
9491 (26, self.is_outbound, required),
9492 (28, self.is_channel_ready, required),
9493 (30, self.is_usable, required),
9494 (32, self.is_public, required),
9495 (33, self.inbound_htlc_minimum_msat, option),
9496 (35, self.inbound_htlc_maximum_msat, option),
9497 (37, user_channel_id_high_opt, option),
9498 (39, self.feerate_sat_per_1000_weight, option),
9499 (41, self.channel_shutdown_state, option),
9500 (43, self.pending_inbound_htlcs, optional_vec),
9501 (45, self.pending_outbound_htlcs, optional_vec),
9507 impl Readable for ChannelDetails {
9508 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9509 _init_and_read_len_prefixed_tlv_fields!(reader, {
9510 (1, inbound_scid_alias, option),
9511 (2, channel_id, required),
9512 (3, channel_type, option),
9513 (4, counterparty, required),
9514 (5, outbound_scid_alias, option),
9515 (6, funding_txo, option),
9516 (7, config, option),
9517 (8, short_channel_id, option),
9518 (9, confirmations, option),
9519 (10, channel_value_satoshis, required),
9520 (12, unspendable_punishment_reserve, option),
9521 (14, user_channel_id_low, required),
9522 (16, balance_msat, required),
9523 (18, outbound_capacity_msat, required),
9524 // Note that by the time we get past the required read above, outbound_capacity_msat will be
9525 // filled in, so we can safely unwrap it here.
9526 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
9527 (20, inbound_capacity_msat, required),
9528 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
9529 (22, confirmations_required, option),
9530 (24, force_close_spend_delay, option),
9531 (26, is_outbound, required),
9532 (28, is_channel_ready, required),
9533 (30, is_usable, required),
9534 (32, is_public, required),
9535 (33, inbound_htlc_minimum_msat, option),
9536 (35, inbound_htlc_maximum_msat, option),
9537 (37, user_channel_id_high_opt, option),
9538 (39, feerate_sat_per_1000_weight, option),
9539 (41, channel_shutdown_state, option),
9540 (43, pending_inbound_htlcs, optional_vec),
9541 (45, pending_outbound_htlcs, optional_vec),
9544 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9545 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9546 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
9547 let user_channel_id = user_channel_id_low as u128 +
9548 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
9552 channel_id: channel_id.0.unwrap(),
9554 counterparty: counterparty.0.unwrap(),
9555 outbound_scid_alias,
9559 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
9560 unspendable_punishment_reserve,
9562 balance_msat: balance_msat.0.unwrap(),
9563 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
9564 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
9565 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
9566 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
9567 confirmations_required,
9569 force_close_spend_delay,
9570 is_outbound: is_outbound.0.unwrap(),
9571 is_channel_ready: is_channel_ready.0.unwrap(),
9572 is_usable: is_usable.0.unwrap(),
9573 is_public: is_public.0.unwrap(),
9574 inbound_htlc_minimum_msat,
9575 inbound_htlc_maximum_msat,
9576 feerate_sat_per_1000_weight,
9577 channel_shutdown_state,
9578 pending_inbound_htlcs: pending_inbound_htlcs.unwrap_or(Vec::new()),
9579 pending_outbound_htlcs: pending_outbound_htlcs.unwrap_or(Vec::new()),
9584 impl_writeable_tlv_based!(PhantomRouteHints, {
9585 (2, channels, required_vec),
9586 (4, phantom_scid, required),
9587 (6, real_node_pubkey, required),
9590 impl_writeable_tlv_based!(BlindedForward, {
9591 (0, inbound_blinding_point, required),
9592 (1, failure, (default_value, BlindedFailure::FromIntroductionNode)),
9595 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
9597 (0, onion_packet, required),
9598 (1, blinded, option),
9599 (2, short_channel_id, required),
9602 (0, payment_data, required),
9603 (1, phantom_shared_secret, option),
9604 (2, incoming_cltv_expiry, required),
9605 (3, payment_metadata, option),
9606 (5, custom_tlvs, optional_vec),
9607 (7, requires_blinded_error, (default_value, false)),
9609 (2, ReceiveKeysend) => {
9610 (0, payment_preimage, required),
9611 (2, incoming_cltv_expiry, required),
9612 (3, payment_metadata, option),
9613 (4, payment_data, option), // Added in 0.0.116
9614 (5, custom_tlvs, optional_vec),
9618 impl_writeable_tlv_based!(PendingHTLCInfo, {
9619 (0, routing, required),
9620 (2, incoming_shared_secret, required),
9621 (4, payment_hash, required),
9622 (6, outgoing_amt_msat, required),
9623 (8, outgoing_cltv_value, required),
9624 (9, incoming_amt_msat, option),
9625 (10, skimmed_fee_msat, option),
9629 impl Writeable for HTLCFailureMsg {
9630 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9632 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
9634 channel_id.write(writer)?;
9635 htlc_id.write(writer)?;
9636 reason.write(writer)?;
9638 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9639 channel_id, htlc_id, sha256_of_onion, failure_code
9642 channel_id.write(writer)?;
9643 htlc_id.write(writer)?;
9644 sha256_of_onion.write(writer)?;
9645 failure_code.write(writer)?;
9652 impl Readable for HTLCFailureMsg {
9653 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9654 let id: u8 = Readable::read(reader)?;
9657 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
9658 channel_id: Readable::read(reader)?,
9659 htlc_id: Readable::read(reader)?,
9660 reason: Readable::read(reader)?,
9664 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9665 channel_id: Readable::read(reader)?,
9666 htlc_id: Readable::read(reader)?,
9667 sha256_of_onion: Readable::read(reader)?,
9668 failure_code: Readable::read(reader)?,
9671 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
9672 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
9673 // messages contained in the variants.
9674 // In version 0.0.101, support for reading the variants with these types was added, and
9675 // we should migrate to writing these variants when UpdateFailHTLC or
9676 // UpdateFailMalformedHTLC get TLV fields.
9678 let length: BigSize = Readable::read(reader)?;
9679 let mut s = FixedLengthReader::new(reader, length.0);
9680 let res = Readable::read(&mut s)?;
9681 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9682 Ok(HTLCFailureMsg::Relay(res))
9685 let length: BigSize = Readable::read(reader)?;
9686 let mut s = FixedLengthReader::new(reader, length.0);
9687 let res = Readable::read(&mut s)?;
9688 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9689 Ok(HTLCFailureMsg::Malformed(res))
9691 _ => Err(DecodeError::UnknownRequiredFeature),
9696 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
9701 impl_writeable_tlv_based_enum!(BlindedFailure,
9702 (0, FromIntroductionNode) => {},
9703 (2, FromBlindedNode) => {}, ;
9706 impl_writeable_tlv_based!(HTLCPreviousHopData, {
9707 (0, short_channel_id, required),
9708 (1, phantom_shared_secret, option),
9709 (2, outpoint, required),
9710 (3, blinded_failure, option),
9711 (4, htlc_id, required),
9712 (6, incoming_packet_shared_secret, required),
9713 (7, user_channel_id, option),
9714 // Note that by the time we get past the required read for type 2 above, outpoint will be
9715 // filled in, so we can safely unwrap it here.
9716 (9, channel_id, (default_value, ChannelId::v1_from_funding_outpoint(outpoint.0.unwrap()))),
9719 impl Writeable for ClaimableHTLC {
9720 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9721 let (payment_data, keysend_preimage) = match &self.onion_payload {
9722 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
9723 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
9725 write_tlv_fields!(writer, {
9726 (0, self.prev_hop, required),
9727 (1, self.total_msat, required),
9728 (2, self.value, required),
9729 (3, self.sender_intended_value, required),
9730 (4, payment_data, option),
9731 (5, self.total_value_received, option),
9732 (6, self.cltv_expiry, required),
9733 (8, keysend_preimage, option),
9734 (10, self.counterparty_skimmed_fee_msat, option),
9740 impl Readable for ClaimableHTLC {
9741 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9742 _init_and_read_len_prefixed_tlv_fields!(reader, {
9743 (0, prev_hop, required),
9744 (1, total_msat, option),
9745 (2, value_ser, required),
9746 (3, sender_intended_value, option),
9747 (4, payment_data_opt, option),
9748 (5, total_value_received, option),
9749 (6, cltv_expiry, required),
9750 (8, keysend_preimage, option),
9751 (10, counterparty_skimmed_fee_msat, option),
9753 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
9754 let value = value_ser.0.unwrap();
9755 let onion_payload = match keysend_preimage {
9757 if payment_data.is_some() {
9758 return Err(DecodeError::InvalidValue)
9760 if total_msat.is_none() {
9761 total_msat = Some(value);
9763 OnionPayload::Spontaneous(p)
9766 if total_msat.is_none() {
9767 if payment_data.is_none() {
9768 return Err(DecodeError::InvalidValue)
9770 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
9772 OnionPayload::Invoice { _legacy_hop_data: payment_data }
9776 prev_hop: prev_hop.0.unwrap(),
9779 sender_intended_value: sender_intended_value.unwrap_or(value),
9780 total_value_received,
9781 total_msat: total_msat.unwrap(),
9783 cltv_expiry: cltv_expiry.0.unwrap(),
9784 counterparty_skimmed_fee_msat,
9789 impl Readable for HTLCSource {
9790 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9791 let id: u8 = Readable::read(reader)?;
9794 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
9795 let mut first_hop_htlc_msat: u64 = 0;
9796 let mut path_hops = Vec::new();
9797 let mut payment_id = None;
9798 let mut payment_params: Option<PaymentParameters> = None;
9799 let mut blinded_tail: Option<BlindedTail> = None;
9800 read_tlv_fields!(reader, {
9801 (0, session_priv, required),
9802 (1, payment_id, option),
9803 (2, first_hop_htlc_msat, required),
9804 (4, path_hops, required_vec),
9805 (5, payment_params, (option: ReadableArgs, 0)),
9806 (6, blinded_tail, option),
9808 if payment_id.is_none() {
9809 // For backwards compat, if there was no payment_id written, use the session_priv bytes
9811 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
9813 let path = Path { hops: path_hops, blinded_tail };
9814 if path.hops.len() == 0 {
9815 return Err(DecodeError::InvalidValue);
9817 if let Some(params) = payment_params.as_mut() {
9818 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
9819 if final_cltv_expiry_delta == &0 {
9820 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
9824 Ok(HTLCSource::OutboundRoute {
9825 session_priv: session_priv.0.unwrap(),
9826 first_hop_htlc_msat,
9828 payment_id: payment_id.unwrap(),
9831 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
9832 _ => Err(DecodeError::UnknownRequiredFeature),
9837 impl Writeable for HTLCSource {
9838 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
9840 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
9842 let payment_id_opt = Some(payment_id);
9843 write_tlv_fields!(writer, {
9844 (0, session_priv, required),
9845 (1, payment_id_opt, option),
9846 (2, first_hop_htlc_msat, required),
9847 // 3 was previously used to write a PaymentSecret for the payment.
9848 (4, path.hops, required_vec),
9849 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
9850 (6, path.blinded_tail, option),
9853 HTLCSource::PreviousHopData(ref field) => {
9855 field.write(writer)?;
9862 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
9863 (0, forward_info, required),
9864 (1, prev_user_channel_id, (default_value, 0)),
9865 (2, prev_short_channel_id, required),
9866 (4, prev_htlc_id, required),
9867 (6, prev_funding_outpoint, required),
9868 // Note that by the time we get past the required read for type 6 above, prev_funding_outpoint will be
9869 // filled in, so we can safely unwrap it here.
9870 (7, prev_channel_id, (default_value, ChannelId::v1_from_funding_outpoint(prev_funding_outpoint.0.unwrap()))),
9873 impl Writeable for HTLCForwardInfo {
9874 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9875 const FAIL_HTLC_VARIANT_ID: u8 = 1;
9877 Self::AddHTLC(info) => {
9881 Self::FailHTLC { htlc_id, err_packet } => {
9882 FAIL_HTLC_VARIANT_ID.write(w)?;
9883 write_tlv_fields!(w, {
9884 (0, htlc_id, required),
9885 (2, err_packet, required),
9888 Self::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
9889 // Since this variant was added in 0.0.119, write this as `::FailHTLC` with an empty error
9890 // packet so older versions have something to fail back with, but serialize the real data as
9891 // optional TLVs for the benefit of newer versions.
9892 FAIL_HTLC_VARIANT_ID.write(w)?;
9893 let dummy_err_packet = msgs::OnionErrorPacket { data: Vec::new() };
9894 write_tlv_fields!(w, {
9895 (0, htlc_id, required),
9896 (1, failure_code, required),
9897 (2, dummy_err_packet, required),
9898 (3, sha256_of_onion, required),
9906 impl Readable for HTLCForwardInfo {
9907 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
9908 let id: u8 = Readable::read(r)?;
9910 0 => Self::AddHTLC(Readable::read(r)?),
9912 _init_and_read_len_prefixed_tlv_fields!(r, {
9913 (0, htlc_id, required),
9914 (1, malformed_htlc_failure_code, option),
9915 (2, err_packet, required),
9916 (3, sha256_of_onion, option),
9918 if let Some(failure_code) = malformed_htlc_failure_code {
9919 Self::FailMalformedHTLC {
9920 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9922 sha256_of_onion: sha256_of_onion.ok_or(DecodeError::InvalidValue)?,
9926 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9927 err_packet: _init_tlv_based_struct_field!(err_packet, required),
9931 _ => return Err(DecodeError::InvalidValue),
9936 impl_writeable_tlv_based!(PendingInboundPayment, {
9937 (0, payment_secret, required),
9938 (2, expiry_time, required),
9939 (4, user_payment_id, required),
9940 (6, payment_preimage, required),
9941 (8, min_value_msat, required),
9944 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>
9946 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9947 T::Target: BroadcasterInterface,
9948 ES::Target: EntropySource,
9949 NS::Target: NodeSigner,
9950 SP::Target: SignerProvider,
9951 F::Target: FeeEstimator,
9955 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9956 let _consistency_lock = self.total_consistency_lock.write().unwrap();
9958 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
9960 self.chain_hash.write(writer)?;
9962 let best_block = self.best_block.read().unwrap();
9963 best_block.height().write(writer)?;
9964 best_block.block_hash().write(writer)?;
9967 let mut serializable_peer_count: u64 = 0;
9969 let per_peer_state = self.per_peer_state.read().unwrap();
9970 let mut number_of_funded_channels = 0;
9971 for (_, peer_state_mutex) in per_peer_state.iter() {
9972 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9973 let peer_state = &mut *peer_state_lock;
9974 if !peer_state.ok_to_remove(false) {
9975 serializable_peer_count += 1;
9978 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
9979 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_broadcast() } else { false }
9983 (number_of_funded_channels as u64).write(writer)?;
9985 for (_, peer_state_mutex) in per_peer_state.iter() {
9986 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9987 let peer_state = &mut *peer_state_lock;
9988 for channel in peer_state.channel_by_id.iter().filter_map(
9989 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
9990 if channel.context.is_funding_broadcast() { Some(channel) } else { None }
9993 channel.write(writer)?;
9999 let forward_htlcs = self.forward_htlcs.lock().unwrap();
10000 (forward_htlcs.len() as u64).write(writer)?;
10001 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
10002 short_channel_id.write(writer)?;
10003 (pending_forwards.len() as u64).write(writer)?;
10004 for forward in pending_forwards {
10005 forward.write(writer)?;
10010 let per_peer_state = self.per_peer_state.write().unwrap();
10012 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
10013 let claimable_payments = self.claimable_payments.lock().unwrap();
10014 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
10016 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
10017 let mut htlc_onion_fields: Vec<&_> = Vec::new();
10018 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
10019 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
10020 payment_hash.write(writer)?;
10021 (payment.htlcs.len() as u64).write(writer)?;
10022 for htlc in payment.htlcs.iter() {
10023 htlc.write(writer)?;
10025 htlc_purposes.push(&payment.purpose);
10026 htlc_onion_fields.push(&payment.onion_fields);
10029 let mut monitor_update_blocked_actions_per_peer = None;
10030 let mut peer_states = Vec::new();
10031 for (_, peer_state_mutex) in per_peer_state.iter() {
10032 // Because we're holding the owning `per_peer_state` write lock here there's no chance
10033 // of a lockorder violation deadlock - no other thread can be holding any
10034 // per_peer_state lock at all.
10035 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
10038 (serializable_peer_count).write(writer)?;
10039 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
10040 // Peers which we have no channels to should be dropped once disconnected. As we
10041 // disconnect all peers when shutting down and serializing the ChannelManager, we
10042 // consider all peers as disconnected here. There's therefore no need write peers with
10044 if !peer_state.ok_to_remove(false) {
10045 peer_pubkey.write(writer)?;
10046 peer_state.latest_features.write(writer)?;
10047 if !peer_state.monitor_update_blocked_actions.is_empty() {
10048 monitor_update_blocked_actions_per_peer
10049 .get_or_insert_with(Vec::new)
10050 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
10055 let events = self.pending_events.lock().unwrap();
10056 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
10057 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
10058 // refuse to read the new ChannelManager.
10059 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
10060 if events_not_backwards_compatible {
10061 // If we're gonna write a even TLV that will overwrite our events anyway we might as
10062 // well save the space and not write any events here.
10063 0u64.write(writer)?;
10065 (events.len() as u64).write(writer)?;
10066 for (event, _) in events.iter() {
10067 event.write(writer)?;
10071 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
10072 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
10073 // the closing monitor updates were always effectively replayed on startup (either directly
10074 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
10075 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
10076 0u64.write(writer)?;
10078 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
10079 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
10080 // likely to be identical.
10081 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
10082 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
10084 (pending_inbound_payments.len() as u64).write(writer)?;
10085 for (hash, pending_payment) in pending_inbound_payments.iter() {
10086 hash.write(writer)?;
10087 pending_payment.write(writer)?;
10090 // For backwards compat, write the session privs and their total length.
10091 let mut num_pending_outbounds_compat: u64 = 0;
10092 for (_, outbound) in pending_outbound_payments.iter() {
10093 if !outbound.is_fulfilled() && !outbound.abandoned() {
10094 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
10097 num_pending_outbounds_compat.write(writer)?;
10098 for (_, outbound) in pending_outbound_payments.iter() {
10100 PendingOutboundPayment::Legacy { session_privs } |
10101 PendingOutboundPayment::Retryable { session_privs, .. } => {
10102 for session_priv in session_privs.iter() {
10103 session_priv.write(writer)?;
10106 PendingOutboundPayment::AwaitingInvoice { .. } => {},
10107 PendingOutboundPayment::InvoiceReceived { .. } => {},
10108 PendingOutboundPayment::Fulfilled { .. } => {},
10109 PendingOutboundPayment::Abandoned { .. } => {},
10113 // Encode without retry info for 0.0.101 compatibility.
10114 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = new_hash_map();
10115 for (id, outbound) in pending_outbound_payments.iter() {
10117 PendingOutboundPayment::Legacy { session_privs } |
10118 PendingOutboundPayment::Retryable { session_privs, .. } => {
10119 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
10125 let mut pending_intercepted_htlcs = None;
10126 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
10127 if our_pending_intercepts.len() != 0 {
10128 pending_intercepted_htlcs = Some(our_pending_intercepts);
10131 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
10132 if pending_claiming_payments.as_ref().unwrap().is_empty() {
10133 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
10134 // map. Thus, if there are no entries we skip writing a TLV for it.
10135 pending_claiming_payments = None;
10138 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
10139 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
10140 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
10141 if !updates.is_empty() {
10142 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(new_hash_map()); }
10143 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
10148 write_tlv_fields!(writer, {
10149 (1, pending_outbound_payments_no_retry, required),
10150 (2, pending_intercepted_htlcs, option),
10151 (3, pending_outbound_payments, required),
10152 (4, pending_claiming_payments, option),
10153 (5, self.our_network_pubkey, required),
10154 (6, monitor_update_blocked_actions_per_peer, option),
10155 (7, self.fake_scid_rand_bytes, required),
10156 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
10157 (9, htlc_purposes, required_vec),
10158 (10, in_flight_monitor_updates, option),
10159 (11, self.probing_cookie_secret, required),
10160 (13, htlc_onion_fields, optional_vec),
10167 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
10168 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
10169 (self.len() as u64).write(w)?;
10170 for (event, action) in self.iter() {
10173 #[cfg(debug_assertions)] {
10174 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
10175 // be persisted and are regenerated on restart. However, if such an event has a
10176 // post-event-handling action we'll write nothing for the event and would have to
10177 // either forget the action or fail on deserialization (which we do below). Thus,
10178 // check that the event is sane here.
10179 let event_encoded = event.encode();
10180 let event_read: Option<Event> =
10181 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
10182 if action.is_some() { assert!(event_read.is_some()); }
10188 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
10189 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
10190 let len: u64 = Readable::read(reader)?;
10191 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
10192 let mut events: Self = VecDeque::with_capacity(cmp::min(
10193 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
10196 let ev_opt = MaybeReadable::read(reader)?;
10197 let action = Readable::read(reader)?;
10198 if let Some(ev) = ev_opt {
10199 events.push_back((ev, action));
10200 } else if action.is_some() {
10201 return Err(DecodeError::InvalidValue);
10208 impl_writeable_tlv_based_enum!(ChannelShutdownState,
10209 (0, NotShuttingDown) => {},
10210 (2, ShutdownInitiated) => {},
10211 (4, ResolvingHTLCs) => {},
10212 (6, NegotiatingClosingFee) => {},
10213 (8, ShutdownComplete) => {}, ;
10216 /// Arguments for the creation of a ChannelManager that are not deserialized.
10218 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
10220 /// 1) Deserialize all stored [`ChannelMonitor`]s.
10221 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
10222 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
10223 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
10224 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
10225 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
10226 /// same way you would handle a [`chain::Filter`] call using
10227 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
10228 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
10229 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
10230 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
10231 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
10232 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
10234 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
10235 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
10237 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
10238 /// call any other methods on the newly-deserialized [`ChannelManager`].
10240 /// Note that because some channels may be closed during deserialization, it is critical that you
10241 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
10242 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
10243 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
10244 /// not force-close the same channels but consider them live), you may end up revoking a state for
10245 /// which you've already broadcasted the transaction.
10247 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
10248 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10250 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10251 T::Target: BroadcasterInterface,
10252 ES::Target: EntropySource,
10253 NS::Target: NodeSigner,
10254 SP::Target: SignerProvider,
10255 F::Target: FeeEstimator,
10259 /// A cryptographically secure source of entropy.
10260 pub entropy_source: ES,
10262 /// A signer that is able to perform node-scoped cryptographic operations.
10263 pub node_signer: NS,
10265 /// The keys provider which will give us relevant keys. Some keys will be loaded during
10266 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
10268 pub signer_provider: SP,
10270 /// The fee_estimator for use in the ChannelManager in the future.
10272 /// No calls to the FeeEstimator will be made during deserialization.
10273 pub fee_estimator: F,
10274 /// The chain::Watch for use in the ChannelManager in the future.
10276 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
10277 /// you have deserialized ChannelMonitors separately and will add them to your
10278 /// chain::Watch after deserializing this ChannelManager.
10279 pub chain_monitor: M,
10281 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
10282 /// used to broadcast the latest local commitment transactions of channels which must be
10283 /// force-closed during deserialization.
10284 pub tx_broadcaster: T,
10285 /// The router which will be used in the ChannelManager in the future for finding routes
10286 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
10288 /// No calls to the router will be made during deserialization.
10290 /// The Logger for use in the ChannelManager and which may be used to log information during
10291 /// deserialization.
10293 /// Default settings used for new channels. Any existing channels will continue to use the
10294 /// runtime settings which were stored when the ChannelManager was serialized.
10295 pub default_config: UserConfig,
10297 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
10298 /// value.context.get_funding_txo() should be the key).
10300 /// If a monitor is inconsistent with the channel state during deserialization the channel will
10301 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
10302 /// is true for missing channels as well. If there is a monitor missing for which we find
10303 /// channel data Err(DecodeError::InvalidValue) will be returned.
10305 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
10308 /// This is not exported to bindings users because we have no HashMap bindings
10309 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>,
10312 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10313 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
10315 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10316 T::Target: BroadcasterInterface,
10317 ES::Target: EntropySource,
10318 NS::Target: NodeSigner,
10319 SP::Target: SignerProvider,
10320 F::Target: FeeEstimator,
10324 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
10325 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
10326 /// populate a HashMap directly from C.
10327 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,
10328 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>) -> Self {
10330 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
10331 channel_monitors: hash_map_from_iter(
10332 channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) })
10338 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
10339 // SipmleArcChannelManager type:
10340 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10341 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
10343 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10344 T::Target: BroadcasterInterface,
10345 ES::Target: EntropySource,
10346 NS::Target: NodeSigner,
10347 SP::Target: SignerProvider,
10348 F::Target: FeeEstimator,
10352 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10353 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
10354 Ok((blockhash, Arc::new(chan_manager)))
10358 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10359 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
10361 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10362 T::Target: BroadcasterInterface,
10363 ES::Target: EntropySource,
10364 NS::Target: NodeSigner,
10365 SP::Target: SignerProvider,
10366 F::Target: FeeEstimator,
10370 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10371 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
10373 let chain_hash: ChainHash = Readable::read(reader)?;
10374 let best_block_height: u32 = Readable::read(reader)?;
10375 let best_block_hash: BlockHash = Readable::read(reader)?;
10377 let mut failed_htlcs = Vec::new();
10379 let channel_count: u64 = Readable::read(reader)?;
10380 let mut funding_txo_set = hash_set_with_capacity(cmp::min(channel_count as usize, 128));
10381 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = hash_map_with_capacity(cmp::min(channel_count as usize, 128));
10382 let mut outpoint_to_peer = hash_map_with_capacity(cmp::min(channel_count as usize, 128));
10383 let mut short_to_chan_info = hash_map_with_capacity(cmp::min(channel_count as usize, 128));
10384 let mut channel_closures = VecDeque::new();
10385 let mut close_background_events = Vec::new();
10386 let mut funding_txo_to_channel_id = hash_map_with_capacity(channel_count as usize);
10387 for _ in 0..channel_count {
10388 let mut channel: Channel<SP> = Channel::read(reader, (
10389 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
10391 let logger = WithChannelContext::from(&args.logger, &channel.context);
10392 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10393 funding_txo_to_channel_id.insert(funding_txo, channel.context.channel_id());
10394 funding_txo_set.insert(funding_txo.clone());
10395 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
10396 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
10397 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
10398 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
10399 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10400 // But if the channel is behind of the monitor, close the channel:
10401 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
10402 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
10403 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10404 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
10405 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
10407 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
10408 log_error!(logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
10409 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
10411 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
10412 log_error!(logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
10413 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
10415 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
10416 log_error!(logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
10417 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
10419 let mut shutdown_result = channel.context.force_shutdown(true, ClosureReason::OutdatedChannelManager);
10420 if shutdown_result.unbroadcasted_batch_funding_txid.is_some() {
10421 return Err(DecodeError::InvalidValue);
10423 if let Some((counterparty_node_id, funding_txo, channel_id, update)) = shutdown_result.monitor_update {
10424 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10425 counterparty_node_id, funding_txo, channel_id, update
10428 failed_htlcs.append(&mut shutdown_result.dropped_outbound_htlcs);
10429 channel_closures.push_back((events::Event::ChannelClosed {
10430 channel_id: channel.context.channel_id(),
10431 user_channel_id: channel.context.get_user_id(),
10432 reason: ClosureReason::OutdatedChannelManager,
10433 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10434 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10435 channel_funding_txo: channel.context.get_funding_txo(),
10437 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
10438 let mut found_htlc = false;
10439 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
10440 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
10443 // If we have some HTLCs in the channel which are not present in the newer
10444 // ChannelMonitor, they have been removed and should be failed back to
10445 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
10446 // were actually claimed we'd have generated and ensured the previous-hop
10447 // claim update ChannelMonitor updates were persisted prior to persising
10448 // the ChannelMonitor update for the forward leg, so attempting to fail the
10449 // backwards leg of the HTLC will simply be rejected.
10451 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
10452 &channel.context.channel_id(), &payment_hash);
10453 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10457 log_info!(logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
10458 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
10459 monitor.get_latest_update_id());
10460 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
10461 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10463 if let Some(funding_txo) = channel.context.get_funding_txo() {
10464 outpoint_to_peer.insert(funding_txo, channel.context.get_counterparty_node_id());
10466 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
10467 hash_map::Entry::Occupied(mut entry) => {
10468 let by_id_map = entry.get_mut();
10469 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10471 hash_map::Entry::Vacant(entry) => {
10472 let mut by_id_map = new_hash_map();
10473 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10474 entry.insert(by_id_map);
10478 } else if channel.is_awaiting_initial_mon_persist() {
10479 // If we were persisted and shut down while the initial ChannelMonitor persistence
10480 // was in-progress, we never broadcasted the funding transaction and can still
10481 // safely discard the channel.
10482 let _ = channel.context.force_shutdown(false, ClosureReason::DisconnectedPeer);
10483 channel_closures.push_back((events::Event::ChannelClosed {
10484 channel_id: channel.context.channel_id(),
10485 user_channel_id: channel.context.get_user_id(),
10486 reason: ClosureReason::DisconnectedPeer,
10487 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10488 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10489 channel_funding_txo: channel.context.get_funding_txo(),
10492 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
10493 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10494 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10495 log_error!(logger, " Without the ChannelMonitor we cannot continue without risking funds.");
10496 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10497 return Err(DecodeError::InvalidValue);
10501 for (funding_txo, monitor) in args.channel_monitors.iter() {
10502 if !funding_txo_set.contains(funding_txo) {
10503 let logger = WithChannelMonitor::from(&args.logger, monitor);
10504 let channel_id = monitor.channel_id();
10505 log_info!(logger, "Queueing monitor update to ensure missing channel {} is force closed",
10507 let monitor_update = ChannelMonitorUpdate {
10508 update_id: CLOSED_CHANNEL_UPDATE_ID,
10509 counterparty_node_id: None,
10510 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
10511 channel_id: Some(monitor.channel_id()),
10513 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, channel_id, monitor_update)));
10517 const MAX_ALLOC_SIZE: usize = 1024 * 64;
10518 let forward_htlcs_count: u64 = Readable::read(reader)?;
10519 let mut forward_htlcs = hash_map_with_capacity(cmp::min(forward_htlcs_count as usize, 128));
10520 for _ in 0..forward_htlcs_count {
10521 let short_channel_id = Readable::read(reader)?;
10522 let pending_forwards_count: u64 = Readable::read(reader)?;
10523 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
10524 for _ in 0..pending_forwards_count {
10525 pending_forwards.push(Readable::read(reader)?);
10527 forward_htlcs.insert(short_channel_id, pending_forwards);
10530 let claimable_htlcs_count: u64 = Readable::read(reader)?;
10531 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
10532 for _ in 0..claimable_htlcs_count {
10533 let payment_hash = Readable::read(reader)?;
10534 let previous_hops_len: u64 = Readable::read(reader)?;
10535 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
10536 for _ in 0..previous_hops_len {
10537 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
10539 claimable_htlcs_list.push((payment_hash, previous_hops));
10542 let peer_state_from_chans = |channel_by_id| {
10545 inbound_channel_request_by_id: new_hash_map(),
10546 latest_features: InitFeatures::empty(),
10547 pending_msg_events: Vec::new(),
10548 in_flight_monitor_updates: BTreeMap::new(),
10549 monitor_update_blocked_actions: BTreeMap::new(),
10550 actions_blocking_raa_monitor_updates: BTreeMap::new(),
10551 is_connected: false,
10555 let peer_count: u64 = Readable::read(reader)?;
10556 let mut per_peer_state = hash_map_with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
10557 for _ in 0..peer_count {
10558 let peer_pubkey = Readable::read(reader)?;
10559 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(new_hash_map());
10560 let mut peer_state = peer_state_from_chans(peer_chans);
10561 peer_state.latest_features = Readable::read(reader)?;
10562 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
10565 let event_count: u64 = Readable::read(reader)?;
10566 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
10567 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
10568 for _ in 0..event_count {
10569 match MaybeReadable::read(reader)? {
10570 Some(event) => pending_events_read.push_back((event, None)),
10575 let background_event_count: u64 = Readable::read(reader)?;
10576 for _ in 0..background_event_count {
10577 match <u8 as Readable>::read(reader)? {
10579 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
10580 // however we really don't (and never did) need them - we regenerate all
10581 // on-startup monitor updates.
10582 let _: OutPoint = Readable::read(reader)?;
10583 let _: ChannelMonitorUpdate = Readable::read(reader)?;
10585 _ => return Err(DecodeError::InvalidValue),
10589 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
10590 let highest_seen_timestamp: u32 = Readable::read(reader)?;
10592 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
10593 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = hash_map_with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
10594 for _ in 0..pending_inbound_payment_count {
10595 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
10596 return Err(DecodeError::InvalidValue);
10600 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
10601 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
10602 hash_map_with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
10603 for _ in 0..pending_outbound_payments_count_compat {
10604 let session_priv = Readable::read(reader)?;
10605 let payment = PendingOutboundPayment::Legacy {
10606 session_privs: hash_set_from_iter([session_priv]),
10608 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
10609 return Err(DecodeError::InvalidValue)
10613 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
10614 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
10615 let mut pending_outbound_payments = None;
10616 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(new_hash_map());
10617 let mut received_network_pubkey: Option<PublicKey> = None;
10618 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
10619 let mut probing_cookie_secret: Option<[u8; 32]> = None;
10620 let mut claimable_htlc_purposes = None;
10621 let mut claimable_htlc_onion_fields = None;
10622 let mut pending_claiming_payments = Some(new_hash_map());
10623 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
10624 let mut events_override = None;
10625 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
10626 read_tlv_fields!(reader, {
10627 (1, pending_outbound_payments_no_retry, option),
10628 (2, pending_intercepted_htlcs, option),
10629 (3, pending_outbound_payments, option),
10630 (4, pending_claiming_payments, option),
10631 (5, received_network_pubkey, option),
10632 (6, monitor_update_blocked_actions_per_peer, option),
10633 (7, fake_scid_rand_bytes, option),
10634 (8, events_override, option),
10635 (9, claimable_htlc_purposes, optional_vec),
10636 (10, in_flight_monitor_updates, option),
10637 (11, probing_cookie_secret, option),
10638 (13, claimable_htlc_onion_fields, optional_vec),
10640 if fake_scid_rand_bytes.is_none() {
10641 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
10644 if probing_cookie_secret.is_none() {
10645 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
10648 if let Some(events) = events_override {
10649 pending_events_read = events;
10652 if !channel_closures.is_empty() {
10653 pending_events_read.append(&mut channel_closures);
10656 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
10657 pending_outbound_payments = Some(pending_outbound_payments_compat);
10658 } else if pending_outbound_payments.is_none() {
10659 let mut outbounds = new_hash_map();
10660 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
10661 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
10663 pending_outbound_payments = Some(outbounds);
10665 let pending_outbounds = OutboundPayments {
10666 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
10667 retry_lock: Mutex::new(())
10670 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
10671 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
10672 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
10673 // replayed, and for each monitor update we have to replay we have to ensure there's a
10674 // `ChannelMonitor` for it.
10676 // In order to do so we first walk all of our live channels (so that we can check their
10677 // state immediately after doing the update replays, when we have the `update_id`s
10678 // available) and then walk any remaining in-flight updates.
10680 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
10681 let mut pending_background_events = Vec::new();
10682 macro_rules! handle_in_flight_updates {
10683 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
10684 $monitor: expr, $peer_state: expr, $logger: expr, $channel_info_log: expr
10686 let mut max_in_flight_update_id = 0;
10687 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
10688 for update in $chan_in_flight_upds.iter() {
10689 log_trace!($logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
10690 update.update_id, $channel_info_log, &$monitor.channel_id());
10691 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
10692 pending_background_events.push(
10693 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10694 counterparty_node_id: $counterparty_node_id,
10695 funding_txo: $funding_txo,
10696 channel_id: $monitor.channel_id(),
10697 update: update.clone(),
10700 if $chan_in_flight_upds.is_empty() {
10701 // We had some updates to apply, but it turns out they had completed before we
10702 // were serialized, we just weren't notified of that. Thus, we may have to run
10703 // the completion actions for any monitor updates, but otherwise are done.
10704 pending_background_events.push(
10705 BackgroundEvent::MonitorUpdatesComplete {
10706 counterparty_node_id: $counterparty_node_id,
10707 channel_id: $monitor.channel_id(),
10710 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
10711 log_error!($logger, "Duplicate in-flight monitor update set for the same channel!");
10712 return Err(DecodeError::InvalidValue);
10714 max_in_flight_update_id
10718 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
10719 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
10720 let peer_state = &mut *peer_state_lock;
10721 for phase in peer_state.channel_by_id.values() {
10722 if let ChannelPhase::Funded(chan) = phase {
10723 let logger = WithChannelContext::from(&args.logger, &chan.context);
10725 // Channels that were persisted have to be funded, otherwise they should have been
10727 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10728 let monitor = args.channel_monitors.get(&funding_txo)
10729 .expect("We already checked for monitor presence when loading channels");
10730 let mut max_in_flight_update_id = monitor.get_latest_update_id();
10731 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
10732 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
10733 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
10734 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
10735 funding_txo, monitor, peer_state, logger, ""));
10738 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
10739 // If the channel is ahead of the monitor, return InvalidValue:
10740 log_error!(logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
10741 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
10742 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
10743 log_error!(logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
10744 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10745 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10746 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10747 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10748 return Err(DecodeError::InvalidValue);
10751 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10752 // created in this `channel_by_id` map.
10753 debug_assert!(false);
10754 return Err(DecodeError::InvalidValue);
10759 if let Some(in_flight_upds) = in_flight_monitor_updates {
10760 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
10761 let channel_id = funding_txo_to_channel_id.get(&funding_txo).copied();
10762 let logger = WithContext::from(&args.logger, Some(counterparty_id), channel_id);
10763 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
10764 // Now that we've removed all the in-flight monitor updates for channels that are
10765 // still open, we need to replay any monitor updates that are for closed channels,
10766 // creating the neccessary peer_state entries as we go.
10767 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
10768 Mutex::new(peer_state_from_chans(new_hash_map()))
10770 let mut peer_state = peer_state_mutex.lock().unwrap();
10771 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
10772 funding_txo, monitor, peer_state, logger, "closed ");
10774 log_error!(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!");
10775 log_error!(logger, " The ChannelMonitor for channel {} is missing.", if let Some(channel_id) =
10776 channel_id { channel_id.to_string() } else { format!("with outpoint {}", funding_txo) } );
10777 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10778 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10779 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10780 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10781 return Err(DecodeError::InvalidValue);
10786 // Note that we have to do the above replays before we push new monitor updates.
10787 pending_background_events.append(&mut close_background_events);
10789 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
10790 // should ensure we try them again on the inbound edge. We put them here and do so after we
10791 // have a fully-constructed `ChannelManager` at the end.
10792 let mut pending_claims_to_replay = Vec::new();
10795 // If we're tracking pending payments, ensure we haven't lost any by looking at the
10796 // ChannelMonitor data for any channels for which we do not have authorative state
10797 // (i.e. those for which we just force-closed above or we otherwise don't have a
10798 // corresponding `Channel` at all).
10799 // This avoids several edge-cases where we would otherwise "forget" about pending
10800 // payments which are still in-flight via their on-chain state.
10801 // We only rebuild the pending payments map if we were most recently serialized by
10803 for (_, monitor) in args.channel_monitors.iter() {
10804 let counterparty_opt = outpoint_to_peer.get(&monitor.get_funding_txo().0);
10805 if counterparty_opt.is_none() {
10806 let logger = WithChannelMonitor::from(&args.logger, monitor);
10807 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
10808 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
10809 if path.hops.is_empty() {
10810 log_error!(logger, "Got an empty path for a pending payment");
10811 return Err(DecodeError::InvalidValue);
10814 let path_amt = path.final_value_msat();
10815 let mut session_priv_bytes = [0; 32];
10816 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
10817 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
10818 hash_map::Entry::Occupied(mut entry) => {
10819 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
10820 log_info!(logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
10821 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), htlc.payment_hash);
10823 hash_map::Entry::Vacant(entry) => {
10824 let path_fee = path.fee_msat();
10825 entry.insert(PendingOutboundPayment::Retryable {
10826 retry_strategy: None,
10827 attempts: PaymentAttempts::new(),
10828 payment_params: None,
10829 session_privs: hash_set_from_iter([session_priv_bytes]),
10830 payment_hash: htlc.payment_hash,
10831 payment_secret: None, // only used for retries, and we'll never retry on startup
10832 payment_metadata: None, // only used for retries, and we'll never retry on startup
10833 keysend_preimage: None, // only used for retries, and we'll never retry on startup
10834 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
10835 pending_amt_msat: path_amt,
10836 pending_fee_msat: Some(path_fee),
10837 total_msat: path_amt,
10838 starting_block_height: best_block_height,
10839 remaining_max_total_routing_fee_msat: None, // only used for retries, and we'll never retry on startup
10841 log_info!(logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
10842 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
10847 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
10848 match htlc_source {
10849 HTLCSource::PreviousHopData(prev_hop_data) => {
10850 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
10851 info.prev_funding_outpoint == prev_hop_data.outpoint &&
10852 info.prev_htlc_id == prev_hop_data.htlc_id
10854 // The ChannelMonitor is now responsible for this HTLC's
10855 // failure/success and will let us know what its outcome is. If we
10856 // still have an entry for this HTLC in `forward_htlcs` or
10857 // `pending_intercepted_htlcs`, we were apparently not persisted after
10858 // the monitor was when forwarding the payment.
10859 forward_htlcs.retain(|_, forwards| {
10860 forwards.retain(|forward| {
10861 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
10862 if pending_forward_matches_htlc(&htlc_info) {
10863 log_info!(logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
10864 &htlc.payment_hash, &monitor.channel_id());
10869 !forwards.is_empty()
10871 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
10872 if pending_forward_matches_htlc(&htlc_info) {
10873 log_info!(logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
10874 &htlc.payment_hash, &monitor.channel_id());
10875 pending_events_read.retain(|(event, _)| {
10876 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
10877 intercepted_id != ev_id
10884 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
10885 if let Some(preimage) = preimage_opt {
10886 let pending_events = Mutex::new(pending_events_read);
10887 // Note that we set `from_onchain` to "false" here,
10888 // deliberately keeping the pending payment around forever.
10889 // Given it should only occur when we have a channel we're
10890 // force-closing for being stale that's okay.
10891 // The alternative would be to wipe the state when claiming,
10892 // generating a `PaymentPathSuccessful` event but regenerating
10893 // it and the `PaymentSent` on every restart until the
10894 // `ChannelMonitor` is removed.
10896 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
10897 channel_funding_outpoint: monitor.get_funding_txo().0,
10898 channel_id: monitor.channel_id(),
10899 counterparty_node_id: path.hops[0].pubkey,
10901 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
10902 path, false, compl_action, &pending_events, &&logger);
10903 pending_events_read = pending_events.into_inner().unwrap();
10910 // Whether the downstream channel was closed or not, try to re-apply any payment
10911 // preimages from it which may be needed in upstream channels for forwarded
10913 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
10915 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
10916 if let HTLCSource::PreviousHopData(_) = htlc_source {
10917 if let Some(payment_preimage) = preimage_opt {
10918 Some((htlc_source, payment_preimage, htlc.amount_msat,
10919 // Check if `counterparty_opt.is_none()` to see if the
10920 // downstream chan is closed (because we don't have a
10921 // channel_id -> peer map entry).
10922 counterparty_opt.is_none(),
10923 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
10924 monitor.get_funding_txo().0, monitor.channel_id()))
10927 // If it was an outbound payment, we've handled it above - if a preimage
10928 // came in and we persisted the `ChannelManager` we either handled it and
10929 // are good to go or the channel force-closed - we don't have to handle the
10930 // channel still live case here.
10934 for tuple in outbound_claimed_htlcs_iter {
10935 pending_claims_to_replay.push(tuple);
10940 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
10941 // If we have pending HTLCs to forward, assume we either dropped a
10942 // `PendingHTLCsForwardable` or the user received it but never processed it as they
10943 // shut down before the timer hit. Either way, set the time_forwardable to a small
10944 // constant as enough time has likely passed that we should simply handle the forwards
10945 // now, or at least after the user gets a chance to reconnect to our peers.
10946 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
10947 time_forwardable: Duration::from_secs(2),
10951 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
10952 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
10954 let mut claimable_payments = hash_map_with_capacity(claimable_htlcs_list.len());
10955 if let Some(purposes) = claimable_htlc_purposes {
10956 if purposes.len() != claimable_htlcs_list.len() {
10957 return Err(DecodeError::InvalidValue);
10959 if let Some(onion_fields) = claimable_htlc_onion_fields {
10960 if onion_fields.len() != claimable_htlcs_list.len() {
10961 return Err(DecodeError::InvalidValue);
10963 for (purpose, (onion, (payment_hash, htlcs))) in
10964 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
10966 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10967 purpose, htlcs, onion_fields: onion,
10969 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10972 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
10973 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10974 purpose, htlcs, onion_fields: None,
10976 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10980 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
10981 // include a `_legacy_hop_data` in the `OnionPayload`.
10982 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
10983 if htlcs.is_empty() {
10984 return Err(DecodeError::InvalidValue);
10986 let purpose = match &htlcs[0].onion_payload {
10987 OnionPayload::Invoice { _legacy_hop_data } => {
10988 if let Some(hop_data) = _legacy_hop_data {
10989 events::PaymentPurpose::InvoicePayment {
10990 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
10991 Some(inbound_payment) => inbound_payment.payment_preimage,
10992 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
10993 Ok((payment_preimage, _)) => payment_preimage,
10995 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);
10996 return Err(DecodeError::InvalidValue);
11000 payment_secret: hop_data.payment_secret,
11002 } else { return Err(DecodeError::InvalidValue); }
11004 OnionPayload::Spontaneous(payment_preimage) =>
11005 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
11007 claimable_payments.insert(payment_hash, ClaimablePayment {
11008 purpose, htlcs, onion_fields: None,
11013 let mut secp_ctx = Secp256k1::new();
11014 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
11016 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
11018 Err(()) => return Err(DecodeError::InvalidValue)
11020 if let Some(network_pubkey) = received_network_pubkey {
11021 if network_pubkey != our_network_pubkey {
11022 log_error!(args.logger, "Key that was generated does not match the existing key.");
11023 return Err(DecodeError::InvalidValue);
11027 let mut outbound_scid_aliases = new_hash_set();
11028 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
11029 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
11030 let peer_state = &mut *peer_state_lock;
11031 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
11032 if let ChannelPhase::Funded(chan) = phase {
11033 let logger = WithChannelContext::from(&args.logger, &chan.context);
11034 if chan.context.outbound_scid_alias() == 0 {
11035 let mut outbound_scid_alias;
11037 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
11038 .get_fake_scid(best_block_height, &chain_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
11039 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
11041 chan.context.set_outbound_scid_alias(outbound_scid_alias);
11042 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
11043 // Note that in rare cases its possible to hit this while reading an older
11044 // channel if we just happened to pick a colliding outbound alias above.
11045 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
11046 return Err(DecodeError::InvalidValue);
11048 if chan.context.is_usable() {
11049 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
11050 // Note that in rare cases its possible to hit this while reading an older
11051 // channel if we just happened to pick a colliding outbound alias above.
11052 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
11053 return Err(DecodeError::InvalidValue);
11057 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
11058 // created in this `channel_by_id` map.
11059 debug_assert!(false);
11060 return Err(DecodeError::InvalidValue);
11065 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
11067 for (_, monitor) in args.channel_monitors.iter() {
11068 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
11069 if let Some(payment) = claimable_payments.remove(&payment_hash) {
11070 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
11071 let mut claimable_amt_msat = 0;
11072 let mut receiver_node_id = Some(our_network_pubkey);
11073 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
11074 if phantom_shared_secret.is_some() {
11075 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
11076 .expect("Failed to get node_id for phantom node recipient");
11077 receiver_node_id = Some(phantom_pubkey)
11079 for claimable_htlc in &payment.htlcs {
11080 claimable_amt_msat += claimable_htlc.value;
11082 // Add a holding-cell claim of the payment to the Channel, which should be
11083 // applied ~immediately on peer reconnection. Because it won't generate a
11084 // new commitment transaction we can just provide the payment preimage to
11085 // the corresponding ChannelMonitor and nothing else.
11087 // We do so directly instead of via the normal ChannelMonitor update
11088 // procedure as the ChainMonitor hasn't yet been initialized, implying
11089 // we're not allowed to call it directly yet. Further, we do the update
11090 // without incrementing the ChannelMonitor update ID as there isn't any
11092 // If we were to generate a new ChannelMonitor update ID here and then
11093 // crash before the user finishes block connect we'd end up force-closing
11094 // this channel as well. On the flip side, there's no harm in restarting
11095 // without the new monitor persisted - we'll end up right back here on
11097 let previous_channel_id = claimable_htlc.prev_hop.channel_id;
11098 if let Some(peer_node_id) = outpoint_to_peer.get(&claimable_htlc.prev_hop.outpoint) {
11099 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
11100 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
11101 let peer_state = &mut *peer_state_lock;
11102 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
11103 let logger = WithChannelContext::from(&args.logger, &channel.context);
11104 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &&logger);
11107 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
11108 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
11111 pending_events_read.push_back((events::Event::PaymentClaimed {
11114 purpose: payment.purpose,
11115 amount_msat: claimable_amt_msat,
11116 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
11117 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
11123 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
11124 if let Some(peer_state) = per_peer_state.get(&node_id) {
11125 for (channel_id, actions) in monitor_update_blocked_actions.iter() {
11126 let logger = WithContext::from(&args.logger, Some(node_id), Some(*channel_id));
11127 for action in actions.iter() {
11128 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
11129 downstream_counterparty_and_funding_outpoint:
11130 Some((blocked_node_id, _blocked_channel_outpoint, blocked_channel_id, blocking_action)), ..
11132 if let Some(blocked_peer_state) = per_peer_state.get(blocked_node_id) {
11134 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
11135 blocked_channel_id);
11136 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
11137 .entry(*blocked_channel_id)
11138 .or_insert_with(Vec::new).push(blocking_action.clone());
11140 // If the channel we were blocking has closed, we don't need to
11141 // worry about it - the blocked monitor update should never have
11142 // been released from the `Channel` object so it can't have
11143 // completed, and if the channel closed there's no reason to bother
11147 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately { .. } = action {
11148 debug_assert!(false, "Non-event-generating channel freeing should not appear in our queue");
11152 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
11154 log_error!(WithContext::from(&args.logger, Some(node_id), None), "Got blocked actions without a per-peer-state for {}", node_id);
11155 return Err(DecodeError::InvalidValue);
11159 let channel_manager = ChannelManager {
11161 fee_estimator: bounded_fee_estimator,
11162 chain_monitor: args.chain_monitor,
11163 tx_broadcaster: args.tx_broadcaster,
11164 router: args.router,
11166 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
11168 inbound_payment_key: expanded_inbound_key,
11169 pending_inbound_payments: Mutex::new(pending_inbound_payments),
11170 pending_outbound_payments: pending_outbounds,
11171 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
11173 forward_htlcs: Mutex::new(forward_htlcs),
11174 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
11175 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
11176 outpoint_to_peer: Mutex::new(outpoint_to_peer),
11177 short_to_chan_info: FairRwLock::new(short_to_chan_info),
11178 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
11180 probing_cookie_secret: probing_cookie_secret.unwrap(),
11182 our_network_pubkey,
11185 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
11187 per_peer_state: FairRwLock::new(per_peer_state),
11189 pending_events: Mutex::new(pending_events_read),
11190 pending_events_processor: AtomicBool::new(false),
11191 pending_background_events: Mutex::new(pending_background_events),
11192 total_consistency_lock: RwLock::new(()),
11193 background_events_processed_since_startup: AtomicBool::new(false),
11195 event_persist_notifier: Notifier::new(),
11196 needs_persist_flag: AtomicBool::new(false),
11198 funding_batch_states: Mutex::new(BTreeMap::new()),
11200 pending_offers_messages: Mutex::new(Vec::new()),
11202 entropy_source: args.entropy_source,
11203 node_signer: args.node_signer,
11204 signer_provider: args.signer_provider,
11206 logger: args.logger,
11207 default_configuration: args.default_config,
11210 for htlc_source in failed_htlcs.drain(..) {
11211 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
11212 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
11213 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
11214 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
11217 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding, downstream_channel_id) in pending_claims_to_replay {
11218 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
11219 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
11220 // channel is closed we just assume that it probably came from an on-chain claim.
11221 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value), None,
11222 downstream_closed, true, downstream_node_id, downstream_funding, downstream_channel_id);
11225 //TODO: Broadcast channel update for closed channels, but only after we've made a
11226 //connection or two.
11228 Ok((best_block_hash.clone(), channel_manager))
11234 use bitcoin::hashes::Hash;
11235 use bitcoin::hashes::sha256::Hash as Sha256;
11236 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
11237 use core::sync::atomic::Ordering;
11238 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
11239 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
11240 use crate::ln::ChannelId;
11241 use crate::ln::channelmanager::{create_recv_pending_htlc_info, HTLCForwardInfo, inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
11242 use crate::ln::functional_test_utils::*;
11243 use crate::ln::msgs::{self, ErrorAction};
11244 use crate::ln::msgs::ChannelMessageHandler;
11245 use crate::prelude::*;
11246 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
11247 use crate::util::errors::APIError;
11248 use crate::util::ser::Writeable;
11249 use crate::util::test_utils;
11250 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
11251 use crate::sign::EntropySource;
11254 fn test_notify_limits() {
11255 // Check that a few cases which don't require the persistence of a new ChannelManager,
11256 // indeed, do not cause the persistence of a new ChannelManager.
11257 let chanmon_cfgs = create_chanmon_cfgs(3);
11258 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
11259 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
11260 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
11262 // All nodes start with a persistable update pending as `create_network` connects each node
11263 // with all other nodes to make most tests simpler.
11264 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11265 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11266 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11268 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11270 // We check that the channel info nodes have doesn't change too early, even though we try
11271 // to connect messages with new values
11272 chan.0.contents.fee_base_msat *= 2;
11273 chan.1.contents.fee_base_msat *= 2;
11274 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
11275 &nodes[1].node.get_our_node_id()).pop().unwrap();
11276 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
11277 &nodes[0].node.get_our_node_id()).pop().unwrap();
11279 // The first two nodes (which opened a channel) should now require fresh persistence
11280 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11281 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11282 // ... but the last node should not.
11283 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11284 // After persisting the first two nodes they should no longer need fresh persistence.
11285 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11286 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11288 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
11289 // about the channel.
11290 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
11291 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
11292 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11294 // The nodes which are a party to the channel should also ignore messages from unrelated
11296 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11297 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11298 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11299 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11300 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11301 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11303 // At this point the channel info given by peers should still be the same.
11304 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11305 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11307 // An earlier version of handle_channel_update didn't check the directionality of the
11308 // update message and would always update the local fee info, even if our peer was
11309 // (spuriously) forwarding us our own channel_update.
11310 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
11311 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
11312 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
11314 // First deliver each peers' own message, checking that the node doesn't need to be
11315 // persisted and that its channel info remains the same.
11316 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
11317 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
11318 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11319 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11320 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11321 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11323 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
11324 // the channel info has updated.
11325 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
11326 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
11327 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11328 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11329 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
11330 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
11334 fn test_keysend_dup_hash_partial_mpp() {
11335 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
11337 let chanmon_cfgs = create_chanmon_cfgs(2);
11338 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11339 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11340 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11341 create_announced_chan_between_nodes(&nodes, 0, 1);
11343 // First, send a partial MPP payment.
11344 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
11345 let mut mpp_route = route.clone();
11346 mpp_route.paths.push(mpp_route.paths[0].clone());
11348 let payment_id = PaymentId([42; 32]);
11349 // Use the utility function send_payment_along_path to send the payment with MPP data which
11350 // indicates there are more HTLCs coming.
11351 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.
11352 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
11353 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
11354 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
11355 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
11356 check_added_monitors!(nodes[0], 1);
11357 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11358 assert_eq!(events.len(), 1);
11359 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
11361 // Next, send a keysend payment with the same payment_hash and make sure it fails.
11362 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11363 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11364 check_added_monitors!(nodes[0], 1);
11365 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11366 assert_eq!(events.len(), 1);
11367 let ev = events.drain(..).next().unwrap();
11368 let payment_event = SendEvent::from_event(ev);
11369 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11370 check_added_monitors!(nodes[1], 0);
11371 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11372 expect_pending_htlcs_forwardable!(nodes[1]);
11373 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
11374 check_added_monitors!(nodes[1], 1);
11375 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11376 assert!(updates.update_add_htlcs.is_empty());
11377 assert!(updates.update_fulfill_htlcs.is_empty());
11378 assert_eq!(updates.update_fail_htlcs.len(), 1);
11379 assert!(updates.update_fail_malformed_htlcs.is_empty());
11380 assert!(updates.update_fee.is_none());
11381 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11382 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11383 expect_payment_failed!(nodes[0], our_payment_hash, true);
11385 // Send the second half of the original MPP payment.
11386 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
11387 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
11388 check_added_monitors!(nodes[0], 1);
11389 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11390 assert_eq!(events.len(), 1);
11391 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
11393 // Claim the full MPP payment. Note that we can't use a test utility like
11394 // claim_funds_along_route because the ordering of the messages causes the second half of the
11395 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
11396 // lightning messages manually.
11397 nodes[1].node.claim_funds(payment_preimage);
11398 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
11399 check_added_monitors!(nodes[1], 2);
11401 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11402 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
11403 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
11404 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
11405 check_added_monitors!(nodes[0], 1);
11406 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11407 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
11408 check_added_monitors!(nodes[1], 1);
11409 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11410 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
11411 check_added_monitors!(nodes[1], 1);
11412 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11413 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
11414 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
11415 check_added_monitors!(nodes[0], 1);
11416 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
11417 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
11418 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11419 check_added_monitors!(nodes[0], 1);
11420 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
11421 check_added_monitors!(nodes[1], 1);
11422 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
11423 check_added_monitors!(nodes[1], 1);
11424 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11425 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
11426 check_added_monitors!(nodes[0], 1);
11428 // Note that successful MPP payments will generate a single PaymentSent event upon the first
11429 // path's success and a PaymentPathSuccessful event for each path's success.
11430 let events = nodes[0].node.get_and_clear_pending_events();
11431 assert_eq!(events.len(), 2);
11433 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11434 assert_eq!(payment_id, *actual_payment_id);
11435 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11436 assert_eq!(route.paths[0], *path);
11438 _ => panic!("Unexpected event"),
11441 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11442 assert_eq!(payment_id, *actual_payment_id);
11443 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11444 assert_eq!(route.paths[0], *path);
11446 _ => panic!("Unexpected event"),
11451 fn test_keysend_dup_payment_hash() {
11452 do_test_keysend_dup_payment_hash(false);
11453 do_test_keysend_dup_payment_hash(true);
11456 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
11457 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
11458 // outbound regular payment fails as expected.
11459 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
11460 // fails as expected.
11461 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
11462 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
11463 // reject MPP keysend payments, since in this case where the payment has no payment
11464 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
11465 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
11466 // payment secrets and reject otherwise.
11467 let chanmon_cfgs = create_chanmon_cfgs(2);
11468 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11469 let mut mpp_keysend_cfg = test_default_channel_config();
11470 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
11471 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
11472 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11473 create_announced_chan_between_nodes(&nodes, 0, 1);
11474 let scorer = test_utils::TestScorer::new();
11475 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11477 // To start (1), send a regular payment but don't claim it.
11478 let expected_route = [&nodes[1]];
11479 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
11481 // Next, attempt a keysend payment and make sure it fails.
11482 let route_params = RouteParameters::from_payment_params_and_value(
11483 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
11484 TEST_FINAL_CLTV, false), 100_000);
11485 let route = find_route(
11486 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11487 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11489 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11490 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11491 check_added_monitors!(nodes[0], 1);
11492 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11493 assert_eq!(events.len(), 1);
11494 let ev = events.drain(..).next().unwrap();
11495 let payment_event = SendEvent::from_event(ev);
11496 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11497 check_added_monitors!(nodes[1], 0);
11498 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11499 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
11500 // fails), the second will process the resulting failure and fail the HTLC backward
11501 expect_pending_htlcs_forwardable!(nodes[1]);
11502 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11503 check_added_monitors!(nodes[1], 1);
11504 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11505 assert!(updates.update_add_htlcs.is_empty());
11506 assert!(updates.update_fulfill_htlcs.is_empty());
11507 assert_eq!(updates.update_fail_htlcs.len(), 1);
11508 assert!(updates.update_fail_malformed_htlcs.is_empty());
11509 assert!(updates.update_fee.is_none());
11510 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11511 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11512 expect_payment_failed!(nodes[0], payment_hash, true);
11514 // Finally, claim the original payment.
11515 claim_payment(&nodes[0], &expected_route, payment_preimage);
11517 // To start (2), send a keysend payment but don't claim it.
11518 let payment_preimage = PaymentPreimage([42; 32]);
11519 let route = find_route(
11520 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11521 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11523 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11524 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11525 check_added_monitors!(nodes[0], 1);
11526 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11527 assert_eq!(events.len(), 1);
11528 let event = events.pop().unwrap();
11529 let path = vec![&nodes[1]];
11530 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11532 // Next, attempt a regular payment and make sure it fails.
11533 let payment_secret = PaymentSecret([43; 32]);
11534 nodes[0].node.send_payment_with_route(&route, payment_hash,
11535 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
11536 check_added_monitors!(nodes[0], 1);
11537 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11538 assert_eq!(events.len(), 1);
11539 let ev = events.drain(..).next().unwrap();
11540 let payment_event = SendEvent::from_event(ev);
11541 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11542 check_added_monitors!(nodes[1], 0);
11543 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11544 expect_pending_htlcs_forwardable!(nodes[1]);
11545 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11546 check_added_monitors!(nodes[1], 1);
11547 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11548 assert!(updates.update_add_htlcs.is_empty());
11549 assert!(updates.update_fulfill_htlcs.is_empty());
11550 assert_eq!(updates.update_fail_htlcs.len(), 1);
11551 assert!(updates.update_fail_malformed_htlcs.is_empty());
11552 assert!(updates.update_fee.is_none());
11553 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11554 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11555 expect_payment_failed!(nodes[0], payment_hash, true);
11557 // Finally, succeed the keysend payment.
11558 claim_payment(&nodes[0], &expected_route, payment_preimage);
11560 // To start (3), send a keysend payment but don't claim it.
11561 let payment_id_1 = PaymentId([44; 32]);
11562 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11563 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
11564 check_added_monitors!(nodes[0], 1);
11565 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11566 assert_eq!(events.len(), 1);
11567 let event = events.pop().unwrap();
11568 let path = vec![&nodes[1]];
11569 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11571 // Next, attempt a keysend payment and make sure it fails.
11572 let route_params = RouteParameters::from_payment_params_and_value(
11573 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
11576 let route = find_route(
11577 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11578 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11580 let payment_id_2 = PaymentId([45; 32]);
11581 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11582 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
11583 check_added_monitors!(nodes[0], 1);
11584 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11585 assert_eq!(events.len(), 1);
11586 let ev = events.drain(..).next().unwrap();
11587 let payment_event = SendEvent::from_event(ev);
11588 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11589 check_added_monitors!(nodes[1], 0);
11590 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11591 expect_pending_htlcs_forwardable!(nodes[1]);
11592 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11593 check_added_monitors!(nodes[1], 1);
11594 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11595 assert!(updates.update_add_htlcs.is_empty());
11596 assert!(updates.update_fulfill_htlcs.is_empty());
11597 assert_eq!(updates.update_fail_htlcs.len(), 1);
11598 assert!(updates.update_fail_malformed_htlcs.is_empty());
11599 assert!(updates.update_fee.is_none());
11600 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11601 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11602 expect_payment_failed!(nodes[0], payment_hash, true);
11604 // Finally, claim the original payment.
11605 claim_payment(&nodes[0], &expected_route, payment_preimage);
11609 fn test_keysend_hash_mismatch() {
11610 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
11611 // preimage doesn't match the msg's payment hash.
11612 let chanmon_cfgs = create_chanmon_cfgs(2);
11613 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11614 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11615 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11617 let payer_pubkey = nodes[0].node.get_our_node_id();
11618 let payee_pubkey = nodes[1].node.get_our_node_id();
11620 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11621 let route_params = RouteParameters::from_payment_params_and_value(
11622 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11623 let network_graph = nodes[0].network_graph;
11624 let first_hops = nodes[0].node.list_usable_channels();
11625 let scorer = test_utils::TestScorer::new();
11626 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11627 let route = find_route(
11628 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11629 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11632 let test_preimage = PaymentPreimage([42; 32]);
11633 let mismatch_payment_hash = PaymentHash([43; 32]);
11634 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
11635 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
11636 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
11637 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
11638 check_added_monitors!(nodes[0], 1);
11640 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11641 assert_eq!(updates.update_add_htlcs.len(), 1);
11642 assert!(updates.update_fulfill_htlcs.is_empty());
11643 assert!(updates.update_fail_htlcs.is_empty());
11644 assert!(updates.update_fail_malformed_htlcs.is_empty());
11645 assert!(updates.update_fee.is_none());
11646 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11648 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
11652 fn test_keysend_msg_with_secret_err() {
11653 // Test that we error as expected if we receive a keysend payment that includes a payment
11654 // secret when we don't support MPP keysend.
11655 let mut reject_mpp_keysend_cfg = test_default_channel_config();
11656 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
11657 let chanmon_cfgs = create_chanmon_cfgs(2);
11658 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11659 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
11660 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11662 let payer_pubkey = nodes[0].node.get_our_node_id();
11663 let payee_pubkey = nodes[1].node.get_our_node_id();
11665 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11666 let route_params = RouteParameters::from_payment_params_and_value(
11667 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11668 let network_graph = nodes[0].network_graph;
11669 let first_hops = nodes[0].node.list_usable_channels();
11670 let scorer = test_utils::TestScorer::new();
11671 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11672 let route = find_route(
11673 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11674 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11677 let test_preimage = PaymentPreimage([42; 32]);
11678 let test_secret = PaymentSecret([43; 32]);
11679 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).to_byte_array());
11680 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
11681 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
11682 nodes[0].node.test_send_payment_internal(&route, payment_hash,
11683 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
11684 PaymentId(payment_hash.0), None, session_privs).unwrap();
11685 check_added_monitors!(nodes[0], 1);
11687 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11688 assert_eq!(updates.update_add_htlcs.len(), 1);
11689 assert!(updates.update_fulfill_htlcs.is_empty());
11690 assert!(updates.update_fail_htlcs.is_empty());
11691 assert!(updates.update_fail_malformed_htlcs.is_empty());
11692 assert!(updates.update_fee.is_none());
11693 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11695 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
11699 fn test_multi_hop_missing_secret() {
11700 let chanmon_cfgs = create_chanmon_cfgs(4);
11701 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
11702 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
11703 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
11705 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
11706 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
11707 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
11708 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
11710 // Marshall an MPP route.
11711 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
11712 let path = route.paths[0].clone();
11713 route.paths.push(path);
11714 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
11715 route.paths[0].hops[0].short_channel_id = chan_1_id;
11716 route.paths[0].hops[1].short_channel_id = chan_3_id;
11717 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
11718 route.paths[1].hops[0].short_channel_id = chan_2_id;
11719 route.paths[1].hops[1].short_channel_id = chan_4_id;
11721 match nodes[0].node.send_payment_with_route(&route, payment_hash,
11722 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
11724 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
11725 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
11727 _ => panic!("unexpected error")
11732 fn test_drop_disconnected_peers_when_removing_channels() {
11733 let chanmon_cfgs = create_chanmon_cfgs(2);
11734 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11735 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11736 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11738 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11740 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
11741 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11743 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
11744 check_closed_broadcast!(nodes[0], true);
11745 check_added_monitors!(nodes[0], 1);
11746 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
11749 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
11750 // disconnected and the channel between has been force closed.
11751 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
11752 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
11753 assert_eq!(nodes_0_per_peer_state.len(), 1);
11754 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
11757 nodes[0].node.timer_tick_occurred();
11760 // Assert that nodes[1] has now been removed.
11761 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
11766 fn bad_inbound_payment_hash() {
11767 // Add coverage for checking that a user-provided payment hash matches the payment secret.
11768 let chanmon_cfgs = create_chanmon_cfgs(2);
11769 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11770 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11771 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11773 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
11774 let payment_data = msgs::FinalOnionHopData {
11776 total_msat: 100_000,
11779 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
11780 // payment verification fails as expected.
11781 let mut bad_payment_hash = payment_hash.clone();
11782 bad_payment_hash.0[0] += 1;
11783 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) {
11784 Ok(_) => panic!("Unexpected ok"),
11786 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
11790 // Check that using the original payment hash succeeds.
11791 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());
11795 fn test_outpoint_to_peer_coverage() {
11796 // Test that the `ChannelManager:outpoint_to_peer` contains channels which have been assigned
11797 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
11798 // the channel is successfully closed.
11799 let chanmon_cfgs = create_chanmon_cfgs(2);
11800 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11801 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11802 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11804 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, None).unwrap();
11805 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11806 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
11807 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11808 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11810 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
11811 let channel_id = ChannelId::from_bytes(tx.txid().to_byte_array());
11813 // Ensure that the `outpoint_to_peer` map is empty until either party has received the
11814 // funding transaction, and have the real `channel_id`.
11815 assert_eq!(nodes[0].node.outpoint_to_peer.lock().unwrap().len(), 0);
11816 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11819 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
11821 // Assert that `nodes[0]`'s `outpoint_to_peer` map is populated with the channel as soon as
11822 // as it has the funding transaction.
11823 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11824 assert_eq!(nodes_0_lock.len(), 1);
11825 assert!(nodes_0_lock.contains_key(&funding_output));
11828 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11830 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11832 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11834 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11835 assert_eq!(nodes_0_lock.len(), 1);
11836 assert!(nodes_0_lock.contains_key(&funding_output));
11838 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11841 // Assert that `nodes[1]`'s `outpoint_to_peer` map is populated with the channel as
11842 // soon as it has the funding transaction.
11843 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11844 assert_eq!(nodes_1_lock.len(), 1);
11845 assert!(nodes_1_lock.contains_key(&funding_output));
11847 check_added_monitors!(nodes[1], 1);
11848 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11849 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11850 check_added_monitors!(nodes[0], 1);
11851 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11852 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
11853 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
11854 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
11856 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
11857 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()));
11858 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
11859 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
11861 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
11862 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
11864 // Assert that the channel is kept in the `outpoint_to_peer` map for both nodes until the
11865 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
11866 // fee for the closing transaction has been negotiated and the parties has the other
11867 // party's signature for the fee negotiated closing transaction.)
11868 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11869 assert_eq!(nodes_0_lock.len(), 1);
11870 assert!(nodes_0_lock.contains_key(&funding_output));
11874 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
11875 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
11876 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
11877 // kept in the `nodes[1]`'s `outpoint_to_peer` map.
11878 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11879 assert_eq!(nodes_1_lock.len(), 1);
11880 assert!(nodes_1_lock.contains_key(&funding_output));
11883 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()));
11885 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
11886 // therefore has all it needs to fully close the channel (both signatures for the
11887 // closing transaction).
11888 // Assert that the channel is removed from `nodes[0]`'s `outpoint_to_peer` map as it can be
11889 // fully closed by `nodes[0]`.
11890 assert_eq!(nodes[0].node.outpoint_to_peer.lock().unwrap().len(), 0);
11892 // Assert that the channel is still in `nodes[1]`'s `outpoint_to_peer` map, as `nodes[1]`
11893 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
11894 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11895 assert_eq!(nodes_1_lock.len(), 1);
11896 assert!(nodes_1_lock.contains_key(&funding_output));
11899 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
11901 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
11903 // Assert that the channel has now been removed from both parties `outpoint_to_peer` map once
11904 // they both have everything required to fully close the channel.
11905 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11907 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
11909 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
11910 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
11913 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11914 let expected_message = format!("Not connected to node: {}", expected_public_key);
11915 check_api_error_message(expected_message, res_err)
11918 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11919 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
11920 check_api_error_message(expected_message, res_err)
11923 fn check_channel_unavailable_error<T>(res_err: Result<T, APIError>, expected_channel_id: ChannelId, peer_node_id: PublicKey) {
11924 let expected_message = format!("Channel with id {} not found for the passed counterparty node_id {}", expected_channel_id, peer_node_id);
11925 check_api_error_message(expected_message, res_err)
11928 fn check_api_misuse_error<T>(res_err: Result<T, APIError>) {
11929 let expected_message = "No such channel awaiting to be accepted.".to_string();
11930 check_api_error_message(expected_message, res_err)
11933 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
11935 Err(APIError::APIMisuseError { err }) => {
11936 assert_eq!(err, expected_err_message);
11938 Err(APIError::ChannelUnavailable { err }) => {
11939 assert_eq!(err, expected_err_message);
11941 Ok(_) => panic!("Unexpected Ok"),
11942 Err(_) => panic!("Unexpected Error"),
11947 fn test_api_calls_with_unkown_counterparty_node() {
11948 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
11949 // expected if the `counterparty_node_id` is an unkown peer in the
11950 // `ChannelManager::per_peer_state` map.
11951 let chanmon_cfg = create_chanmon_cfgs(2);
11952 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11953 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11954 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11957 let channel_id = ChannelId::from_bytes([4; 32]);
11958 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
11959 let intercept_id = InterceptId([0; 32]);
11961 // Test the API functions.
11962 check_not_connected_to_peer_error(nodes[0].node.create_channel(unkown_public_key, 1_000_000, 500_000_000, 42, None, None), unkown_public_key);
11964 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
11966 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
11968 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
11970 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
11972 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
11974 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
11978 fn test_api_calls_with_unavailable_channel() {
11979 // Tests that our API functions that expects a `counterparty_node_id` and a `channel_id`
11980 // as input, behaves as expected if the `counterparty_node_id` is a known peer in the
11981 // `ChannelManager::per_peer_state` map, but the peer state doesn't contain a channel with
11982 // the given `channel_id`.
11983 let chanmon_cfg = create_chanmon_cfgs(2);
11984 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11985 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11986 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11988 let counterparty_node_id = nodes[1].node.get_our_node_id();
11991 let channel_id = ChannelId::from_bytes([4; 32]);
11993 // Test the API functions.
11994 check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42));
11996 check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11998 check_channel_unavailable_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
12000 check_channel_unavailable_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
12002 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);
12004 check_channel_unavailable_error(nodes[0].node.update_channel_config(&counterparty_node_id, &[channel_id], &ChannelConfig::default()), channel_id, counterparty_node_id);
12008 fn test_connection_limiting() {
12009 // Test that we limit un-channel'd peers and un-funded channels properly.
12010 let chanmon_cfgs = create_chanmon_cfgs(2);
12011 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12012 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
12013 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12015 // Note that create_network connects the nodes together for us
12017 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12018 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12020 let mut funding_tx = None;
12021 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
12022 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12023 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12026 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
12027 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
12028 funding_tx = Some(tx.clone());
12029 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
12030 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
12032 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
12033 check_added_monitors!(nodes[1], 1);
12034 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
12036 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
12038 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
12039 check_added_monitors!(nodes[0], 1);
12040 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
12042 open_channel_msg.common_fields.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12045 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
12046 open_channel_msg.common_fields.temporary_channel_id = ChannelId::temporary_from_entropy_source(
12047 &nodes[0].keys_manager);
12048 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12049 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12050 open_channel_msg.common_fields.temporary_channel_id);
12052 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
12053 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
12055 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
12056 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
12057 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12058 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12059 peer_pks.push(random_pk);
12060 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
12061 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12064 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12065 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12066 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12067 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12068 }, true).unwrap_err();
12070 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
12071 // them if we have too many un-channel'd peers.
12072 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12073 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
12074 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
12075 for ev in chan_closed_events {
12076 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
12078 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12079 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12081 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12082 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12083 }, true).unwrap_err();
12085 // but of course if the connection is outbound its allowed...
12086 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12087 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12088 }, false).unwrap();
12089 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12091 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
12092 // Even though we accept one more connection from new peers, we won't actually let them
12094 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
12095 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
12096 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
12097 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
12098 open_channel_msg.common_fields.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12100 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12101 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
12102 open_channel_msg.common_fields.temporary_channel_id);
12104 // Of course, however, outbound channels are always allowed
12105 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None, None).unwrap();
12106 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
12108 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
12109 // "protected" and can connect again.
12110 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
12111 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12112 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12114 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
12116 // Further, because the first channel was funded, we can open another channel with
12118 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12119 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
12123 fn test_outbound_chans_unlimited() {
12124 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
12125 let chanmon_cfgs = create_chanmon_cfgs(2);
12126 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12127 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
12128 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12130 // Note that create_network connects the nodes together for us
12132 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12133 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12135 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
12136 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12137 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12138 open_channel_msg.common_fields.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12141 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
12143 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12144 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12145 open_channel_msg.common_fields.temporary_channel_id);
12147 // but we can still open an outbound channel.
12148 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12149 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
12151 // but even with such an outbound channel, additional inbound channels will still fail.
12152 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12153 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12154 open_channel_msg.common_fields.temporary_channel_id);
12158 fn test_0conf_limiting() {
12159 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12160 // flag set and (sometimes) accept channels as 0conf.
12161 let chanmon_cfgs = create_chanmon_cfgs(2);
12162 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12163 let mut settings = test_default_channel_config();
12164 settings.manually_accept_inbound_channels = true;
12165 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
12166 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12168 // Note that create_network connects the nodes together for us
12170 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12171 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12173 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
12174 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
12175 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12176 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12177 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
12178 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12181 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
12182 let events = nodes[1].node.get_and_clear_pending_events();
12184 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12185 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
12187 _ => panic!("Unexpected event"),
12189 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
12190 open_channel_msg.common_fields.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12193 // If we try to accept a channel from another peer non-0conf it will fail.
12194 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12195 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12196 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12197 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12199 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12200 let events = nodes[1].node.get_and_clear_pending_events();
12202 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12203 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
12204 Err(APIError::APIMisuseError { err }) =>
12205 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
12209 _ => panic!("Unexpected event"),
12211 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
12212 open_channel_msg.common_fields.temporary_channel_id);
12214 // ...however if we accept the same channel 0conf it should work just fine.
12215 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12216 let events = nodes[1].node.get_and_clear_pending_events();
12218 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12219 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
12221 _ => panic!("Unexpected event"),
12223 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
12227 fn reject_excessively_underpaying_htlcs() {
12228 let chanmon_cfg = create_chanmon_cfgs(1);
12229 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12230 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12231 let node = create_network(1, &node_cfg, &node_chanmgr);
12232 let sender_intended_amt_msat = 100;
12233 let extra_fee_msat = 10;
12234 let hop_data = msgs::InboundOnionPayload::Receive {
12235 sender_intended_htlc_amt_msat: 100,
12236 cltv_expiry_height: 42,
12237 payment_metadata: None,
12238 keysend_preimage: None,
12239 payment_data: Some(msgs::FinalOnionHopData {
12240 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12242 custom_tlvs: Vec::new(),
12244 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
12245 // intended amount, we fail the payment.
12246 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12247 if let Err(crate::ln::channelmanager::InboundHTLCErr { err_code, .. }) =
12248 create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12249 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat),
12250 current_height, node[0].node.default_configuration.accept_mpp_keysend)
12252 assert_eq!(err_code, 19);
12253 } else { panic!(); }
12255 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
12256 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
12257 sender_intended_htlc_amt_msat: 100,
12258 cltv_expiry_height: 42,
12259 payment_metadata: None,
12260 keysend_preimage: None,
12261 payment_data: Some(msgs::FinalOnionHopData {
12262 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12264 custom_tlvs: Vec::new(),
12266 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12267 assert!(create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12268 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat),
12269 current_height, node[0].node.default_configuration.accept_mpp_keysend).is_ok());
12273 fn test_final_incorrect_cltv(){
12274 let chanmon_cfg = create_chanmon_cfgs(1);
12275 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12276 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12277 let node = create_network(1, &node_cfg, &node_chanmgr);
12279 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12280 let result = create_recv_pending_htlc_info(msgs::InboundOnionPayload::Receive {
12281 sender_intended_htlc_amt_msat: 100,
12282 cltv_expiry_height: 22,
12283 payment_metadata: None,
12284 keysend_preimage: None,
12285 payment_data: Some(msgs::FinalOnionHopData {
12286 payment_secret: PaymentSecret([0; 32]), total_msat: 100,
12288 custom_tlvs: Vec::new(),
12289 }, [0; 32], PaymentHash([0; 32]), 100, 23, None, true, None, current_height,
12290 node[0].node.default_configuration.accept_mpp_keysend);
12292 // Should not return an error as this condition:
12293 // https://github.com/lightning/bolts/blob/4dcc377209509b13cf89a4b91fde7d478f5b46d8/04-onion-routing.md?plain=1#L334
12294 // is not satisfied.
12295 assert!(result.is_ok());
12299 fn test_inbound_anchors_manual_acceptance() {
12300 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12301 // flag set and (sometimes) accept channels as 0conf.
12302 let mut anchors_cfg = test_default_channel_config();
12303 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12305 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
12306 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
12308 let chanmon_cfgs = create_chanmon_cfgs(3);
12309 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
12310 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
12311 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
12312 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
12314 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12315 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12317 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12318 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12319 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
12320 match &msg_events[0] {
12321 MessageSendEvent::HandleError { node_id, action } => {
12322 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
12324 ErrorAction::SendErrorMessage { msg } =>
12325 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
12326 _ => panic!("Unexpected error action"),
12329 _ => panic!("Unexpected event"),
12332 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12333 let events = nodes[2].node.get_and_clear_pending_events();
12335 Event::OpenChannelRequest { temporary_channel_id, .. } =>
12336 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
12337 _ => panic!("Unexpected event"),
12339 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12343 fn test_anchors_zero_fee_htlc_tx_fallback() {
12344 // Tests that if both nodes support anchors, but the remote node does not want to accept
12345 // anchor channels at the moment, an error it sent to the local node such that it can retry
12346 // the channel without the anchors feature.
12347 let chanmon_cfgs = create_chanmon_cfgs(2);
12348 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12349 let mut anchors_config = test_default_channel_config();
12350 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12351 anchors_config.manually_accept_inbound_channels = true;
12352 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
12353 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12355 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None, None).unwrap();
12356 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12357 assert!(open_channel_msg.common_fields.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
12359 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12360 let events = nodes[1].node.get_and_clear_pending_events();
12362 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12363 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
12365 _ => panic!("Unexpected event"),
12368 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
12369 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
12371 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12372 assert!(!open_channel_msg.common_fields.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
12374 // Since nodes[1] should not have accepted the channel, it should
12375 // not have generated any events.
12376 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12380 fn test_update_channel_config() {
12381 let chanmon_cfg = create_chanmon_cfgs(2);
12382 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12383 let mut user_config = test_default_channel_config();
12384 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12385 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12386 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
12387 let channel = &nodes[0].node.list_channels()[0];
12389 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12390 let events = nodes[0].node.get_and_clear_pending_msg_events();
12391 assert_eq!(events.len(), 0);
12393 user_config.channel_config.forwarding_fee_base_msat += 10;
12394 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12395 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
12396 let events = nodes[0].node.get_and_clear_pending_msg_events();
12397 assert_eq!(events.len(), 1);
12399 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12400 _ => panic!("expected BroadcastChannelUpdate event"),
12403 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
12404 let events = nodes[0].node.get_and_clear_pending_msg_events();
12405 assert_eq!(events.len(), 0);
12407 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
12408 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12409 cltv_expiry_delta: Some(new_cltv_expiry_delta),
12410 ..Default::default()
12412 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12413 let events = nodes[0].node.get_and_clear_pending_msg_events();
12414 assert_eq!(events.len(), 1);
12416 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12417 _ => panic!("expected BroadcastChannelUpdate event"),
12420 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
12421 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12422 forwarding_fee_proportional_millionths: Some(new_fee),
12423 ..Default::default()
12425 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12426 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
12427 let events = nodes[0].node.get_and_clear_pending_msg_events();
12428 assert_eq!(events.len(), 1);
12430 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12431 _ => panic!("expected BroadcastChannelUpdate event"),
12434 // If we provide a channel_id not associated with the peer, we should get an error and no updates
12435 // should be applied to ensure update atomicity as specified in the API docs.
12436 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
12437 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
12438 let new_fee = current_fee + 100;
12441 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
12442 forwarding_fee_proportional_millionths: Some(new_fee),
12443 ..Default::default()
12445 Err(APIError::ChannelUnavailable { err: _ }),
12448 // Check that the fee hasn't changed for the channel that exists.
12449 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
12450 let events = nodes[0].node.get_and_clear_pending_msg_events();
12451 assert_eq!(events.len(), 0);
12455 fn test_payment_display() {
12456 let payment_id = PaymentId([42; 32]);
12457 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12458 let payment_hash = PaymentHash([42; 32]);
12459 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12460 let payment_preimage = PaymentPreimage([42; 32]);
12461 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12465 fn test_trigger_lnd_force_close() {
12466 let chanmon_cfg = create_chanmon_cfgs(2);
12467 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12468 let user_config = test_default_channel_config();
12469 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12470 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12472 // Open a channel, immediately disconnect each other, and broadcast Alice's latest state.
12473 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
12474 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
12475 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12476 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
12477 check_closed_broadcast(&nodes[0], 1, true);
12478 check_added_monitors(&nodes[0], 1);
12479 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
12481 let txn = nodes[0].tx_broadcaster.txn_broadcast();
12482 assert_eq!(txn.len(), 1);
12483 check_spends!(txn[0], funding_tx);
12486 // Since they're disconnected, Bob won't receive Alice's `Error` message. Reconnect them
12487 // such that Bob sends a `ChannelReestablish` to Alice since the channel is still open from
12489 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
12490 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
12492 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12493 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12494 }, false).unwrap();
12495 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
12496 let channel_reestablish = get_event_msg!(
12497 nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()
12499 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &channel_reestablish);
12501 // Alice should respond with an error since the channel isn't known, but a bogus
12502 // `ChannelReestablish` should be sent first, such that we actually trigger Bob to force
12503 // close even if it was an lnd node.
12504 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
12505 assert_eq!(msg_events.len(), 2);
12506 if let MessageSendEvent::SendChannelReestablish { node_id, msg } = &msg_events[0] {
12507 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
12508 assert_eq!(msg.next_local_commitment_number, 0);
12509 assert_eq!(msg.next_remote_commitment_number, 0);
12510 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &msg);
12511 } else { panic!() };
12512 check_closed_broadcast(&nodes[1], 1, true);
12513 check_added_monitors(&nodes[1], 1);
12514 let expected_close_reason = ClosureReason::ProcessingError {
12515 err: "Peer sent an invalid channel_reestablish to force close in a non-standard way".to_string()
12517 check_closed_event!(nodes[1], 1, expected_close_reason, [nodes[0].node.get_our_node_id()], 100000);
12519 let txn = nodes[1].tx_broadcaster.txn_broadcast();
12520 assert_eq!(txn.len(), 1);
12521 check_spends!(txn[0], funding_tx);
12526 fn test_malformed_forward_htlcs_ser() {
12527 // Ensure that `HTLCForwardInfo::FailMalformedHTLC`s are (de)serialized properly.
12528 let chanmon_cfg = create_chanmon_cfgs(1);
12529 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12532 let chanmgrs = create_node_chanmgrs(1, &node_cfg, &[None]);
12533 let deserialized_chanmgr;
12534 let mut nodes = create_network(1, &node_cfg, &chanmgrs);
12536 let dummy_failed_htlc = |htlc_id| {
12537 HTLCForwardInfo::FailHTLC { htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }, }
12539 let dummy_malformed_htlc = |htlc_id| {
12540 HTLCForwardInfo::FailMalformedHTLC { htlc_id, failure_code: 0x4000, sha256_of_onion: [0; 32] }
12543 let dummy_htlcs_1: Vec<HTLCForwardInfo> = (1..10).map(|htlc_id| {
12544 if htlc_id % 2 == 0 {
12545 dummy_failed_htlc(htlc_id)
12547 dummy_malformed_htlc(htlc_id)
12551 let dummy_htlcs_2: Vec<HTLCForwardInfo> = (1..10).map(|htlc_id| {
12552 if htlc_id % 2 == 1 {
12553 dummy_failed_htlc(htlc_id)
12555 dummy_malformed_htlc(htlc_id)
12560 let (scid_1, scid_2) = (42, 43);
12561 let mut forward_htlcs = new_hash_map();
12562 forward_htlcs.insert(scid_1, dummy_htlcs_1.clone());
12563 forward_htlcs.insert(scid_2, dummy_htlcs_2.clone());
12565 let mut chanmgr_fwd_htlcs = nodes[0].node.forward_htlcs.lock().unwrap();
12566 *chanmgr_fwd_htlcs = forward_htlcs.clone();
12567 core::mem::drop(chanmgr_fwd_htlcs);
12569 reload_node!(nodes[0], nodes[0].node.encode(), &[], persister, chain_monitor, deserialized_chanmgr);
12571 let mut deserialized_fwd_htlcs = nodes[0].node.forward_htlcs.lock().unwrap();
12572 for scid in [scid_1, scid_2].iter() {
12573 let deserialized_htlcs = deserialized_fwd_htlcs.remove(scid).unwrap();
12574 assert_eq!(forward_htlcs.remove(scid).unwrap(), deserialized_htlcs);
12576 assert!(deserialized_fwd_htlcs.is_empty());
12577 core::mem::drop(deserialized_fwd_htlcs);
12579 expect_pending_htlcs_forwardable!(nodes[0]);
12585 use crate::chain::Listen;
12586 use crate::chain::chainmonitor::{ChainMonitor, Persist};
12587 use crate::sign::{KeysManager, InMemorySigner};
12588 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
12589 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
12590 use crate::ln::functional_test_utils::*;
12591 use crate::ln::msgs::{ChannelMessageHandler, Init};
12592 use crate::routing::gossip::NetworkGraph;
12593 use crate::routing::router::{PaymentParameters, RouteParameters};
12594 use crate::util::test_utils;
12595 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
12597 use bitcoin::blockdata::locktime::absolute::LockTime;
12598 use bitcoin::hashes::Hash;
12599 use bitcoin::hashes::sha256::Hash as Sha256;
12600 use bitcoin::{Transaction, TxOut};
12602 use crate::sync::{Arc, Mutex, RwLock};
12604 use criterion::Criterion;
12606 type Manager<'a, P> = ChannelManager<
12607 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
12608 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
12609 &'a test_utils::TestLogger, &'a P>,
12610 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
12611 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
12612 &'a test_utils::TestLogger>;
12614 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
12615 node: &'node_cfg Manager<'chan_mon_cfg, P>,
12617 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
12618 type CM = Manager<'chan_mon_cfg, P>;
12620 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
12622 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
12625 pub fn bench_sends(bench: &mut Criterion) {
12626 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
12629 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
12630 // Do a simple benchmark of sending a payment back and forth between two nodes.
12631 // Note that this is unrealistic as each payment send will require at least two fsync
12633 let network = bitcoin::Network::Testnet;
12634 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
12636 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
12637 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
12638 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
12639 let scorer = RwLock::new(test_utils::TestScorer::new());
12640 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &logger_a, &scorer);
12642 let mut config: UserConfig = Default::default();
12643 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
12644 config.channel_handshake_config.minimum_depth = 1;
12646 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
12647 let seed_a = [1u8; 32];
12648 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
12649 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 {
12651 best_block: BestBlock::from_network(network),
12652 }, genesis_block.header.time);
12653 let node_a_holder = ANodeHolder { node: &node_a };
12655 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
12656 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
12657 let seed_b = [2u8; 32];
12658 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
12659 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 {
12661 best_block: BestBlock::from_network(network),
12662 }, genesis_block.header.time);
12663 let node_b_holder = ANodeHolder { node: &node_b };
12665 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
12666 features: node_b.init_features(), networks: None, remote_network_address: None
12668 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
12669 features: node_a.init_features(), networks: None, remote_network_address: None
12670 }, false).unwrap();
12671 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None, None).unwrap();
12672 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()));
12673 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()));
12676 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
12677 tx = Transaction { version: 2, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
12678 value: 8_000_000, script_pubkey: output_script,
12680 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
12681 } else { panic!(); }
12683 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()));
12684 let events_b = node_b.get_and_clear_pending_events();
12685 assert_eq!(events_b.len(), 1);
12686 match events_b[0] {
12687 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12688 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12690 _ => panic!("Unexpected event"),
12693 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()));
12694 let events_a = node_a.get_and_clear_pending_events();
12695 assert_eq!(events_a.len(), 1);
12696 match events_a[0] {
12697 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12698 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12700 _ => panic!("Unexpected event"),
12703 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
12705 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
12706 Listen::block_connected(&node_a, &block, 1);
12707 Listen::block_connected(&node_b, &block, 1);
12709 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()));
12710 let msg_events = node_a.get_and_clear_pending_msg_events();
12711 assert_eq!(msg_events.len(), 2);
12712 match msg_events[0] {
12713 MessageSendEvent::SendChannelReady { ref msg, .. } => {
12714 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
12715 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
12719 match msg_events[1] {
12720 MessageSendEvent::SendChannelUpdate { .. } => {},
12724 let events_a = node_a.get_and_clear_pending_events();
12725 assert_eq!(events_a.len(), 1);
12726 match events_a[0] {
12727 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12728 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12730 _ => panic!("Unexpected event"),
12733 let events_b = node_b.get_and_clear_pending_events();
12734 assert_eq!(events_b.len(), 1);
12735 match events_b[0] {
12736 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12737 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12739 _ => panic!("Unexpected event"),
12742 let mut payment_count: u64 = 0;
12743 macro_rules! send_payment {
12744 ($node_a: expr, $node_b: expr) => {
12745 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
12746 .with_bolt11_features($node_b.bolt11_invoice_features()).unwrap();
12747 let mut payment_preimage = PaymentPreimage([0; 32]);
12748 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
12749 payment_count += 1;
12750 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
12751 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
12753 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
12754 PaymentId(payment_hash.0),
12755 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
12756 Retry::Attempts(0)).unwrap();
12757 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
12758 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
12759 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
12760 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
12761 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
12762 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
12763 $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()));
12765 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
12766 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
12767 $node_b.claim_funds(payment_preimage);
12768 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
12770 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
12771 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
12772 assert_eq!(node_id, $node_a.get_our_node_id());
12773 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
12774 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
12776 _ => panic!("Failed to generate claim event"),
12779 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
12780 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
12781 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
12782 $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()));
12784 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
12788 bench.bench_function(bench_name, |b| b.iter(|| {
12789 send_payment!(node_a, node_b);
12790 send_payment!(node_b, node_a);