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::{Channel, ChannelPhase, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UnfundedChannelContext, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel, WithChannelContext};
47 use crate::ln::features::{Bolt12InvoiceFeatures, ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
48 #[cfg(any(feature = "_test_utils", test))]
49 use crate::ln::features::Bolt11InvoiceFeatures;
50 use crate::routing::gossip::NetworkGraph;
51 use crate::routing::router::{BlindedTail, DefaultRouter, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
52 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
53 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, InboundOnionErr, NextPacketDetails};
55 use crate::ln::onion_utils;
56 use crate::ln::onion_utils::{HTLCFailReason, INVALID_ONION_BLINDING};
57 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
59 use crate::ln::outbound_payment;
60 use crate::ln::outbound_payment::{Bolt12PaymentError, OutboundPayments, PaymentAttempts, PendingOutboundPayment, SendAlongPathArgs, StaleExpiration};
61 use crate::ln::wire::Encode;
62 use crate::offers::invoice::{BlindedPayInfo, Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, DerivedSigningPubkey, InvoiceBuilder};
63 use crate::offers::invoice_error::InvoiceError;
64 use crate::offers::merkle::SignError;
65 use crate::offers::offer::{DerivedMetadata, Offer, OfferBuilder};
66 use crate::offers::parse::Bolt12SemanticError;
67 use crate::offers::refund::{Refund, RefundBuilder};
68 use crate::onion_message::{Destination, OffersMessage, OffersMessageHandler, PendingOnionMessage, new_pending_onion_message};
69 use crate::sign::{EntropySource, KeysManager, 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;
79 use alloc::collections::{btree_map, BTreeMap};
82 use crate::prelude::*;
84 use core::cell::RefCell;
86 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
87 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
88 use core::time::Duration;
91 // Re-export this for use in the public API.
92 pub use crate::ln::outbound_payment::{PaymentSendFailure, ProbeSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
93 use crate::ln::script::ShutdownScript;
95 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
97 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
98 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
99 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
101 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
102 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
103 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
104 // before we forward it.
106 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
107 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
108 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
109 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
110 // our payment, which we can use to decode errors or inform the user that the payment was sent.
112 /// Information about where a received HTLC('s onion) has indicated the HTLC should go.
113 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
114 pub enum PendingHTLCRouting {
115 /// An HTLC which should be forwarded on to another node.
117 /// The onion which should be included in the forwarded HTLC, telling the next hop what to
118 /// do with the HTLC.
119 onion_packet: msgs::OnionPacket,
120 /// The short channel ID of the channel which we were instructed to forward this HTLC to.
122 /// This could be a real on-chain SCID, an SCID alias, or some other SCID which has meaning
123 /// to the receiving node, such as one returned from
124 /// [`ChannelManager::get_intercept_scid`] or [`ChannelManager::get_phantom_scid`].
125 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
126 /// Set if this HTLC is being forwarded within a blinded path.
127 blinded: Option<BlindedForward>,
129 /// The onion indicates that this is a payment for an invoice (supposedly) generated by us.
131 /// Note that at this point, we have not checked that the invoice being paid was actually
132 /// generated by us, but rather it's claiming to pay an invoice of ours.
134 /// Information about the amount the sender intended to pay and (potential) proof that this
135 /// is a payment for an invoice we generated. This proof of payment is is also used for
136 /// linking MPP parts of a larger payment.
137 payment_data: msgs::FinalOnionHopData,
138 /// Additional data which we (allegedly) instructed the sender to include in the onion.
140 /// For HTLCs received by LDK, this will ultimately be exposed in
141 /// [`Event::PaymentClaimable::onion_fields`] as
142 /// [`RecipientOnionFields::payment_metadata`].
143 payment_metadata: Option<Vec<u8>>,
144 /// CLTV expiry of the received HTLC.
146 /// Used to track when we should expire pending HTLCs that go unclaimed.
147 incoming_cltv_expiry: u32,
148 /// If the onion had forwarding instructions to one of our phantom node SCIDs, this will
149 /// provide the onion shared secret used to decrypt the next level of forwarding
151 phantom_shared_secret: Option<[u8; 32]>,
152 /// Custom TLVs which were set by the sender.
154 /// For HTLCs received by LDK, this will ultimately be exposed in
155 /// [`Event::PaymentClaimable::onion_fields`] as
156 /// [`RecipientOnionFields::custom_tlvs`].
157 custom_tlvs: Vec<(u64, Vec<u8>)>,
158 /// Set if this HTLC is the final hop in a multi-hop blinded path.
159 requires_blinded_error: bool,
161 /// The onion indicates that this is for payment to us but which contains the preimage for
162 /// claiming included, and is unrelated to any invoice we'd previously generated (aka a
163 /// "keysend" or "spontaneous" payment).
165 /// Information about the amount the sender intended to pay and possibly a token to
166 /// associate MPP parts of a larger payment.
168 /// This will only be filled in if receiving MPP keysend payments is enabled, and it being
169 /// present will cause deserialization to fail on versions of LDK prior to 0.0.116.
170 payment_data: Option<msgs::FinalOnionHopData>,
171 /// Preimage for this onion payment. This preimage is provided by the sender and will be
172 /// used to settle the spontaneous payment.
173 payment_preimage: PaymentPreimage,
174 /// Additional data which we (allegedly) instructed the sender to include in the onion.
176 /// For HTLCs received by LDK, this will ultimately bubble back up as
177 /// [`RecipientOnionFields::payment_metadata`].
178 payment_metadata: Option<Vec<u8>>,
179 /// CLTV expiry of the received HTLC.
181 /// Used to track when we should expire pending HTLCs that go unclaimed.
182 incoming_cltv_expiry: u32,
183 /// Custom TLVs which were set by the sender.
185 /// For HTLCs received by LDK, these will ultimately bubble back up as
186 /// [`RecipientOnionFields::custom_tlvs`].
187 custom_tlvs: Vec<(u64, Vec<u8>)>,
191 /// Information used to forward or fail this HTLC that is being forwarded within a blinded path.
192 #[derive(Clone, Copy, Hash, PartialEq, Eq)]
193 pub struct BlindedForward {
194 /// The `blinding_point` that was set in the inbound [`msgs::UpdateAddHTLC`], or in the inbound
195 /// onion payload if we're the introduction node. Useful for calculating the next hop's
196 /// [`msgs::UpdateAddHTLC::blinding_point`].
197 pub inbound_blinding_point: PublicKey,
198 // Another field will be added here when we support forwarding as a non-intro node.
201 impl PendingHTLCRouting {
202 // Used to override the onion failure code and data if the HTLC is blinded.
203 fn blinded_failure(&self) -> Option<BlindedFailure> {
204 // TODO: needs update when we support forwarding blinded HTLCs as non-intro node
206 Self::Forward { blinded: Some(_), .. } => Some(BlindedFailure::FromIntroductionNode),
207 Self::Receive { requires_blinded_error: true, .. } => Some(BlindedFailure::FromBlindedNode),
213 /// Information about an incoming HTLC, including the [`PendingHTLCRouting`] describing where it
215 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
216 pub struct PendingHTLCInfo {
217 /// Further routing details based on whether the HTLC is being forwarded or received.
218 pub routing: PendingHTLCRouting,
219 /// The onion shared secret we build with the sender used to decrypt the onion.
221 /// This is later used to encrypt failure packets in the event that the HTLC is failed.
222 pub incoming_shared_secret: [u8; 32],
223 /// Hash of the payment preimage, to lock the payment until the receiver releases the preimage.
224 pub payment_hash: PaymentHash,
225 /// Amount received in the incoming HTLC.
227 /// This field was added in LDK 0.0.113 and will be `None` for objects written by prior
229 pub incoming_amt_msat: Option<u64>,
230 /// The amount the sender indicated should be forwarded on to the next hop or amount the sender
231 /// intended for us to receive for received payments.
233 /// If the received amount is less than this for received payments, an intermediary hop has
234 /// attempted to steal some of our funds and we should fail the HTLC (the sender should retry
235 /// it along another path).
237 /// Because nodes can take less than their required fees, and because senders may wish to
238 /// improve their own privacy, this amount may be less than [`Self::incoming_amt_msat`] for
239 /// received payments. In such cases, recipients must handle this HTLC as if it had received
240 /// [`Self::outgoing_amt_msat`].
241 pub outgoing_amt_msat: u64,
242 /// The CLTV the sender has indicated we should set on the forwarded HTLC (or has indicated
243 /// should have been set on the received HTLC for received payments).
244 pub outgoing_cltv_value: u32,
245 /// The fee taken for this HTLC in addition to the standard protocol HTLC fees.
247 /// If this is a payment for forwarding, this is the fee we are taking before forwarding the
250 /// If this is a received payment, this is the fee that our counterparty took.
252 /// This is used to allow LSPs to take fees as a part of payments, without the sender having to
254 pub skimmed_fee_msat: Option<u64>,
257 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
258 pub(super) enum HTLCFailureMsg {
259 Relay(msgs::UpdateFailHTLC),
260 Malformed(msgs::UpdateFailMalformedHTLC),
263 /// Stores whether we can't forward an HTLC or relevant forwarding info
264 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
265 pub(super) enum PendingHTLCStatus {
266 Forward(PendingHTLCInfo),
267 Fail(HTLCFailureMsg),
270 pub(super) struct PendingAddHTLCInfo {
271 pub(super) forward_info: PendingHTLCInfo,
273 // These fields are produced in `forward_htlcs()` and consumed in
274 // `process_pending_htlc_forwards()` for constructing the
275 // `HTLCSource::PreviousHopData` for failed and forwarded
278 // Note that this may be an outbound SCID alias for the associated channel.
279 prev_short_channel_id: u64,
281 prev_funding_outpoint: OutPoint,
282 prev_user_channel_id: u128,
285 pub(super) enum HTLCForwardInfo {
286 AddHTLC(PendingAddHTLCInfo),
289 err_packet: msgs::OnionErrorPacket,
294 sha256_of_onion: [u8; 32],
298 // Used for failing blinded HTLCs backwards correctly.
299 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
300 enum BlindedFailure {
301 FromIntroductionNode,
305 /// Tracks the inbound corresponding to an outbound HTLC
306 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
307 pub(crate) struct HTLCPreviousHopData {
308 // Note that this may be an outbound SCID alias for the associated channel.
309 short_channel_id: u64,
310 user_channel_id: Option<u128>,
312 incoming_packet_shared_secret: [u8; 32],
313 phantom_shared_secret: Option<[u8; 32]>,
314 blinded_failure: Option<BlindedFailure>,
316 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
317 // channel with a preimage provided by the forward channel.
322 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
324 /// This is only here for backwards-compatibility in serialization, in the future it can be
325 /// removed, breaking clients running 0.0.106 and earlier.
326 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
328 /// Contains the payer-provided preimage.
329 Spontaneous(PaymentPreimage),
332 /// HTLCs that are to us and can be failed/claimed by the user
333 struct ClaimableHTLC {
334 prev_hop: HTLCPreviousHopData,
336 /// The amount (in msats) of this MPP part
338 /// The amount (in msats) that the sender intended to be sent in this MPP
339 /// part (used for validating total MPP amount)
340 sender_intended_value: u64,
341 onion_payload: OnionPayload,
343 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
344 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
345 total_value_received: Option<u64>,
346 /// The sender intended sum total of all MPP parts specified in the onion
348 /// The extra fee our counterparty skimmed off the top of this HTLC.
349 counterparty_skimmed_fee_msat: Option<u64>,
352 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
353 fn from(val: &ClaimableHTLC) -> Self {
354 events::ClaimedHTLC {
355 channel_id: val.prev_hop.outpoint.to_channel_id(),
356 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
357 cltv_expiry: val.cltv_expiry,
358 value_msat: val.value,
359 counterparty_skimmed_fee_msat: val.counterparty_skimmed_fee_msat.unwrap_or(0),
364 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
365 /// a payment and ensure idempotency in LDK.
367 /// This is not exported to bindings users as we just use [u8; 32] directly
368 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
369 pub struct PaymentId(pub [u8; Self::LENGTH]);
372 /// Number of bytes in the id.
373 pub const LENGTH: usize = 32;
376 impl Writeable for PaymentId {
377 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
382 impl Readable for PaymentId {
383 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
384 let buf: [u8; 32] = Readable::read(r)?;
389 impl core::fmt::Display for PaymentId {
390 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
391 crate::util::logger::DebugBytes(&self.0).fmt(f)
395 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
397 /// This is not exported to bindings users as we just use [u8; 32] directly
398 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
399 pub struct InterceptId(pub [u8; 32]);
401 impl Writeable for InterceptId {
402 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
407 impl Readable for InterceptId {
408 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
409 let buf: [u8; 32] = Readable::read(r)?;
414 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
415 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
416 pub(crate) enum SentHTLCId {
417 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
418 OutboundRoute { session_priv: [u8; SECRET_KEY_SIZE] },
421 pub(crate) fn from_source(source: &HTLCSource) -> Self {
423 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
424 short_channel_id: hop_data.short_channel_id,
425 htlc_id: hop_data.htlc_id,
427 HTLCSource::OutboundRoute { session_priv, .. } =>
428 Self::OutboundRoute { session_priv: session_priv.secret_bytes() },
432 impl_writeable_tlv_based_enum!(SentHTLCId,
433 (0, PreviousHopData) => {
434 (0, short_channel_id, required),
435 (2, htlc_id, required),
437 (2, OutboundRoute) => {
438 (0, session_priv, required),
443 /// Tracks the inbound corresponding to an outbound HTLC
444 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
445 #[derive(Clone, Debug, PartialEq, Eq)]
446 pub(crate) enum HTLCSource {
447 PreviousHopData(HTLCPreviousHopData),
450 session_priv: SecretKey,
451 /// Technically we can recalculate this from the route, but we cache it here to avoid
452 /// doing a double-pass on route when we get a failure back
453 first_hop_htlc_msat: u64,
454 payment_id: PaymentId,
457 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
458 impl core::hash::Hash for HTLCSource {
459 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
461 HTLCSource::PreviousHopData(prev_hop_data) => {
463 prev_hop_data.hash(hasher);
465 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
468 session_priv[..].hash(hasher);
469 payment_id.hash(hasher);
470 first_hop_htlc_msat.hash(hasher);
476 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
478 pub fn dummy() -> Self {
479 HTLCSource::OutboundRoute {
480 path: Path { hops: Vec::new(), blinded_tail: None },
481 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
482 first_hop_htlc_msat: 0,
483 payment_id: PaymentId([2; 32]),
487 #[cfg(debug_assertions)]
488 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
489 /// transaction. Useful to ensure different datastructures match up.
490 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
491 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
492 *first_hop_htlc_msat == htlc.amount_msat
494 // There's nothing we can check for forwarded HTLCs
500 /// This enum is used to specify which error data to send to peers when failing back an HTLC
501 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
503 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
504 #[derive(Clone, Copy)]
505 pub enum FailureCode {
506 /// We had a temporary error processing the payment. Useful if no other error codes fit
507 /// and you want to indicate that the payer may want to retry.
508 TemporaryNodeFailure,
509 /// We have a required feature which was not in this onion. For example, you may require
510 /// some additional metadata that was not provided with this payment.
511 RequiredNodeFeatureMissing,
512 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
513 /// the HTLC is too close to the current block height for safe handling.
514 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
515 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
516 IncorrectOrUnknownPaymentDetails,
517 /// We failed to process the payload after the onion was decrypted. You may wish to
518 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
520 /// If available, the tuple data may include the type number and byte offset in the
521 /// decrypted byte stream where the failure occurred.
522 InvalidOnionPayload(Option<(u64, u16)>),
525 impl Into<u16> for FailureCode {
526 fn into(self) -> u16 {
528 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
529 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
530 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
531 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
536 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
537 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
538 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
539 /// peer_state lock. We then return the set of things that need to be done outside the lock in
540 /// this struct and call handle_error!() on it.
542 struct MsgHandleErrInternal {
543 err: msgs::LightningError,
544 chan_id: Option<(ChannelId, u128)>, // If Some a channel of ours has been closed
545 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
546 channel_capacity: Option<u64>,
548 impl MsgHandleErrInternal {
550 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
552 err: LightningError {
554 action: msgs::ErrorAction::SendErrorMessage {
555 msg: msgs::ErrorMessage {
562 shutdown_finish: None,
563 channel_capacity: None,
567 fn from_no_close(err: msgs::LightningError) -> Self {
568 Self { err, chan_id: None, shutdown_finish: None, channel_capacity: None }
571 fn from_finish_shutdown(err: String, channel_id: ChannelId, user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>, channel_capacity: u64) -> Self {
572 let err_msg = msgs::ErrorMessage { channel_id, data: err.clone() };
573 let action = if shutdown_res.monitor_update.is_some() {
574 // We have a closing `ChannelMonitorUpdate`, which means the channel was funded and we
575 // should disconnect our peer such that we force them to broadcast their latest
576 // commitment upon reconnecting.
577 msgs::ErrorAction::DisconnectPeer { msg: Some(err_msg) }
579 msgs::ErrorAction::SendErrorMessage { msg: err_msg }
582 err: LightningError { err, action },
583 chan_id: Some((channel_id, user_channel_id)),
584 shutdown_finish: Some((shutdown_res, channel_update)),
585 channel_capacity: Some(channel_capacity)
589 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
592 ChannelError::Warn(msg) => LightningError {
594 action: msgs::ErrorAction::SendWarningMessage {
595 msg: msgs::WarningMessage {
599 log_level: Level::Warn,
602 ChannelError::Ignore(msg) => LightningError {
604 action: msgs::ErrorAction::IgnoreError,
606 ChannelError::Close(msg) => LightningError {
608 action: msgs::ErrorAction::SendErrorMessage {
609 msg: msgs::ErrorMessage {
617 shutdown_finish: None,
618 channel_capacity: None,
622 fn closes_channel(&self) -> bool {
623 self.chan_id.is_some()
627 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
628 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
629 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
630 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
631 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
633 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
634 /// be sent in the order they appear in the return value, however sometimes the order needs to be
635 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
636 /// they were originally sent). In those cases, this enum is also returned.
637 #[derive(Clone, PartialEq)]
638 pub(super) enum RAACommitmentOrder {
639 /// Send the CommitmentUpdate messages first
641 /// Send the RevokeAndACK message first
645 /// Information about a payment which is currently being claimed.
646 struct ClaimingPayment {
648 payment_purpose: events::PaymentPurpose,
649 receiver_node_id: PublicKey,
650 htlcs: Vec<events::ClaimedHTLC>,
651 sender_intended_value: Option<u64>,
653 impl_writeable_tlv_based!(ClaimingPayment, {
654 (0, amount_msat, required),
655 (2, payment_purpose, required),
656 (4, receiver_node_id, required),
657 (5, htlcs, optional_vec),
658 (7, sender_intended_value, option),
661 struct ClaimablePayment {
662 purpose: events::PaymentPurpose,
663 onion_fields: Option<RecipientOnionFields>,
664 htlcs: Vec<ClaimableHTLC>,
667 /// Information about claimable or being-claimed payments
668 struct ClaimablePayments {
669 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
670 /// failed/claimed by the user.
672 /// Note that, no consistency guarantees are made about the channels given here actually
673 /// existing anymore by the time you go to read them!
675 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
676 /// we don't get a duplicate payment.
677 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
679 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
680 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
681 /// as an [`events::Event::PaymentClaimed`].
682 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
685 /// Events which we process internally but cannot be processed immediately at the generation site
686 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
687 /// running normally, and specifically must be processed before any other non-background
688 /// [`ChannelMonitorUpdate`]s are applied.
690 enum BackgroundEvent {
691 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
692 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
693 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
694 /// channel has been force-closed we do not need the counterparty node_id.
696 /// Note that any such events are lost on shutdown, so in general they must be updates which
697 /// are regenerated on startup.
698 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
699 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
700 /// channel to continue normal operation.
702 /// In general this should be used rather than
703 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
704 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
705 /// error the other variant is acceptable.
707 /// Note that any such events are lost on shutdown, so in general they must be updates which
708 /// are regenerated on startup.
709 MonitorUpdateRegeneratedOnStartup {
710 counterparty_node_id: PublicKey,
711 funding_txo: OutPoint,
712 update: ChannelMonitorUpdate
714 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
715 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
717 MonitorUpdatesComplete {
718 counterparty_node_id: PublicKey,
719 channel_id: ChannelId,
724 pub(crate) enum MonitorUpdateCompletionAction {
725 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
726 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
727 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
728 /// event can be generated.
729 PaymentClaimed { payment_hash: PaymentHash },
730 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
731 /// operation of another channel.
733 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
734 /// from completing a monitor update which removes the payment preimage until the inbound edge
735 /// completes a monitor update containing the payment preimage. In that case, after the inbound
736 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
738 EmitEventAndFreeOtherChannel {
739 event: events::Event,
740 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
742 /// Indicates we should immediately resume the operation of another channel, unless there is
743 /// some other reason why the channel is blocked. In practice this simply means immediately
744 /// removing the [`RAAMonitorUpdateBlockingAction`] provided from the blocking set.
746 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
747 /// from completing a monitor update which removes the payment preimage until the inbound edge
748 /// completes a monitor update containing the payment preimage. However, we use this variant
749 /// instead of [`Self::EmitEventAndFreeOtherChannel`] when we discover that the claim was in
750 /// fact duplicative and we simply want to resume the outbound edge channel immediately.
752 /// This variant should thus never be written to disk, as it is processed inline rather than
753 /// stored for later processing.
754 FreeOtherChannelImmediately {
755 downstream_counterparty_node_id: PublicKey,
756 downstream_funding_outpoint: OutPoint,
757 blocking_action: RAAMonitorUpdateBlockingAction,
761 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
762 (0, PaymentClaimed) => { (0, payment_hash, required) },
763 // Note that FreeOtherChannelImmediately should never be written - we were supposed to free
764 // *immediately*. However, for simplicity we implement read/write here.
765 (1, FreeOtherChannelImmediately) => {
766 (0, downstream_counterparty_node_id, required),
767 (2, downstream_funding_outpoint, required),
768 (4, blocking_action, required),
770 (2, EmitEventAndFreeOtherChannel) => {
771 (0, event, upgradable_required),
772 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
773 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
774 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
775 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
776 // downgrades to prior versions.
777 (1, downstream_counterparty_and_funding_outpoint, option),
781 #[derive(Clone, Debug, PartialEq, Eq)]
782 pub(crate) enum EventCompletionAction {
783 ReleaseRAAChannelMonitorUpdate {
784 counterparty_node_id: PublicKey,
785 channel_funding_outpoint: OutPoint,
788 impl_writeable_tlv_based_enum!(EventCompletionAction,
789 (0, ReleaseRAAChannelMonitorUpdate) => {
790 (0, channel_funding_outpoint, required),
791 (2, counterparty_node_id, required),
795 #[derive(Clone, PartialEq, Eq, Debug)]
796 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
797 /// the blocked action here. See enum variants for more info.
798 pub(crate) enum RAAMonitorUpdateBlockingAction {
799 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
800 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
802 ForwardedPaymentInboundClaim {
803 /// The upstream channel ID (i.e. the inbound edge).
804 channel_id: ChannelId,
805 /// The HTLC ID on the inbound edge.
810 impl RAAMonitorUpdateBlockingAction {
811 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
812 Self::ForwardedPaymentInboundClaim {
813 channel_id: prev_hop.outpoint.to_channel_id(),
814 htlc_id: prev_hop.htlc_id,
819 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
820 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
824 /// State we hold per-peer.
825 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
826 /// `channel_id` -> `ChannelPhase`
828 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
829 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
830 /// `temporary_channel_id` -> `InboundChannelRequest`.
832 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
833 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
834 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
835 /// the channel is rejected, then the entry is simply removed.
836 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
837 /// The latest `InitFeatures` we heard from the peer.
838 latest_features: InitFeatures,
839 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
840 /// for broadcast messages, where ordering isn't as strict).
841 pub(super) pending_msg_events: Vec<MessageSendEvent>,
842 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
843 /// user but which have not yet completed.
845 /// Note that the channel may no longer exist. For example if the channel was closed but we
846 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
847 /// for a missing channel.
848 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
849 /// Map from a specific channel to some action(s) that should be taken when all pending
850 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
852 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
853 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
854 /// channels with a peer this will just be one allocation and will amount to a linear list of
855 /// channels to walk, avoiding the whole hashing rigmarole.
857 /// Note that the channel may no longer exist. For example, if a channel was closed but we
858 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
859 /// for a missing channel. While a malicious peer could construct a second channel with the
860 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
861 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
862 /// duplicates do not occur, so such channels should fail without a monitor update completing.
863 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
864 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
865 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
866 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
867 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
868 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
869 /// The peer is currently connected (i.e. we've seen a
870 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
871 /// [`ChannelMessageHandler::peer_disconnected`].
875 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
876 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
877 /// If true is passed for `require_disconnected`, the function will return false if we haven't
878 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
879 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
880 if require_disconnected && self.is_connected {
883 self.channel_by_id.iter().filter(|(_, phase)| matches!(phase, ChannelPhase::Funded(_))).count() == 0
884 && self.monitor_update_blocked_actions.is_empty()
885 && self.in_flight_monitor_updates.is_empty()
888 // Returns a count of all channels we have with this peer, including unfunded channels.
889 fn total_channel_count(&self) -> usize {
890 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
893 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
894 fn has_channel(&self, channel_id: &ChannelId) -> bool {
895 self.channel_by_id.contains_key(channel_id) ||
896 self.inbound_channel_request_by_id.contains_key(channel_id)
900 /// A not-yet-accepted inbound (from counterparty) channel. Once
901 /// accepted, the parameters will be used to construct a channel.
902 pub(super) struct InboundChannelRequest {
903 /// The original OpenChannel message.
904 pub open_channel_msg: msgs::OpenChannel,
905 /// The number of ticks remaining before the request expires.
906 pub ticks_remaining: i32,
909 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
910 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
911 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
913 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
914 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
916 /// For users who don't want to bother doing their own payment preimage storage, we also store that
919 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
920 /// and instead encoding it in the payment secret.
921 struct PendingInboundPayment {
922 /// The payment secret that the sender must use for us to accept this payment
923 payment_secret: PaymentSecret,
924 /// Time at which this HTLC expires - blocks with a header time above this value will result in
925 /// this payment being removed.
927 /// Arbitrary identifier the user specifies (or not)
928 user_payment_id: u64,
929 // Other required attributes of the payment, optionally enforced:
930 payment_preimage: Option<PaymentPreimage>,
931 min_value_msat: Option<u64>,
934 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
935 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
936 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
937 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
938 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
939 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
940 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
941 /// of [`KeysManager`] and [`DefaultRouter`].
943 /// This is not exported to bindings users as type aliases aren't supported in most languages.
944 #[cfg(not(c_bindings))]
945 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
953 Arc<NetworkGraph<Arc<L>>>,
955 Arc<RwLock<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
956 ProbabilisticScoringFeeParameters,
957 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
962 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
963 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
964 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
965 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
966 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
967 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
968 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
969 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
970 /// of [`KeysManager`] and [`DefaultRouter`].
972 /// This is not exported to bindings users as type aliases aren't supported in most languages.
973 #[cfg(not(c_bindings))]
974 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
983 &'f NetworkGraph<&'g L>,
985 &'h RwLock<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
986 ProbabilisticScoringFeeParameters,
987 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
992 /// A trivial trait which describes any [`ChannelManager`].
994 /// This is not exported to bindings users as general cover traits aren't useful in other
996 pub trait AChannelManager {
997 /// A type implementing [`chain::Watch`].
998 type Watch: chain::Watch<Self::Signer> + ?Sized;
999 /// A type that may be dereferenced to [`Self::Watch`].
1000 type M: Deref<Target = Self::Watch>;
1001 /// A type implementing [`BroadcasterInterface`].
1002 type Broadcaster: BroadcasterInterface + ?Sized;
1003 /// A type that may be dereferenced to [`Self::Broadcaster`].
1004 type T: Deref<Target = Self::Broadcaster>;
1005 /// A type implementing [`EntropySource`].
1006 type EntropySource: EntropySource + ?Sized;
1007 /// A type that may be dereferenced to [`Self::EntropySource`].
1008 type ES: Deref<Target = Self::EntropySource>;
1009 /// A type implementing [`NodeSigner`].
1010 type NodeSigner: NodeSigner + ?Sized;
1011 /// A type that may be dereferenced to [`Self::NodeSigner`].
1012 type NS: Deref<Target = Self::NodeSigner>;
1013 /// A type implementing [`WriteableEcdsaChannelSigner`].
1014 type Signer: WriteableEcdsaChannelSigner + Sized;
1015 /// A type implementing [`SignerProvider`] for [`Self::Signer`].
1016 type SignerProvider: SignerProvider<EcdsaSigner= Self::Signer> + ?Sized;
1017 /// A type that may be dereferenced to [`Self::SignerProvider`].
1018 type SP: Deref<Target = Self::SignerProvider>;
1019 /// A type implementing [`FeeEstimator`].
1020 type FeeEstimator: FeeEstimator + ?Sized;
1021 /// A type that may be dereferenced to [`Self::FeeEstimator`].
1022 type F: Deref<Target = Self::FeeEstimator>;
1023 /// A type implementing [`Router`].
1024 type Router: Router + ?Sized;
1025 /// A type that may be dereferenced to [`Self::Router`].
1026 type R: Deref<Target = Self::Router>;
1027 /// A type implementing [`Logger`].
1028 type Logger: Logger + ?Sized;
1029 /// A type that may be dereferenced to [`Self::Logger`].
1030 type L: Deref<Target = Self::Logger>;
1031 /// Returns a reference to the actual [`ChannelManager`] object.
1032 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
1035 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
1036 for ChannelManager<M, T, ES, NS, SP, F, R, L>
1038 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
1039 T::Target: BroadcasterInterface,
1040 ES::Target: EntropySource,
1041 NS::Target: NodeSigner,
1042 SP::Target: SignerProvider,
1043 F::Target: FeeEstimator,
1047 type Watch = M::Target;
1049 type Broadcaster = T::Target;
1051 type EntropySource = ES::Target;
1053 type NodeSigner = NS::Target;
1055 type Signer = <SP::Target as SignerProvider>::EcdsaSigner;
1056 type SignerProvider = SP::Target;
1058 type FeeEstimator = F::Target;
1060 type Router = R::Target;
1062 type Logger = L::Target;
1064 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
1067 /// Manager which keeps track of a number of channels and sends messages to the appropriate
1068 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
1070 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
1071 /// to individual Channels.
1073 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
1074 /// all peers during write/read (though does not modify this instance, only the instance being
1075 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
1076 /// called [`funding_transaction_generated`] for outbound channels) being closed.
1078 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
1079 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST durably write each
1080 /// [`ChannelMonitorUpdate`] before returning from
1081 /// [`chain::Watch::watch_channel`]/[`update_channel`] or before completing async writes. With
1082 /// `ChannelManager`s, writing updates happens out-of-band (and will prevent any other
1083 /// `ChannelManager` operations from occurring during the serialization process). If the
1084 /// deserialized version is out-of-date compared to the [`ChannelMonitor`] passed by reference to
1085 /// [`read`], those channels will be force-closed based on the `ChannelMonitor` state and no funds
1086 /// will be lost (modulo on-chain transaction fees).
1088 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
1089 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
1090 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
1092 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
1093 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
1094 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
1095 /// offline for a full minute. In order to track this, you must call
1096 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
1098 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
1099 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
1100 /// not have a channel with being unable to connect to us or open new channels with us if we have
1101 /// many peers with unfunded channels.
1103 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
1104 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
1105 /// never limited. Please ensure you limit the count of such channels yourself.
1107 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
1108 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
1109 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
1110 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
1111 /// you're using lightning-net-tokio.
1113 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
1114 /// [`funding_created`]: msgs::FundingCreated
1115 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
1116 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
1117 /// [`update_channel`]: chain::Watch::update_channel
1118 /// [`ChannelUpdate`]: msgs::ChannelUpdate
1119 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
1120 /// [`read`]: ReadableArgs::read
1123 // The tree structure below illustrates the lock order requirements for the different locks of the
1124 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
1125 // and should then be taken in the order of the lowest to the highest level in the tree.
1126 // Note that locks on different branches shall not be taken at the same time, as doing so will
1127 // create a new lock order for those specific locks in the order they were taken.
1131 // `pending_offers_messages`
1133 // `total_consistency_lock`
1135 // |__`forward_htlcs`
1137 // | |__`pending_intercepted_htlcs`
1139 // |__`per_peer_state`
1141 // |__`pending_inbound_payments`
1143 // |__`claimable_payments`
1145 // |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
1151 // |__`short_to_chan_info`
1153 // |__`outbound_scid_aliases`
1157 // |__`pending_events`
1159 // |__`pending_background_events`
1161 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
1163 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
1164 T::Target: BroadcasterInterface,
1165 ES::Target: EntropySource,
1166 NS::Target: NodeSigner,
1167 SP::Target: SignerProvider,
1168 F::Target: FeeEstimator,
1172 default_configuration: UserConfig,
1173 chain_hash: ChainHash,
1174 fee_estimator: LowerBoundedFeeEstimator<F>,
1180 /// See `ChannelManager` struct-level documentation for lock order requirements.
1182 pub(super) best_block: RwLock<BestBlock>,
1184 best_block: RwLock<BestBlock>,
1185 secp_ctx: Secp256k1<secp256k1::All>,
1187 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1188 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1189 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1190 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1192 /// See `ChannelManager` struct-level documentation for lock order requirements.
1193 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1195 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1196 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1197 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1198 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1199 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1200 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1201 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1202 /// after reloading from disk while replaying blocks against ChannelMonitors.
1204 /// See `PendingOutboundPayment` documentation for more info.
1206 /// See `ChannelManager` struct-level documentation for lock order requirements.
1207 pending_outbound_payments: OutboundPayments,
1209 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1211 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1212 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1213 /// and via the classic SCID.
1215 /// Note that no consistency guarantees are made about the existence of a channel with the
1216 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1218 /// See `ChannelManager` struct-level documentation for lock order requirements.
1220 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1222 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1223 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1224 /// until the user tells us what we should do with them.
1226 /// See `ChannelManager` struct-level documentation for lock order requirements.
1227 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1229 /// The sets of payments which are claimable or currently being claimed. See
1230 /// [`ClaimablePayments`]' individual field docs for more info.
1232 /// See `ChannelManager` struct-level documentation for lock order requirements.
1233 claimable_payments: Mutex<ClaimablePayments>,
1235 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1236 /// and some closed channels which reached a usable state prior to being closed. This is used
1237 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1238 /// active channel list on load.
1240 /// See `ChannelManager` struct-level documentation for lock order requirements.
1241 outbound_scid_aliases: Mutex<HashSet<u64>>,
1243 /// `channel_id` -> `counterparty_node_id`.
1245 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1246 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1247 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1249 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1250 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1251 /// the handling of the events.
1253 /// Note that no consistency guarantees are made about the existence of a peer with the
1254 /// `counterparty_node_id` in our other maps.
1257 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1258 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1259 /// would break backwards compatability.
1260 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1261 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1262 /// required to access the channel with the `counterparty_node_id`.
1264 /// See `ChannelManager` struct-level documentation for lock order requirements.
1265 id_to_peer: Mutex<HashMap<ChannelId, PublicKey>>,
1267 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1269 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1270 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1271 /// confirmation depth.
1273 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1274 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1275 /// channel with the `channel_id` in our other maps.
1277 /// See `ChannelManager` struct-level documentation for lock order requirements.
1279 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1281 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1283 our_network_pubkey: PublicKey,
1285 inbound_payment_key: inbound_payment::ExpandedKey,
1287 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1288 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1289 /// we encrypt the namespace identifier using these bytes.
1291 /// [fake scids]: crate::util::scid_utils::fake_scid
1292 fake_scid_rand_bytes: [u8; 32],
1294 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1295 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1296 /// keeping additional state.
1297 probing_cookie_secret: [u8; 32],
1299 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1300 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1301 /// very far in the past, and can only ever be up to two hours in the future.
1302 highest_seen_timestamp: AtomicUsize,
1304 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1305 /// basis, as well as the peer's latest features.
1307 /// If we are connected to a peer we always at least have an entry here, even if no channels
1308 /// are currently open with that peer.
1310 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1311 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1314 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1316 /// See `ChannelManager` struct-level documentation for lock order requirements.
1317 #[cfg(not(any(test, feature = "_test_utils")))]
1318 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1319 #[cfg(any(test, feature = "_test_utils"))]
1320 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1322 /// The set of events which we need to give to the user to handle. In some cases an event may
1323 /// require some further action after the user handles it (currently only blocking a monitor
1324 /// update from being handed to the user to ensure the included changes to the channel state
1325 /// are handled by the user before they're persisted durably to disk). In that case, the second
1326 /// element in the tuple is set to `Some` with further details of the action.
1328 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1329 /// could be in the middle of being processed without the direct mutex held.
1331 /// See `ChannelManager` struct-level documentation for lock order requirements.
1332 #[cfg(not(any(test, feature = "_test_utils")))]
1333 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1334 #[cfg(any(test, feature = "_test_utils"))]
1335 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1337 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1338 pending_events_processor: AtomicBool,
1340 /// If we are running during init (either directly during the deserialization method or in
1341 /// block connection methods which run after deserialization but before normal operation) we
1342 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1343 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1344 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1346 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1348 /// See `ChannelManager` struct-level documentation for lock order requirements.
1350 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1351 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1352 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1353 /// Essentially just when we're serializing ourselves out.
1354 /// Taken first everywhere where we are making changes before any other locks.
1355 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1356 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1357 /// Notifier the lock contains sends out a notification when the lock is released.
1358 total_consistency_lock: RwLock<()>,
1359 /// Tracks the progress of channels going through batch funding by whether funding_signed was
1360 /// received and the monitor has been persisted.
1362 /// This information does not need to be persisted as funding nodes can forget
1363 /// unfunded channels upon disconnection.
1364 funding_batch_states: Mutex<BTreeMap<Txid, Vec<(ChannelId, PublicKey, bool)>>>,
1366 background_events_processed_since_startup: AtomicBool,
1368 event_persist_notifier: Notifier,
1369 needs_persist_flag: AtomicBool,
1371 pending_offers_messages: Mutex<Vec<PendingOnionMessage<OffersMessage>>>,
1375 signer_provider: SP,
1380 /// Chain-related parameters used to construct a new `ChannelManager`.
1382 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1383 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1384 /// are not needed when deserializing a previously constructed `ChannelManager`.
1385 #[derive(Clone, Copy, PartialEq)]
1386 pub struct ChainParameters {
1387 /// The network for determining the `chain_hash` in Lightning messages.
1388 pub network: Network,
1390 /// The hash and height of the latest block successfully connected.
1392 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1393 pub best_block: BestBlock,
1396 #[derive(Copy, Clone, PartialEq)]
1400 SkipPersistHandleEvents,
1401 SkipPersistNoEvents,
1404 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1405 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1406 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1407 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1408 /// sending the aforementioned notification (since the lock being released indicates that the
1409 /// updates are ready for persistence).
1411 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1412 /// notify or not based on whether relevant changes have been made, providing a closure to
1413 /// `optionally_notify` which returns a `NotifyOption`.
1414 struct PersistenceNotifierGuard<'a, F: FnMut() -> NotifyOption> {
1415 event_persist_notifier: &'a Notifier,
1416 needs_persist_flag: &'a AtomicBool,
1418 // We hold onto this result so the lock doesn't get released immediately.
1419 _read_guard: RwLockReadGuard<'a, ()>,
1422 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1423 /// Notifies any waiters and indicates that we need to persist, in addition to possibly having
1424 /// events to handle.
1426 /// This must always be called if the changes included a `ChannelMonitorUpdate`, as well as in
1427 /// other cases where losing the changes on restart may result in a force-close or otherwise
1429 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1430 Self::optionally_notify(cm, || -> NotifyOption { NotifyOption::DoPersist })
1433 fn optionally_notify<F: FnMut() -> NotifyOption, C: AChannelManager>(cm: &'a C, mut persist_check: F)
1434 -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1435 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1436 let force_notify = cm.get_cm().process_background_events();
1438 PersistenceNotifierGuard {
1439 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1440 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1441 should_persist: move || {
1442 // Pick the "most" action between `persist_check` and the background events
1443 // processing and return that.
1444 let notify = persist_check();
1445 match (notify, force_notify) {
1446 (NotifyOption::DoPersist, _) => NotifyOption::DoPersist,
1447 (_, NotifyOption::DoPersist) => NotifyOption::DoPersist,
1448 (NotifyOption::SkipPersistHandleEvents, _) => NotifyOption::SkipPersistHandleEvents,
1449 (_, NotifyOption::SkipPersistHandleEvents) => NotifyOption::SkipPersistHandleEvents,
1450 _ => NotifyOption::SkipPersistNoEvents,
1453 _read_guard: read_guard,
1457 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1458 /// [`ChannelManager::process_background_events`] MUST be called first (or
1459 /// [`Self::optionally_notify`] used).
1460 fn optionally_notify_skipping_background_events<F: Fn() -> NotifyOption, C: AChannelManager>
1461 (cm: &'a C, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1462 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1464 PersistenceNotifierGuard {
1465 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1466 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1467 should_persist: persist_check,
1468 _read_guard: read_guard,
1473 impl<'a, F: FnMut() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1474 fn drop(&mut self) {
1475 match (self.should_persist)() {
1476 NotifyOption::DoPersist => {
1477 self.needs_persist_flag.store(true, Ordering::Release);
1478 self.event_persist_notifier.notify()
1480 NotifyOption::SkipPersistHandleEvents =>
1481 self.event_persist_notifier.notify(),
1482 NotifyOption::SkipPersistNoEvents => {},
1487 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1488 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1490 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1492 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1493 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1494 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1495 /// the maximum required amount in lnd as of March 2021.
1496 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1498 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1499 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1501 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1503 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1504 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1505 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1506 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1507 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1508 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1509 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1510 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1511 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1512 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1513 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1514 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1515 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1517 /// Minimum CLTV difference between the current block height and received inbound payments.
1518 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1520 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1521 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1522 // a payment was being routed, so we add an extra block to be safe.
1523 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1525 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1526 // ie that if the next-hop peer fails the HTLC within
1527 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1528 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1529 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1530 // LATENCY_GRACE_PERIOD_BLOCKS.
1533 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;
1535 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1536 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1539 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1541 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1542 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1544 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1545 /// until we mark the channel disabled and gossip the update.
1546 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1548 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1549 /// we mark the channel enabled and gossip the update.
1550 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1552 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1553 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1554 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1555 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1557 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1558 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1559 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1561 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1562 /// many peers we reject new (inbound) connections.
1563 const MAX_NO_CHANNEL_PEERS: usize = 250;
1565 /// Information needed for constructing an invoice route hint for this channel.
1566 #[derive(Clone, Debug, PartialEq)]
1567 pub struct CounterpartyForwardingInfo {
1568 /// Base routing fee in millisatoshis.
1569 pub fee_base_msat: u32,
1570 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1571 pub fee_proportional_millionths: u32,
1572 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1573 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1574 /// `cltv_expiry_delta` for more details.
1575 pub cltv_expiry_delta: u16,
1578 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1579 /// to better separate parameters.
1580 #[derive(Clone, Debug, PartialEq)]
1581 pub struct ChannelCounterparty {
1582 /// The node_id of our counterparty
1583 pub node_id: PublicKey,
1584 /// The Features the channel counterparty provided upon last connection.
1585 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1586 /// many routing-relevant features are present in the init context.
1587 pub features: InitFeatures,
1588 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1589 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1590 /// claiming at least this value on chain.
1592 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1594 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1595 pub unspendable_punishment_reserve: u64,
1596 /// Information on the fees and requirements that the counterparty requires when forwarding
1597 /// payments to us through this channel.
1598 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1599 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1600 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1601 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1602 pub outbound_htlc_minimum_msat: Option<u64>,
1603 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1604 pub outbound_htlc_maximum_msat: Option<u64>,
1607 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1608 #[derive(Clone, Debug, PartialEq)]
1609 pub struct ChannelDetails {
1610 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1611 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1612 /// Note that this means this value is *not* persistent - it can change once during the
1613 /// lifetime of the channel.
1614 pub channel_id: ChannelId,
1615 /// Parameters which apply to our counterparty. See individual fields for more information.
1616 pub counterparty: ChannelCounterparty,
1617 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1618 /// our counterparty already.
1620 /// Note that, if this has been set, `channel_id` will be equivalent to
1621 /// `funding_txo.unwrap().to_channel_id()`.
1622 pub funding_txo: Option<OutPoint>,
1623 /// The features which this channel operates with. See individual features for more info.
1625 /// `None` until negotiation completes and the channel type is finalized.
1626 pub channel_type: Option<ChannelTypeFeatures>,
1627 /// The position of the funding transaction in the chain. None if the funding transaction has
1628 /// not yet been confirmed and the channel fully opened.
1630 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1631 /// payments instead of this. See [`get_inbound_payment_scid`].
1633 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1634 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1636 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1637 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1638 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1639 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1640 /// [`confirmations_required`]: Self::confirmations_required
1641 pub short_channel_id: Option<u64>,
1642 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1643 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1644 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1647 /// This will be `None` as long as the channel is not available for routing outbound payments.
1649 /// [`short_channel_id`]: Self::short_channel_id
1650 /// [`confirmations_required`]: Self::confirmations_required
1651 pub outbound_scid_alias: Option<u64>,
1652 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1653 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1654 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1655 /// when they see a payment to be routed to us.
1657 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1658 /// previous values for inbound payment forwarding.
1660 /// [`short_channel_id`]: Self::short_channel_id
1661 pub inbound_scid_alias: Option<u64>,
1662 /// The value, in satoshis, of this channel as appears in the funding output
1663 pub channel_value_satoshis: u64,
1664 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1665 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1666 /// this value on chain.
1668 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1670 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1672 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1673 pub unspendable_punishment_reserve: Option<u64>,
1674 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1675 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1676 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1677 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1678 /// serialized with LDK versions prior to 0.0.113.
1680 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1681 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1682 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1683 pub user_channel_id: u128,
1684 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1685 /// which is applied to commitment and HTLC transactions.
1687 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1688 pub feerate_sat_per_1000_weight: Option<u32>,
1689 /// Our total balance. This is the amount we would get if we close the channel.
1690 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1691 /// amount is not likely to be recoverable on close.
1693 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1694 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1695 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1696 /// This does not consider any on-chain fees.
1698 /// See also [`ChannelDetails::outbound_capacity_msat`]
1699 pub balance_msat: u64,
1700 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1701 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1702 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1703 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1705 /// See also [`ChannelDetails::balance_msat`]
1707 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1708 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1709 /// should be able to spend nearly this amount.
1710 pub outbound_capacity_msat: u64,
1711 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1712 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1713 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1714 /// to use a limit as close as possible to the HTLC limit we can currently send.
1716 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1717 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1718 pub next_outbound_htlc_limit_msat: u64,
1719 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1720 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1721 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1722 /// route which is valid.
1723 pub next_outbound_htlc_minimum_msat: u64,
1724 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1725 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1726 /// available for inclusion in new inbound HTLCs).
1727 /// Note that there are some corner cases not fully handled here, so the actual available
1728 /// inbound capacity may be slightly higher than this.
1730 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1731 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1732 /// However, our counterparty should be able to spend nearly this amount.
1733 pub inbound_capacity_msat: u64,
1734 /// The number of required confirmations on the funding transaction before the funding will be
1735 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1736 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1737 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1738 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1740 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1742 /// [`is_outbound`]: ChannelDetails::is_outbound
1743 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1744 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1745 pub confirmations_required: Option<u32>,
1746 /// The current number of confirmations on the funding transaction.
1748 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1749 pub confirmations: Option<u32>,
1750 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1751 /// until we can claim our funds after we force-close the channel. During this time our
1752 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1753 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1754 /// time to claim our non-HTLC-encumbered funds.
1756 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1757 pub force_close_spend_delay: Option<u16>,
1758 /// True if the channel was initiated (and thus funded) by us.
1759 pub is_outbound: bool,
1760 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1761 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1762 /// required confirmation count has been reached (and we were connected to the peer at some
1763 /// point after the funding transaction received enough confirmations). The required
1764 /// confirmation count is provided in [`confirmations_required`].
1766 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1767 pub is_channel_ready: bool,
1768 /// The stage of the channel's shutdown.
1769 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1770 pub channel_shutdown_state: Option<ChannelShutdownState>,
1771 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1772 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1774 /// This is a strict superset of `is_channel_ready`.
1775 pub is_usable: bool,
1776 /// True if this channel is (or will be) publicly-announced.
1777 pub is_public: bool,
1778 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1779 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1780 pub inbound_htlc_minimum_msat: Option<u64>,
1781 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1782 pub inbound_htlc_maximum_msat: Option<u64>,
1783 /// Set of configurable parameters that affect channel operation.
1785 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1786 pub config: Option<ChannelConfig>,
1789 impl ChannelDetails {
1790 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1791 /// This should be used for providing invoice hints or in any other context where our
1792 /// counterparty will forward a payment to us.
1794 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1795 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1796 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1797 self.inbound_scid_alias.or(self.short_channel_id)
1800 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1801 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1802 /// we're sending or forwarding a payment outbound over this channel.
1804 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1805 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1806 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1807 self.short_channel_id.or(self.outbound_scid_alias)
1810 fn from_channel_context<SP: Deref, F: Deref>(
1811 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1812 fee_estimator: &LowerBoundedFeeEstimator<F>
1815 SP::Target: SignerProvider,
1816 F::Target: FeeEstimator
1818 let balance = context.get_available_balances(fee_estimator);
1819 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1820 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1822 channel_id: context.channel_id(),
1823 counterparty: ChannelCounterparty {
1824 node_id: context.get_counterparty_node_id(),
1825 features: latest_features,
1826 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1827 forwarding_info: context.counterparty_forwarding_info(),
1828 // Ensures that we have actually received the `htlc_minimum_msat` value
1829 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1830 // message (as they are always the first message from the counterparty).
1831 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1832 // default `0` value set by `Channel::new_outbound`.
1833 outbound_htlc_minimum_msat: if context.have_received_message() {
1834 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1835 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1837 funding_txo: context.get_funding_txo(),
1838 // Note that accept_channel (or open_channel) is always the first message, so
1839 // `have_received_message` indicates that type negotiation has completed.
1840 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1841 short_channel_id: context.get_short_channel_id(),
1842 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1843 inbound_scid_alias: context.latest_inbound_scid_alias(),
1844 channel_value_satoshis: context.get_value_satoshis(),
1845 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1846 unspendable_punishment_reserve: to_self_reserve_satoshis,
1847 balance_msat: balance.balance_msat,
1848 inbound_capacity_msat: balance.inbound_capacity_msat,
1849 outbound_capacity_msat: balance.outbound_capacity_msat,
1850 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1851 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1852 user_channel_id: context.get_user_id(),
1853 confirmations_required: context.minimum_depth(),
1854 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1855 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1856 is_outbound: context.is_outbound(),
1857 is_channel_ready: context.is_usable(),
1858 is_usable: context.is_live(),
1859 is_public: context.should_announce(),
1860 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1861 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1862 config: Some(context.config()),
1863 channel_shutdown_state: Some(context.shutdown_state()),
1868 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1869 /// Further information on the details of the channel shutdown.
1870 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1871 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1872 /// the channel will be removed shortly.
1873 /// Also note, that in normal operation, peers could disconnect at any of these states
1874 /// and require peer re-connection before making progress onto other states
1875 pub enum ChannelShutdownState {
1876 /// Channel has not sent or received a shutdown message.
1878 /// Local node has sent a shutdown message for this channel.
1880 /// Shutdown message exchanges have concluded and the channels are in the midst of
1881 /// resolving all existing open HTLCs before closing can continue.
1883 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1884 NegotiatingClosingFee,
1885 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1886 /// to drop the channel.
1890 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1891 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1892 #[derive(Debug, PartialEq)]
1893 pub enum RecentPaymentDetails {
1894 /// When an invoice was requested and thus a payment has not yet been sent.
1896 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1897 /// a payment and ensure idempotency in LDK.
1898 payment_id: PaymentId,
1900 /// When a payment is still being sent and awaiting successful delivery.
1902 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1903 /// a payment and ensure idempotency in LDK.
1904 payment_id: PaymentId,
1905 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1907 payment_hash: PaymentHash,
1908 /// Total amount (in msat, excluding fees) across all paths for this payment,
1909 /// not just the amount currently inflight.
1912 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1913 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1914 /// payment is removed from tracking.
1916 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1917 /// a payment and ensure idempotency in LDK.
1918 payment_id: PaymentId,
1919 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1920 /// made before LDK version 0.0.104.
1921 payment_hash: Option<PaymentHash>,
1923 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1924 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1925 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1927 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1928 /// a payment and ensure idempotency in LDK.
1929 payment_id: PaymentId,
1930 /// Hash of the payment that we have given up trying to send.
1931 payment_hash: PaymentHash,
1935 /// Route hints used in constructing invoices for [phantom node payents].
1937 /// [phantom node payments]: crate::sign::PhantomKeysManager
1939 pub struct PhantomRouteHints {
1940 /// The list of channels to be included in the invoice route hints.
1941 pub channels: Vec<ChannelDetails>,
1942 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1944 pub phantom_scid: u64,
1945 /// The pubkey of the real backing node that would ultimately receive the payment.
1946 pub real_node_pubkey: PublicKey,
1949 macro_rules! handle_error {
1950 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1951 // In testing, ensure there are no deadlocks where the lock is already held upon
1952 // entering the macro.
1953 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1954 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1958 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish, channel_capacity }) => {
1959 let mut msg_events = Vec::with_capacity(2);
1961 if let Some((shutdown_res, update_option)) = shutdown_finish {
1962 $self.finish_close_channel(shutdown_res);
1963 if let Some(update) = update_option {
1964 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1968 if let Some((channel_id, user_channel_id)) = chan_id {
1969 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1970 channel_id, user_channel_id,
1971 reason: ClosureReason::ProcessingError { err: err.err.clone() },
1972 counterparty_node_id: Some($counterparty_node_id),
1973 channel_capacity_sats: channel_capacity,
1978 let logger = WithContext::from(
1979 &$self.logger, Some($counterparty_node_id), chan_id.map(|(chan_id, _)| chan_id)
1981 log_error!(logger, "{}", err.err);
1982 if let msgs::ErrorAction::IgnoreError = err.action {
1984 msg_events.push(events::MessageSendEvent::HandleError {
1985 node_id: $counterparty_node_id,
1986 action: err.action.clone()
1990 if !msg_events.is_empty() {
1991 let per_peer_state = $self.per_peer_state.read().unwrap();
1992 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1993 let mut peer_state = peer_state_mutex.lock().unwrap();
1994 peer_state.pending_msg_events.append(&mut msg_events);
1998 // Return error in case higher-API need one
2005 macro_rules! update_maps_on_chan_removal {
2006 ($self: expr, $channel_context: expr) => {{
2007 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
2008 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2009 if let Some(short_id) = $channel_context.get_short_channel_id() {
2010 short_to_chan_info.remove(&short_id);
2012 // If the channel was never confirmed on-chain prior to its closure, remove the
2013 // outbound SCID alias we used for it from the collision-prevention set. While we
2014 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
2015 // also don't want a counterparty to be able to trivially cause a memory leak by simply
2016 // opening a million channels with us which are closed before we ever reach the funding
2018 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
2019 debug_assert!(alias_removed);
2021 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
2025 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
2026 macro_rules! convert_chan_phase_err {
2027 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
2029 ChannelError::Warn(msg) => {
2030 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
2032 ChannelError::Ignore(msg) => {
2033 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
2035 ChannelError::Close(msg) => {
2036 let logger = WithChannelContext::from(&$self.logger, &$channel.context);
2037 log_error!(logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
2038 update_maps_on_chan_removal!($self, $channel.context);
2039 let shutdown_res = $channel.context.force_shutdown(true);
2040 let user_id = $channel.context.get_user_id();
2041 let channel_capacity_satoshis = $channel.context.get_value_satoshis();
2043 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, user_id,
2044 shutdown_res, $channel_update, channel_capacity_satoshis))
2048 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
2049 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
2051 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
2052 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
2054 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
2055 match $channel_phase {
2056 ChannelPhase::Funded(channel) => {
2057 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
2059 ChannelPhase::UnfundedOutboundV1(channel) => {
2060 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2062 ChannelPhase::UnfundedInboundV1(channel) => {
2063 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2069 macro_rules! break_chan_phase_entry {
2070 ($self: ident, $res: expr, $entry: expr) => {
2074 let key = *$entry.key();
2075 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2077 $entry.remove_entry();
2085 macro_rules! try_chan_phase_entry {
2086 ($self: ident, $res: expr, $entry: expr) => {
2090 let key = *$entry.key();
2091 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2093 $entry.remove_entry();
2101 macro_rules! remove_channel_phase {
2102 ($self: expr, $entry: expr) => {
2104 let channel = $entry.remove_entry().1;
2105 update_maps_on_chan_removal!($self, &channel.context());
2111 macro_rules! send_channel_ready {
2112 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
2113 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
2114 node_id: $channel.context.get_counterparty_node_id(),
2115 msg: $channel_ready_msg,
2117 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
2118 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
2119 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2120 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2121 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2122 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2123 if let Some(real_scid) = $channel.context.get_short_channel_id() {
2124 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2125 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2126 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2131 macro_rules! emit_channel_pending_event {
2132 ($locked_events: expr, $channel: expr) => {
2133 if $channel.context.should_emit_channel_pending_event() {
2134 $locked_events.push_back((events::Event::ChannelPending {
2135 channel_id: $channel.context.channel_id(),
2136 former_temporary_channel_id: $channel.context.temporary_channel_id(),
2137 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2138 user_channel_id: $channel.context.get_user_id(),
2139 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
2141 $channel.context.set_channel_pending_event_emitted();
2146 macro_rules! emit_channel_ready_event {
2147 ($locked_events: expr, $channel: expr) => {
2148 if $channel.context.should_emit_channel_ready_event() {
2149 debug_assert!($channel.context.channel_pending_event_emitted());
2150 $locked_events.push_back((events::Event::ChannelReady {
2151 channel_id: $channel.context.channel_id(),
2152 user_channel_id: $channel.context.get_user_id(),
2153 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2154 channel_type: $channel.context.get_channel_type().clone(),
2156 $channel.context.set_channel_ready_event_emitted();
2161 macro_rules! handle_monitor_update_completion {
2162 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2163 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2164 let mut updates = $chan.monitor_updating_restored(&&logger,
2165 &$self.node_signer, $self.chain_hash, &$self.default_configuration,
2166 $self.best_block.read().unwrap().height());
2167 let counterparty_node_id = $chan.context.get_counterparty_node_id();
2168 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
2169 // We only send a channel_update in the case where we are just now sending a
2170 // channel_ready and the channel is in a usable state. We may re-send a
2171 // channel_update later through the announcement_signatures process for public
2172 // channels, but there's no reason not to just inform our counterparty of our fees
2174 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
2175 Some(events::MessageSendEvent::SendChannelUpdate {
2176 node_id: counterparty_node_id,
2182 let update_actions = $peer_state.monitor_update_blocked_actions
2183 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
2185 let htlc_forwards = $self.handle_channel_resumption(
2186 &mut $peer_state.pending_msg_events, $chan, updates.raa,
2187 updates.commitment_update, updates.order, updates.accepted_htlcs,
2188 updates.funding_broadcastable, updates.channel_ready,
2189 updates.announcement_sigs);
2190 if let Some(upd) = channel_update {
2191 $peer_state.pending_msg_events.push(upd);
2194 let channel_id = $chan.context.channel_id();
2195 let unbroadcasted_batch_funding_txid = $chan.context.unbroadcasted_batch_funding_txid();
2196 core::mem::drop($peer_state_lock);
2197 core::mem::drop($per_peer_state_lock);
2199 // If the channel belongs to a batch funding transaction, the progress of the batch
2200 // should be updated as we have received funding_signed and persisted the monitor.
2201 if let Some(txid) = unbroadcasted_batch_funding_txid {
2202 let mut funding_batch_states = $self.funding_batch_states.lock().unwrap();
2203 let mut batch_completed = false;
2204 if let Some(batch_state) = funding_batch_states.get_mut(&txid) {
2205 let channel_state = batch_state.iter_mut().find(|(chan_id, pubkey, _)| (
2206 *chan_id == channel_id &&
2207 *pubkey == counterparty_node_id
2209 if let Some(channel_state) = channel_state {
2210 channel_state.2 = true;
2212 debug_assert!(false, "Missing channel batch state for channel which completed initial monitor update");
2214 batch_completed = batch_state.iter().all(|(_, _, completed)| *completed);
2216 debug_assert!(false, "Missing batch state for channel which completed initial monitor update");
2219 // When all channels in a batched funding transaction have become ready, it is not necessary
2220 // to track the progress of the batch anymore and the state of the channels can be updated.
2221 if batch_completed {
2222 let removed_batch_state = funding_batch_states.remove(&txid).into_iter().flatten();
2223 let per_peer_state = $self.per_peer_state.read().unwrap();
2224 let mut batch_funding_tx = None;
2225 for (channel_id, counterparty_node_id, _) in removed_batch_state {
2226 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2227 let mut peer_state = peer_state_mutex.lock().unwrap();
2228 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
2229 batch_funding_tx = batch_funding_tx.or_else(|| chan.context.unbroadcasted_funding());
2230 chan.set_batch_ready();
2231 let mut pending_events = $self.pending_events.lock().unwrap();
2232 emit_channel_pending_event!(pending_events, chan);
2236 if let Some(tx) = batch_funding_tx {
2237 log_info!($self.logger, "Broadcasting batch funding transaction with txid {}", tx.txid());
2238 $self.tx_broadcaster.broadcast_transactions(&[&tx]);
2243 $self.handle_monitor_update_completion_actions(update_actions);
2245 if let Some(forwards) = htlc_forwards {
2246 $self.forward_htlcs(&mut [forwards][..]);
2248 $self.finalize_claims(updates.finalized_claimed_htlcs);
2249 for failure in updates.failed_htlcs.drain(..) {
2250 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2251 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2256 macro_rules! handle_new_monitor_update {
2257 ($self: ident, $update_res: expr, $chan: expr, _internal, $completed: expr) => { {
2258 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2259 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2261 ChannelMonitorUpdateStatus::UnrecoverableError => {
2262 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
2263 log_error!(logger, "{}", err_str);
2264 panic!("{}", err_str);
2266 ChannelMonitorUpdateStatus::InProgress => {
2267 log_debug!(logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2268 &$chan.context.channel_id());
2271 ChannelMonitorUpdateStatus::Completed => {
2277 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, INITIAL_MONITOR) => {
2278 handle_new_monitor_update!($self, $update_res, $chan, _internal,
2279 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2281 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2282 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2283 .or_insert_with(Vec::new);
2284 // During startup, we push monitor updates as background events through to here in
2285 // order to replay updates that were in-flight when we shut down. Thus, we have to
2286 // filter for uniqueness here.
2287 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2288 .unwrap_or_else(|| {
2289 in_flight_updates.push($update);
2290 in_flight_updates.len() - 1
2292 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2293 handle_new_monitor_update!($self, update_res, $chan, _internal,
2295 let _ = in_flight_updates.remove(idx);
2296 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2297 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2303 macro_rules! process_events_body {
2304 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2305 let mut processed_all_events = false;
2306 while !processed_all_events {
2307 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2314 // We'll acquire our total consistency lock so that we can be sure no other
2315 // persists happen while processing monitor events.
2316 let _read_guard = $self.total_consistency_lock.read().unwrap();
2318 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2319 // ensure any startup-generated background events are handled first.
2320 result = $self.process_background_events();
2322 // TODO: This behavior should be documented. It's unintuitive that we query
2323 // ChannelMonitors when clearing other events.
2324 if $self.process_pending_monitor_events() {
2325 result = NotifyOption::DoPersist;
2329 let pending_events = $self.pending_events.lock().unwrap().clone();
2330 let num_events = pending_events.len();
2331 if !pending_events.is_empty() {
2332 result = NotifyOption::DoPersist;
2335 let mut post_event_actions = Vec::new();
2337 for (event, action_opt) in pending_events {
2338 $event_to_handle = event;
2340 if let Some(action) = action_opt {
2341 post_event_actions.push(action);
2346 let mut pending_events = $self.pending_events.lock().unwrap();
2347 pending_events.drain(..num_events);
2348 processed_all_events = pending_events.is_empty();
2349 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2350 // updated here with the `pending_events` lock acquired.
2351 $self.pending_events_processor.store(false, Ordering::Release);
2354 if !post_event_actions.is_empty() {
2355 $self.handle_post_event_actions(post_event_actions);
2356 // If we had some actions, go around again as we may have more events now
2357 processed_all_events = false;
2361 NotifyOption::DoPersist => {
2362 $self.needs_persist_flag.store(true, Ordering::Release);
2363 $self.event_persist_notifier.notify();
2365 NotifyOption::SkipPersistHandleEvents =>
2366 $self.event_persist_notifier.notify(),
2367 NotifyOption::SkipPersistNoEvents => {},
2373 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>
2375 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
2376 T::Target: BroadcasterInterface,
2377 ES::Target: EntropySource,
2378 NS::Target: NodeSigner,
2379 SP::Target: SignerProvider,
2380 F::Target: FeeEstimator,
2384 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2386 /// The current time or latest block header time can be provided as the `current_timestamp`.
2388 /// This is the main "logic hub" for all channel-related actions, and implements
2389 /// [`ChannelMessageHandler`].
2391 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2393 /// Users need to notify the new `ChannelManager` when a new block is connected or
2394 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2395 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2398 /// [`block_connected`]: chain::Listen::block_connected
2399 /// [`block_disconnected`]: chain::Listen::block_disconnected
2400 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2402 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2403 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2404 current_timestamp: u32,
2406 let mut secp_ctx = Secp256k1::new();
2407 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2408 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2409 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2411 default_configuration: config.clone(),
2412 chain_hash: ChainHash::using_genesis_block(params.network),
2413 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2418 best_block: RwLock::new(params.best_block),
2420 outbound_scid_aliases: Mutex::new(HashSet::new()),
2421 pending_inbound_payments: Mutex::new(HashMap::new()),
2422 pending_outbound_payments: OutboundPayments::new(),
2423 forward_htlcs: Mutex::new(HashMap::new()),
2424 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2425 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2426 id_to_peer: Mutex::new(HashMap::new()),
2427 short_to_chan_info: FairRwLock::new(HashMap::new()),
2429 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2432 inbound_payment_key: expanded_inbound_key,
2433 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2435 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2437 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2439 per_peer_state: FairRwLock::new(HashMap::new()),
2441 pending_events: Mutex::new(VecDeque::new()),
2442 pending_events_processor: AtomicBool::new(false),
2443 pending_background_events: Mutex::new(Vec::new()),
2444 total_consistency_lock: RwLock::new(()),
2445 background_events_processed_since_startup: AtomicBool::new(false),
2446 event_persist_notifier: Notifier::new(),
2447 needs_persist_flag: AtomicBool::new(false),
2448 funding_batch_states: Mutex::new(BTreeMap::new()),
2450 pending_offers_messages: Mutex::new(Vec::new()),
2460 /// Gets the current configuration applied to all new channels.
2461 pub fn get_current_default_configuration(&self) -> &UserConfig {
2462 &self.default_configuration
2465 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2466 let height = self.best_block.read().unwrap().height();
2467 let mut outbound_scid_alias = 0;
2470 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2471 outbound_scid_alias += 1;
2473 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2475 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2479 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"); }
2484 /// Creates a new outbound channel to the given remote node and with the given value.
2486 /// `user_channel_id` will be provided back as in
2487 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2488 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2489 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2490 /// is simply copied to events and otherwise ignored.
2492 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2493 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2495 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2496 /// generate a shutdown scriptpubkey or destination script set by
2497 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2499 /// Note that we do not check if you are currently connected to the given peer. If no
2500 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2501 /// the channel eventually being silently forgotten (dropped on reload).
2503 /// If `temporary_channel_id` is specified, it will be used as the temporary channel ID of the
2504 /// channel. Otherwise, a random one will be generated for you.
2506 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2507 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2508 /// [`ChannelDetails::channel_id`] until after
2509 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2510 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2511 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2513 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2514 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2515 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2516 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> {
2517 if channel_value_satoshis < 1000 {
2518 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2521 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2522 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2523 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2525 let per_peer_state = self.per_peer_state.read().unwrap();
2527 let peer_state_mutex = per_peer_state.get(&their_network_key)
2528 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2530 let mut peer_state = peer_state_mutex.lock().unwrap();
2532 if let Some(temporary_channel_id) = temporary_channel_id {
2533 if peer_state.channel_by_id.contains_key(&temporary_channel_id) {
2534 return Err(APIError::APIMisuseError{ err: format!("Channel with temporary channel ID {} already exists!", temporary_channel_id)});
2539 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2540 let their_features = &peer_state.latest_features;
2541 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2542 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2543 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2544 self.best_block.read().unwrap().height(), outbound_scid_alias, temporary_channel_id)
2548 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2553 let res = channel.get_open_channel(self.chain_hash);
2555 let temporary_channel_id = channel.context.channel_id();
2556 match peer_state.channel_by_id.entry(temporary_channel_id) {
2557 hash_map::Entry::Occupied(_) => {
2559 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2561 panic!("RNG is bad???");
2564 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2567 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2568 node_id: their_network_key,
2571 Ok(temporary_channel_id)
2574 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2575 // Allocate our best estimate of the number of channels we have in the `res`
2576 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2577 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2578 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2579 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2580 // the same channel.
2581 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2583 let best_block_height = self.best_block.read().unwrap().height();
2584 let per_peer_state = self.per_peer_state.read().unwrap();
2585 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2586 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2587 let peer_state = &mut *peer_state_lock;
2588 res.extend(peer_state.channel_by_id.iter()
2589 .filter_map(|(chan_id, phase)| match phase {
2590 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2591 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2595 .map(|(_channel_id, channel)| {
2596 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2597 peer_state.latest_features.clone(), &self.fee_estimator)
2605 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2606 /// more information.
2607 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2608 // Allocate our best estimate of the number of channels we have in the `res`
2609 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2610 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2611 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2612 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2613 // the same channel.
2614 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2616 let best_block_height = self.best_block.read().unwrap().height();
2617 let per_peer_state = self.per_peer_state.read().unwrap();
2618 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2619 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2620 let peer_state = &mut *peer_state_lock;
2621 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2622 let details = ChannelDetails::from_channel_context(context, best_block_height,
2623 peer_state.latest_features.clone(), &self.fee_estimator);
2631 /// Gets the list of usable channels, in random order. Useful as an argument to
2632 /// [`Router::find_route`] to ensure non-announced channels are used.
2634 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2635 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2637 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2638 // Note we use is_live here instead of usable which leads to somewhat confused
2639 // internal/external nomenclature, but that's ok cause that's probably what the user
2640 // really wanted anyway.
2641 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2644 /// Gets the list of channels we have with a given counterparty, in random order.
2645 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2646 let best_block_height = self.best_block.read().unwrap().height();
2647 let per_peer_state = self.per_peer_state.read().unwrap();
2649 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2650 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2651 let peer_state = &mut *peer_state_lock;
2652 let features = &peer_state.latest_features;
2653 let context_to_details = |context| {
2654 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2656 return peer_state.channel_by_id
2658 .map(|(_, phase)| phase.context())
2659 .map(context_to_details)
2665 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2666 /// successful path, or have unresolved HTLCs.
2668 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2669 /// result of a crash. If such a payment exists, is not listed here, and an
2670 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2672 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2673 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2674 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2675 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2676 PendingOutboundPayment::AwaitingInvoice { .. } => {
2677 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2679 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2680 PendingOutboundPayment::InvoiceReceived { .. } => {
2681 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2683 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2684 Some(RecentPaymentDetails::Pending {
2685 payment_id: *payment_id,
2686 payment_hash: *payment_hash,
2687 total_msat: *total_msat,
2690 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2691 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2693 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2694 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2696 PendingOutboundPayment::Legacy { .. } => None
2701 /// Helper function that issues the channel close events
2702 fn issue_channel_close_events(&self, context: &ChannelContext<SP>, closure_reason: ClosureReason) {
2703 let mut pending_events_lock = self.pending_events.lock().unwrap();
2704 match context.unbroadcasted_funding() {
2705 Some(transaction) => {
2706 pending_events_lock.push_back((events::Event::DiscardFunding {
2707 channel_id: context.channel_id(), transaction
2712 pending_events_lock.push_back((events::Event::ChannelClosed {
2713 channel_id: context.channel_id(),
2714 user_channel_id: context.get_user_id(),
2715 reason: closure_reason,
2716 counterparty_node_id: Some(context.get_counterparty_node_id()),
2717 channel_capacity_sats: Some(context.get_value_satoshis()),
2721 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> {
2722 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2724 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
2725 let mut shutdown_result = None;
2728 let per_peer_state = self.per_peer_state.read().unwrap();
2730 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2731 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2733 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2734 let peer_state = &mut *peer_state_lock;
2736 match peer_state.channel_by_id.entry(channel_id.clone()) {
2737 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2738 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2739 let funding_txo_opt = chan.context.get_funding_txo();
2740 let their_features = &peer_state.latest_features;
2741 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2742 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2743 failed_htlcs = htlcs;
2745 // We can send the `shutdown` message before updating the `ChannelMonitor`
2746 // here as we don't need the monitor update to complete until we send a
2747 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2748 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2749 node_id: *counterparty_node_id,
2753 debug_assert!(monitor_update_opt.is_none() || !chan.is_shutdown(),
2754 "We can't both complete shutdown and generate a monitor update");
2756 // Update the monitor with the shutdown script if necessary.
2757 if let Some(monitor_update) = monitor_update_opt.take() {
2758 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2759 peer_state_lock, peer_state, per_peer_state, chan);
2762 self.issue_channel_close_events(chan_phase_entry.get().context(), ClosureReason::HolderForceClosed);
2763 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2764 shutdown_result = Some(chan_phase.context_mut().force_shutdown(false));
2767 hash_map::Entry::Vacant(_) => {
2768 return Err(APIError::ChannelUnavailable {
2770 "Channel with id {} not found for the passed counterparty node_id {}",
2771 channel_id, counterparty_node_id,
2778 for htlc_source in failed_htlcs.drain(..) {
2779 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2780 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2781 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2784 if let Some(shutdown_result) = shutdown_result {
2785 self.finish_close_channel(shutdown_result);
2791 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2792 /// will be accepted on the given channel, and after additional timeout/the closing of all
2793 /// pending HTLCs, the channel will be closed on chain.
2795 /// * If we are the channel initiator, we will pay between our [`ChannelCloseMinimum`] and
2796 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2798 /// * If our counterparty is the channel initiator, we will require a channel closing
2799 /// transaction feerate of at least our [`ChannelCloseMinimum`] feerate or the feerate which
2800 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2801 /// counterparty to pay as much fee as they'd like, however.
2803 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2805 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2806 /// generate a shutdown scriptpubkey or destination script set by
2807 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2810 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2811 /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
2812 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2813 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2814 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2815 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2818 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2819 /// will be accepted on the given channel, and after additional timeout/the closing of all
2820 /// pending HTLCs, the channel will be closed on chain.
2822 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2823 /// the channel being closed or not:
2824 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2825 /// transaction. The upper-bound is set by
2826 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2827 /// fee estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2828 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2829 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2830 /// will appear on a force-closure transaction, whichever is lower).
2832 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2833 /// Will fail if a shutdown script has already been set for this channel by
2834 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2835 /// also be compatible with our and the counterparty's features.
2837 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2839 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2840 /// generate a shutdown scriptpubkey or destination script set by
2841 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2844 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2845 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2846 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2847 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> {
2848 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2851 fn finish_close_channel(&self, mut shutdown_res: ShutdownResult) {
2852 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
2853 #[cfg(debug_assertions)]
2854 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
2855 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
2858 let logger = WithContext::from(
2859 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
2861 log_debug!(logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
2862 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
2863 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2864 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2865 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2866 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2868 if let Some((_, funding_txo, monitor_update)) = shutdown_res.monitor_update {
2869 // There isn't anything we can do if we get an update failure - we're already
2870 // force-closing. The monitor update on the required in-memory copy should broadcast
2871 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2872 // ignore the result here.
2873 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2875 let mut shutdown_results = Vec::new();
2876 if let Some(txid) = shutdown_res.unbroadcasted_batch_funding_txid {
2877 let mut funding_batch_states = self.funding_batch_states.lock().unwrap();
2878 let affected_channels = funding_batch_states.remove(&txid).into_iter().flatten();
2879 let per_peer_state = self.per_peer_state.read().unwrap();
2880 let mut has_uncompleted_channel = None;
2881 for (channel_id, counterparty_node_id, state) in affected_channels {
2882 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2883 let mut peer_state = peer_state_mutex.lock().unwrap();
2884 if let Some(mut chan) = peer_state.channel_by_id.remove(&channel_id) {
2885 update_maps_on_chan_removal!(self, &chan.context());
2886 self.issue_channel_close_events(&chan.context(), ClosureReason::FundingBatchClosure);
2887 shutdown_results.push(chan.context_mut().force_shutdown(false));
2890 has_uncompleted_channel = Some(has_uncompleted_channel.map_or(!state, |v| v || !state));
2893 has_uncompleted_channel.unwrap_or(true),
2894 "Closing a batch where all channels have completed initial monitor update",
2897 for shutdown_result in shutdown_results.drain(..) {
2898 self.finish_close_channel(shutdown_result);
2902 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2903 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2904 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2905 -> Result<PublicKey, APIError> {
2906 let per_peer_state = self.per_peer_state.read().unwrap();
2907 let peer_state_mutex = per_peer_state.get(peer_node_id)
2908 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2909 let (update_opt, counterparty_node_id) = {
2910 let mut peer_state = peer_state_mutex.lock().unwrap();
2911 let closure_reason = if let Some(peer_msg) = peer_msg {
2912 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2914 ClosureReason::HolderForceClosed
2916 let logger = WithContext::from(&self.logger, Some(*peer_node_id), Some(*channel_id));
2917 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2918 log_error!(logger, "Force-closing channel {}", channel_id);
2919 self.issue_channel_close_events(&chan_phase_entry.get().context(), closure_reason);
2920 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2921 mem::drop(peer_state);
2922 mem::drop(per_peer_state);
2924 ChannelPhase::Funded(mut chan) => {
2925 self.finish_close_channel(chan.context.force_shutdown(broadcast));
2926 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2928 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2929 self.finish_close_channel(chan_phase.context_mut().force_shutdown(false));
2930 // Unfunded channel has no update
2931 (None, chan_phase.context().get_counterparty_node_id())
2934 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2935 log_error!(logger, "Force-closing channel {}", &channel_id);
2936 // N.B. that we don't send any channel close event here: we
2937 // don't have a user_channel_id, and we never sent any opening
2939 (None, *peer_node_id)
2941 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2944 if let Some(update) = update_opt {
2945 // Try to send the `BroadcastChannelUpdate` to the peer we just force-closed on, but if
2946 // not try to broadcast it via whatever peer we have.
2947 let per_peer_state = self.per_peer_state.read().unwrap();
2948 let a_peer_state_opt = per_peer_state.get(peer_node_id)
2949 .ok_or(per_peer_state.values().next());
2950 if let Ok(a_peer_state_mutex) = a_peer_state_opt {
2951 let mut a_peer_state = a_peer_state_mutex.lock().unwrap();
2952 a_peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2958 Ok(counterparty_node_id)
2961 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2962 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2963 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2964 Ok(counterparty_node_id) => {
2965 let per_peer_state = self.per_peer_state.read().unwrap();
2966 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2967 let mut peer_state = peer_state_mutex.lock().unwrap();
2968 peer_state.pending_msg_events.push(
2969 events::MessageSendEvent::HandleError {
2970 node_id: counterparty_node_id,
2971 action: msgs::ErrorAction::DisconnectPeer {
2972 msg: Some(msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() })
2983 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2984 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2985 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2987 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2988 -> Result<(), APIError> {
2989 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2992 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2993 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2994 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2996 /// You can always get the latest local transaction(s) to broadcast from
2997 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2998 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2999 -> Result<(), APIError> {
3000 self.force_close_sending_error(channel_id, counterparty_node_id, false)
3003 /// Force close all channels, immediately broadcasting the latest local commitment transaction
3004 /// for each to the chain and rejecting new HTLCs on each.
3005 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
3006 for chan in self.list_channels() {
3007 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
3011 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
3012 /// local transaction(s).
3013 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
3014 for chan in self.list_channels() {
3015 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
3019 fn decode_update_add_htlc_onion(
3020 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
3022 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
3024 let (next_hop, shared_secret, next_packet_details_opt) = decode_incoming_update_add_htlc_onion(
3025 msg, &self.node_signer, &self.logger, &self.secp_ctx
3028 let is_blinded = match next_hop {
3029 onion_utils::Hop::Forward {
3030 next_hop_data: msgs::InboundOnionPayload::BlindedForward { .. }, ..
3032 _ => false, // TODO: update this when we support receiving to multi-hop blinded paths
3035 macro_rules! return_err {
3036 ($msg: expr, $err_code: expr, $data: expr) => {
3039 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
3040 "Failed to accept/forward incoming HTLC: {}", $msg
3042 let (err_code, err_data) = if is_blinded {
3043 (INVALID_ONION_BLINDING, &[0; 32][..])
3044 } else { ($err_code, $data) };
3045 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3046 channel_id: msg.channel_id,
3047 htlc_id: msg.htlc_id,
3048 reason: HTLCFailReason::reason(err_code, err_data.to_vec())
3049 .get_encrypted_failure_packet(&shared_secret, &None),
3055 let NextPacketDetails {
3056 next_packet_pubkey, outgoing_amt_msat, outgoing_scid, outgoing_cltv_value
3057 } = match next_packet_details_opt {
3058 Some(next_packet_details) => next_packet_details,
3059 // it is a receive, so no need for outbound checks
3060 None => return Ok((next_hop, shared_secret, None)),
3063 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
3064 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
3065 if let Some((err, mut code, chan_update)) = loop {
3066 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
3067 let forwarding_chan_info_opt = match id_option {
3068 None => { // unknown_next_peer
3069 // Note that this is likely a timing oracle for detecting whether an scid is a
3070 // phantom or an intercept.
3071 if (self.default_configuration.accept_intercept_htlcs &&
3072 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)) ||
3073 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)
3077 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3080 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
3082 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
3083 let per_peer_state = self.per_peer_state.read().unwrap();
3084 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3085 if peer_state_mutex_opt.is_none() {
3086 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3088 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3089 let peer_state = &mut *peer_state_lock;
3090 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
3091 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
3094 // Channel was removed. The short_to_chan_info and channel_by_id maps
3095 // have no consistency guarantees.
3096 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3100 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3101 // Note that the behavior here should be identical to the above block - we
3102 // should NOT reveal the existence or non-existence of a private channel if
3103 // we don't allow forwards outbound over them.
3104 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3106 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3107 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3108 // "refuse to forward unless the SCID alias was used", so we pretend
3109 // we don't have the channel here.
3110 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3112 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3114 // Note that we could technically not return an error yet here and just hope
3115 // that the connection is reestablished or monitor updated by the time we get
3116 // around to doing the actual forward, but better to fail early if we can and
3117 // hopefully an attacker trying to path-trace payments cannot make this occur
3118 // on a small/per-node/per-channel scale.
3119 if !chan.context.is_live() { // channel_disabled
3120 // If the channel_update we're going to return is disabled (i.e. the
3121 // peer has been disabled for some time), return `channel_disabled`,
3122 // otherwise return `temporary_channel_failure`.
3123 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3124 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3126 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3129 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3130 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3132 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3133 break Some((err, code, chan_update_opt));
3140 let cur_height = self.best_block.read().unwrap().height() + 1;
3142 if let Err((err_msg, code)) = check_incoming_htlc_cltv(
3143 cur_height, outgoing_cltv_value, msg.cltv_expiry
3145 if code & 0x1000 != 0 && chan_update_opt.is_none() {
3146 // We really should set `incorrect_cltv_expiry` here but as we're not
3147 // forwarding over a real channel we can't generate a channel_update
3148 // for it. Instead we just return a generic temporary_node_failure.
3149 break Some((err_msg, 0x2000 | 2, None))
3151 let chan_update_opt = if code & 0x1000 != 0 { chan_update_opt } else { None };
3152 break Some((err_msg, code, chan_update_opt));
3158 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3159 if let Some(chan_update) = chan_update {
3160 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3161 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3163 else if code == 0x1000 | 13 {
3164 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3166 else if code == 0x1000 | 20 {
3167 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3168 0u16.write(&mut res).expect("Writes cannot fail");
3170 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3171 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3172 chan_update.write(&mut res).expect("Writes cannot fail");
3173 } else if code & 0x1000 == 0x1000 {
3174 // If we're trying to return an error that requires a `channel_update` but
3175 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3176 // generate an update), just use the generic "temporary_node_failure"
3180 return_err!(err, code, &res.0[..]);
3182 Ok((next_hop, shared_secret, Some(next_packet_pubkey)))
3185 fn construct_pending_htlc_status<'a>(
3186 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
3187 decoded_hop: onion_utils::Hop, allow_underpay: bool,
3188 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
3189 ) -> PendingHTLCStatus {
3190 macro_rules! return_err {
3191 ($msg: expr, $err_code: expr, $data: expr) => {
3193 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
3194 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3195 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3196 channel_id: msg.channel_id,
3197 htlc_id: msg.htlc_id,
3198 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3199 .get_encrypted_failure_packet(&shared_secret, &None),
3205 onion_utils::Hop::Receive(next_hop_data) => {
3207 let current_height: u32 = self.best_block.read().unwrap().height();
3208 match create_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3209 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat,
3210 current_height, self.default_configuration.accept_mpp_keysend)
3213 // Note that we could obviously respond immediately with an update_fulfill_htlc
3214 // message, however that would leak that we are the recipient of this payment, so
3215 // instead we stay symmetric with the forwarding case, only responding (after a
3216 // delay) once they've send us a commitment_signed!
3217 PendingHTLCStatus::Forward(info)
3219 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3222 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3223 match create_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3224 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3225 Ok(info) => PendingHTLCStatus::Forward(info),
3226 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3232 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3233 /// public, and thus should be called whenever the result is going to be passed out in a
3234 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3236 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3237 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3238 /// storage and the `peer_state` lock has been dropped.
3240 /// [`channel_update`]: msgs::ChannelUpdate
3241 /// [`internal_closing_signed`]: Self::internal_closing_signed
3242 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3243 if !chan.context.should_announce() {
3244 return Err(LightningError {
3245 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3246 action: msgs::ErrorAction::IgnoreError
3249 if chan.context.get_short_channel_id().is_none() {
3250 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3252 let logger = WithChannelContext::from(&self.logger, &chan.context);
3253 log_trace!(logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3254 self.get_channel_update_for_unicast(chan)
3257 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3258 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3259 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3260 /// provided evidence that they know about the existence of the channel.
3262 /// Note that through [`internal_closing_signed`], this function is called without the
3263 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3264 /// removed from the storage and the `peer_state` lock has been dropped.
3266 /// [`channel_update`]: msgs::ChannelUpdate
3267 /// [`internal_closing_signed`]: Self::internal_closing_signed
3268 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3269 let logger = WithChannelContext::from(&self.logger, &chan.context);
3270 log_trace!(logger, "Attempting to generate channel update for channel {}", chan.context.channel_id());
3271 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3272 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3276 self.get_channel_update_for_onion(short_channel_id, chan)
3279 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3280 let logger = WithChannelContext::from(&self.logger, &chan.context);
3281 log_trace!(logger, "Generating channel update for channel {}", chan.context.channel_id());
3282 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3284 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3285 ChannelUpdateStatus::Enabled => true,
3286 ChannelUpdateStatus::DisabledStaged(_) => true,
3287 ChannelUpdateStatus::Disabled => false,
3288 ChannelUpdateStatus::EnabledStaged(_) => false,
3291 let unsigned = msgs::UnsignedChannelUpdate {
3292 chain_hash: self.chain_hash,
3294 timestamp: chan.context.get_update_time_counter(),
3295 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3296 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3297 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3298 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3299 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3300 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3301 excess_data: Vec::new(),
3303 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3304 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3305 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3307 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3309 Ok(msgs::ChannelUpdate {
3316 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> {
3317 let _lck = self.total_consistency_lock.read().unwrap();
3318 self.send_payment_along_path(SendAlongPathArgs {
3319 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3324 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3325 let SendAlongPathArgs {
3326 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3329 // The top-level caller should hold the total_consistency_lock read lock.
3330 debug_assert!(self.total_consistency_lock.try_write().is_err());
3331 let prng_seed = self.entropy_source.get_secure_random_bytes();
3332 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3334 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
3335 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
3336 payment_hash, keysend_preimage, prng_seed
3338 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3339 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
3343 let err: Result<(), _> = loop {
3344 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3346 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3347 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
3348 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
3350 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3353 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
3355 "Attempting to send payment with payment hash {} along path with next hop {}",
3356 payment_hash, path.hops.first().unwrap().short_channel_id);
3358 let per_peer_state = self.per_peer_state.read().unwrap();
3359 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3360 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3361 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3362 let peer_state = &mut *peer_state_lock;
3363 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3364 match chan_phase_entry.get_mut() {
3365 ChannelPhase::Funded(chan) => {
3366 if !chan.context.is_live() {
3367 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3369 let funding_txo = chan.context.get_funding_txo().unwrap();
3370 let logger = WithChannelContext::from(&self.logger, &chan.context);
3371 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3372 htlc_cltv, HTLCSource::OutboundRoute {
3374 session_priv: session_priv.clone(),
3375 first_hop_htlc_msat: htlc_msat,
3377 }, onion_packet, None, &self.fee_estimator, &&logger);
3378 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3379 Some(monitor_update) => {
3380 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3382 // Note that MonitorUpdateInProgress here indicates (per function
3383 // docs) that we will resend the commitment update once monitor
3384 // updating completes. Therefore, we must return an error
3385 // indicating that it is unsafe to retry the payment wholesale,
3386 // which we do in the send_payment check for
3387 // MonitorUpdateInProgress, below.
3388 return Err(APIError::MonitorUpdateInProgress);
3396 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3399 // The channel was likely removed after we fetched the id from the
3400 // `short_to_chan_info` map, but before we successfully locked the
3401 // `channel_by_id` map.
3402 // This can occur as no consistency guarantees exists between the two maps.
3403 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3407 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3408 Ok(_) => unreachable!(),
3410 Err(APIError::ChannelUnavailable { err: e.err })
3415 /// Sends a payment along a given route.
3417 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3418 /// fields for more info.
3420 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3421 /// [`PeerManager::process_events`]).
3423 /// # Avoiding Duplicate Payments
3425 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3426 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3427 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3428 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3429 /// second payment with the same [`PaymentId`].
3431 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3432 /// tracking of payments, including state to indicate once a payment has completed. Because you
3433 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3434 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3435 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3437 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3438 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3439 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3440 /// [`ChannelManager::list_recent_payments`] for more information.
3442 /// # Possible Error States on [`PaymentSendFailure`]
3444 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3445 /// each entry matching the corresponding-index entry in the route paths, see
3446 /// [`PaymentSendFailure`] for more info.
3448 /// In general, a path may raise:
3449 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3450 /// node public key) is specified.
3451 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3452 /// closed, doesn't exist, or the peer is currently disconnected.
3453 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3454 /// relevant updates.
3456 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3457 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3458 /// different route unless you intend to pay twice!
3460 /// [`RouteHop`]: crate::routing::router::RouteHop
3461 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3462 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3463 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3464 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3465 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3466 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3467 let best_block_height = self.best_block.read().unwrap().height();
3468 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3469 self.pending_outbound_payments
3470 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3471 &self.entropy_source, &self.node_signer, best_block_height,
3472 |args| self.send_payment_along_path(args))
3475 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3476 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3477 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3478 let best_block_height = self.best_block.read().unwrap().height();
3479 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3480 self.pending_outbound_payments
3481 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3482 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3483 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3484 &self.pending_events, |args| self.send_payment_along_path(args))
3488 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> {
3489 let best_block_height = self.best_block.read().unwrap().height();
3490 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3491 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3492 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3493 best_block_height, |args| self.send_payment_along_path(args))
3497 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> {
3498 let best_block_height = self.best_block.read().unwrap().height();
3499 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3503 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3504 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3507 pub(super) fn send_payment_for_bolt12_invoice(&self, invoice: &Bolt12Invoice, payment_id: PaymentId) -> Result<(), Bolt12PaymentError> {
3508 let best_block_height = self.best_block.read().unwrap().height();
3509 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3510 self.pending_outbound_payments
3511 .send_payment_for_bolt12_invoice(
3512 invoice, payment_id, &self.router, self.list_usable_channels(),
3513 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer,
3514 best_block_height, &self.logger, &self.pending_events,
3515 |args| self.send_payment_along_path(args)
3519 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3520 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3521 /// retries are exhausted.
3523 /// # Event Generation
3525 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3526 /// as there are no remaining pending HTLCs for this payment.
3528 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3529 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3530 /// determine the ultimate status of a payment.
3532 /// # Requested Invoices
3534 /// In the case of paying a [`Bolt12Invoice`] via [`ChannelManager::pay_for_offer`], abandoning
3535 /// the payment prior to receiving the invoice will result in an [`Event::InvoiceRequestFailed`]
3536 /// and prevent any attempts at paying it once received. The other events may only be generated
3537 /// once the invoice has been received.
3539 /// # Restart Behavior
3541 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3542 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3543 /// [`Event::InvoiceRequestFailed`].
3545 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3546 pub fn abandon_payment(&self, payment_id: PaymentId) {
3547 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3548 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3551 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3552 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3553 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3554 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3555 /// never reach the recipient.
3557 /// See [`send_payment`] documentation for more details on the return value of this function
3558 /// and idempotency guarantees provided by the [`PaymentId`] key.
3560 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3561 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3563 /// [`send_payment`]: Self::send_payment
3564 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3565 let best_block_height = self.best_block.read().unwrap().height();
3566 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3567 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3568 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3569 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3572 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3573 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3575 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3578 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3579 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> {
3580 let best_block_height = self.best_block.read().unwrap().height();
3581 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3582 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3583 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3584 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3585 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3588 /// Send a payment that is probing the given route for liquidity. We calculate the
3589 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3590 /// us to easily discern them from real payments.
3591 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3592 let best_block_height = self.best_block.read().unwrap().height();
3593 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3594 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3595 &self.entropy_source, &self.node_signer, best_block_height,
3596 |args| self.send_payment_along_path(args))
3599 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3602 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3603 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3606 /// Sends payment probes over all paths of a route that would be used to pay the given
3607 /// amount to the given `node_id`.
3609 /// See [`ChannelManager::send_preflight_probes`] for more information.
3610 pub fn send_spontaneous_preflight_probes(
3611 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3612 liquidity_limit_multiplier: Option<u64>,
3613 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3614 let payment_params =
3615 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3617 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
3619 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3622 /// Sends payment probes over all paths of a route that would be used to pay a route found
3623 /// according to the given [`RouteParameters`].
3625 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3626 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3627 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3628 /// confirmation in a wallet UI.
3630 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3631 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3632 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3633 /// payment. To mitigate this issue, channels with available liquidity less than the required
3634 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3635 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3636 pub fn send_preflight_probes(
3637 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3638 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3639 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3641 let payer = self.get_our_node_id();
3642 let usable_channels = self.list_usable_channels();
3643 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3644 let inflight_htlcs = self.compute_inflight_htlcs();
3648 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3650 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3651 ProbeSendFailure::RouteNotFound
3654 let mut used_liquidity_map = HashMap::with_capacity(first_hops.len());
3656 let mut res = Vec::new();
3658 for mut path in route.paths {
3659 // If the last hop is probably an unannounced channel we refrain from probing all the
3660 // way through to the end and instead probe up to the second-to-last channel.
3661 while let Some(last_path_hop) = path.hops.last() {
3662 if last_path_hop.maybe_announced_channel {
3663 // We found a potentially announced last hop.
3666 // Drop the last hop, as it's likely unannounced.
3669 "Avoided sending payment probe all the way to last hop {} as it is likely unannounced.",
3670 last_path_hop.short_channel_id
3672 let final_value_msat = path.final_value_msat();
3674 if let Some(new_last) = path.hops.last_mut() {
3675 new_last.fee_msat += final_value_msat;
3680 if path.hops.len() < 2 {
3683 "Skipped sending payment probe over path with less than two hops."
3688 if let Some(first_path_hop) = path.hops.first() {
3689 if let Some(first_hop) = first_hops.iter().find(|h| {
3690 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3692 let path_value = path.final_value_msat() + path.fee_msat();
3693 let used_liquidity =
3694 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3696 if first_hop.next_outbound_htlc_limit_msat
3697 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3699 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3702 *used_liquidity += path_value;
3707 res.push(self.send_probe(path).map_err(|e| {
3708 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3709 ProbeSendFailure::SendingFailed(e)
3716 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3717 /// which checks the correctness of the funding transaction given the associated channel.
3718 fn funding_transaction_generated_intern<FundingOutput: FnMut(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3719 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, is_batch_funding: bool,
3720 mut find_funding_output: FundingOutput,
3721 ) -> Result<(), APIError> {
3722 let per_peer_state = self.per_peer_state.read().unwrap();
3723 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3724 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3726 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3727 let peer_state = &mut *peer_state_lock;
3728 let (chan, msg_opt) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3729 Some(ChannelPhase::UnfundedOutboundV1(mut chan)) => {
3730 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3732 let logger = WithChannelContext::from(&self.logger, &chan.context);
3733 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, is_batch_funding, &&logger)
3734 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3735 let channel_id = chan.context.channel_id();
3736 let user_id = chan.context.get_user_id();
3737 let shutdown_res = chan.context.force_shutdown(false);
3738 let channel_capacity = chan.context.get_value_satoshis();
3739 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3740 } else { unreachable!(); });
3742 Ok(funding_msg) => (chan, funding_msg),
3743 Err((chan, err)) => {
3744 mem::drop(peer_state_lock);
3745 mem::drop(per_peer_state);
3746 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3747 return Err(APIError::ChannelUnavailable {
3748 err: "Signer refused to sign the initial commitment transaction".to_owned()
3754 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3755 return Err(APIError::APIMisuseError {
3757 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3758 temporary_channel_id, counterparty_node_id),
3761 None => return Err(APIError::ChannelUnavailable {err: format!(
3762 "Channel with id {} not found for the passed counterparty node_id {}",
3763 temporary_channel_id, counterparty_node_id),
3767 if let Some(msg) = msg_opt {
3768 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3769 node_id: chan.context.get_counterparty_node_id(),
3773 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3774 hash_map::Entry::Occupied(_) => {
3775 panic!("Generated duplicate funding txid?");
3777 hash_map::Entry::Vacant(e) => {
3778 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3779 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3780 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3782 e.insert(ChannelPhase::UnfundedOutboundV1(chan));
3789 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3790 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, false, |_, tx| {
3791 Ok(OutPoint { txid: tx.txid(), index: output_index })
3795 /// Call this upon creation of a funding transaction for the given channel.
3797 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3798 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3800 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3801 /// across the p2p network.
3803 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3804 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3806 /// May panic if the output found in the funding transaction is duplicative with some other
3807 /// channel (note that this should be trivially prevented by using unique funding transaction
3808 /// keys per-channel).
3810 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3811 /// counterparty's signature the funding transaction will automatically be broadcast via the
3812 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3814 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3815 /// not currently support replacing a funding transaction on an existing channel. Instead,
3816 /// create a new channel with a conflicting funding transaction.
3818 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3819 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3820 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3821 /// for more details.
3823 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3824 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3825 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3826 self.batch_funding_transaction_generated(&[(temporary_channel_id, counterparty_node_id)], funding_transaction)
3829 /// Call this upon creation of a batch funding transaction for the given channels.
3831 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
3832 /// each individual channel and transaction output.
3834 /// Do NOT broadcast the funding transaction yourself. This batch funding transaction
3835 /// will only be broadcast when we have safely received and persisted the counterparty's
3836 /// signature for each channel.
3838 /// If there is an error, all channels in the batch are to be considered closed.
3839 pub fn batch_funding_transaction_generated(&self, temporary_channels: &[(&ChannelId, &PublicKey)], funding_transaction: Transaction) -> Result<(), APIError> {
3840 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3841 let mut result = Ok(());
3843 if !funding_transaction.is_coin_base() {
3844 for inp in funding_transaction.input.iter() {
3845 if inp.witness.is_empty() {
3846 result = result.and(Err(APIError::APIMisuseError {
3847 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3852 if funding_transaction.output.len() > u16::max_value() as usize {
3853 result = result.and(Err(APIError::APIMisuseError {
3854 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3858 let height = self.best_block.read().unwrap().height();
3859 // Transactions are evaluated as final by network mempools if their locktime is strictly
3860 // lower than the next block height. However, the modules constituting our Lightning
3861 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3862 // module is ahead of LDK, only allow one more block of headroom.
3863 if !funding_transaction.input.iter().all(|input| input.sequence == Sequence::MAX) &&
3864 funding_transaction.lock_time.is_block_height() &&
3865 funding_transaction.lock_time.to_consensus_u32() > height + 1
3867 result = result.and(Err(APIError::APIMisuseError {
3868 err: "Funding transaction absolute timelock is non-final".to_owned()
3873 let txid = funding_transaction.txid();
3874 let is_batch_funding = temporary_channels.len() > 1;
3875 let mut funding_batch_states = if is_batch_funding {
3876 Some(self.funding_batch_states.lock().unwrap())
3880 let mut funding_batch_state = funding_batch_states.as_mut().and_then(|states| {
3881 match states.entry(txid) {
3882 btree_map::Entry::Occupied(_) => {
3883 result = result.clone().and(Err(APIError::APIMisuseError {
3884 err: "Batch funding transaction with the same txid already exists".to_owned()
3888 btree_map::Entry::Vacant(vacant) => Some(vacant.insert(Vec::new())),
3891 for &(temporary_channel_id, counterparty_node_id) in temporary_channels {
3892 result = result.and_then(|_| self.funding_transaction_generated_intern(
3893 temporary_channel_id,
3894 counterparty_node_id,
3895 funding_transaction.clone(),
3898 let mut output_index = None;
3899 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3900 for (idx, outp) in tx.output.iter().enumerate() {
3901 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3902 if output_index.is_some() {
3903 return Err(APIError::APIMisuseError {
3904 err: "Multiple outputs matched the expected script and value".to_owned()
3907 output_index = Some(idx as u16);
3910 if output_index.is_none() {
3911 return Err(APIError::APIMisuseError {
3912 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3915 let outpoint = OutPoint { txid: tx.txid(), index: output_index.unwrap() };
3916 if let Some(funding_batch_state) = funding_batch_state.as_mut() {
3917 funding_batch_state.push((outpoint.to_channel_id(), *counterparty_node_id, false));
3923 if let Err(ref e) = result {
3924 // Remaining channels need to be removed on any error.
3925 let e = format!("Error in transaction funding: {:?}", e);
3926 let mut channels_to_remove = Vec::new();
3927 channels_to_remove.extend(funding_batch_states.as_mut()
3928 .and_then(|states| states.remove(&txid))
3929 .into_iter().flatten()
3930 .map(|(chan_id, node_id, _state)| (chan_id, node_id))
3932 channels_to_remove.extend(temporary_channels.iter()
3933 .map(|(&chan_id, &node_id)| (chan_id, node_id))
3935 let mut shutdown_results = Vec::new();
3937 let per_peer_state = self.per_peer_state.read().unwrap();
3938 for (channel_id, counterparty_node_id) in channels_to_remove {
3939 per_peer_state.get(&counterparty_node_id)
3940 .map(|peer_state_mutex| peer_state_mutex.lock().unwrap())
3941 .and_then(|mut peer_state| peer_state.channel_by_id.remove(&channel_id))
3943 update_maps_on_chan_removal!(self, &chan.context());
3944 self.issue_channel_close_events(&chan.context(), ClosureReason::ProcessingError { err: e.clone() });
3945 shutdown_results.push(chan.context_mut().force_shutdown(false));
3949 for shutdown_result in shutdown_results.drain(..) {
3950 self.finish_close_channel(shutdown_result);
3956 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3958 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3959 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3960 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3961 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3963 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3964 /// `counterparty_node_id` is provided.
3966 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3967 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3969 /// If an error is returned, none of the updates should be considered applied.
3971 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3972 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3973 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3974 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3975 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3976 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3977 /// [`APIMisuseError`]: APIError::APIMisuseError
3978 pub fn update_partial_channel_config(
3979 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
3980 ) -> Result<(), APIError> {
3981 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3982 return Err(APIError::APIMisuseError {
3983 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3987 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3988 let per_peer_state = self.per_peer_state.read().unwrap();
3989 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3990 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3991 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3992 let peer_state = &mut *peer_state_lock;
3993 for channel_id in channel_ids {
3994 if !peer_state.has_channel(channel_id) {
3995 return Err(APIError::ChannelUnavailable {
3996 err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, counterparty_node_id),
4000 for channel_id in channel_ids {
4001 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
4002 let mut config = channel_phase.context().config();
4003 config.apply(config_update);
4004 if !channel_phase.context_mut().update_config(&config) {
4007 if let ChannelPhase::Funded(channel) = channel_phase {
4008 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
4009 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
4010 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
4011 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4012 node_id: channel.context.get_counterparty_node_id(),
4019 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
4020 debug_assert!(false);
4021 return Err(APIError::ChannelUnavailable {
4023 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
4024 channel_id, counterparty_node_id),
4031 /// Atomically updates the [`ChannelConfig`] for the given channels.
4033 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4034 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4035 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4036 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4038 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4039 /// `counterparty_node_id` is provided.
4041 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4042 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4044 /// If an error is returned, none of the updates should be considered applied.
4046 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4047 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4048 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4049 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4050 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4051 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4052 /// [`APIMisuseError`]: APIError::APIMisuseError
4053 pub fn update_channel_config(
4054 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
4055 ) -> Result<(), APIError> {
4056 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
4059 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
4060 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
4062 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
4063 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
4065 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
4066 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
4067 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
4068 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
4069 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
4071 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
4072 /// you from forwarding more than you received. See
4073 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
4076 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4079 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
4080 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4081 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
4082 // TODO: when we move to deciding the best outbound channel at forward time, only take
4083 // `next_node_id` and not `next_hop_channel_id`
4084 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> {
4085 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4087 let next_hop_scid = {
4088 let peer_state_lock = self.per_peer_state.read().unwrap();
4089 let peer_state_mutex = peer_state_lock.get(&next_node_id)
4090 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
4091 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4092 let peer_state = &mut *peer_state_lock;
4093 match peer_state.channel_by_id.get(next_hop_channel_id) {
4094 Some(ChannelPhase::Funded(chan)) => {
4095 if !chan.context.is_usable() {
4096 return Err(APIError::ChannelUnavailable {
4097 err: format!("Channel with id {} not fully established", next_hop_channel_id)
4100 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
4102 Some(_) => return Err(APIError::ChannelUnavailable {
4103 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
4104 next_hop_channel_id, next_node_id)
4107 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
4108 next_hop_channel_id, next_node_id);
4109 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
4110 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
4111 return Err(APIError::ChannelUnavailable {
4118 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4119 .ok_or_else(|| APIError::APIMisuseError {
4120 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4123 let routing = match payment.forward_info.routing {
4124 PendingHTLCRouting::Forward { onion_packet, blinded, .. } => {
4125 PendingHTLCRouting::Forward {
4126 onion_packet, blinded, short_channel_id: next_hop_scid
4129 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
4131 let skimmed_fee_msat =
4132 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
4133 let pending_htlc_info = PendingHTLCInfo {
4134 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
4135 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
4138 let mut per_source_pending_forward = [(
4139 payment.prev_short_channel_id,
4140 payment.prev_funding_outpoint,
4141 payment.prev_user_channel_id,
4142 vec![(pending_htlc_info, payment.prev_htlc_id)]
4144 self.forward_htlcs(&mut per_source_pending_forward);
4148 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
4149 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
4151 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4154 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4155 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
4156 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4158 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4159 .ok_or_else(|| APIError::APIMisuseError {
4160 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4163 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
4164 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4165 short_channel_id: payment.prev_short_channel_id,
4166 user_channel_id: Some(payment.prev_user_channel_id),
4167 outpoint: payment.prev_funding_outpoint,
4168 htlc_id: payment.prev_htlc_id,
4169 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
4170 phantom_shared_secret: None,
4171 blinded_failure: payment.forward_info.routing.blinded_failure(),
4174 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
4175 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
4176 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
4177 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
4182 /// Processes HTLCs which are pending waiting on random forward delay.
4184 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
4185 /// Will likely generate further events.
4186 pub fn process_pending_htlc_forwards(&self) {
4187 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4189 let mut new_events = VecDeque::new();
4190 let mut failed_forwards = Vec::new();
4191 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
4193 let mut forward_htlcs = HashMap::new();
4194 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
4196 for (short_chan_id, mut pending_forwards) in forward_htlcs {
4197 if short_chan_id != 0 {
4198 let mut forwarding_counterparty = None;
4199 macro_rules! forwarding_channel_not_found {
4201 for forward_info in pending_forwards.drain(..) {
4202 match forward_info {
4203 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4204 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4205 forward_info: PendingHTLCInfo {
4206 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
4207 outgoing_cltv_value, ..
4210 macro_rules! failure_handler {
4211 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
4212 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
4213 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
4215 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4216 short_channel_id: prev_short_channel_id,
4217 user_channel_id: Some(prev_user_channel_id),
4218 outpoint: prev_funding_outpoint,
4219 htlc_id: prev_htlc_id,
4220 incoming_packet_shared_secret: incoming_shared_secret,
4221 phantom_shared_secret: $phantom_ss,
4222 blinded_failure: routing.blinded_failure(),
4225 let reason = if $next_hop_unknown {
4226 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
4228 HTLCDestination::FailedPayment{ payment_hash }
4231 failed_forwards.push((htlc_source, payment_hash,
4232 HTLCFailReason::reason($err_code, $err_data),
4238 macro_rules! fail_forward {
4239 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4241 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4245 macro_rules! failed_payment {
4246 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4248 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4252 if let PendingHTLCRouting::Forward { ref onion_packet, .. } = routing {
4253 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4254 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.chain_hash) {
4255 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4256 let next_hop = match onion_utils::decode_next_payment_hop(
4257 phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac,
4258 payment_hash, None, &self.node_signer
4261 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4262 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).to_byte_array();
4263 // In this scenario, the phantom would have sent us an
4264 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4265 // if it came from us (the second-to-last hop) but contains the sha256
4267 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4269 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4270 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4274 onion_utils::Hop::Receive(hop_data) => {
4275 let current_height: u32 = self.best_block.read().unwrap().height();
4276 match create_recv_pending_htlc_info(hop_data,
4277 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4278 outgoing_cltv_value, Some(phantom_shared_secret), false, None,
4279 current_height, self.default_configuration.accept_mpp_keysend)
4281 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4282 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4288 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4291 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4294 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4295 // Channel went away before we could fail it. This implies
4296 // the channel is now on chain and our counterparty is
4297 // trying to broadcast the HTLC-Timeout, but that's their
4298 // problem, not ours.
4304 let chan_info_opt = self.short_to_chan_info.read().unwrap().get(&short_chan_id).cloned();
4305 let (counterparty_node_id, forward_chan_id) = match chan_info_opt {
4306 Some((cp_id, chan_id)) => (cp_id, chan_id),
4308 forwarding_channel_not_found!();
4312 forwarding_counterparty = Some(counterparty_node_id);
4313 let per_peer_state = self.per_peer_state.read().unwrap();
4314 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4315 if peer_state_mutex_opt.is_none() {
4316 forwarding_channel_not_found!();
4319 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4320 let peer_state = &mut *peer_state_lock;
4321 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4322 let logger = WithChannelContext::from(&self.logger, &chan.context);
4323 for forward_info in pending_forwards.drain(..) {
4324 match forward_info {
4325 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4326 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4327 forward_info: PendingHTLCInfo {
4328 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4329 routing: PendingHTLCRouting::Forward {
4330 onion_packet, blinded, ..
4331 }, skimmed_fee_msat, ..
4334 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);
4335 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4336 short_channel_id: prev_short_channel_id,
4337 user_channel_id: Some(prev_user_channel_id),
4338 outpoint: prev_funding_outpoint,
4339 htlc_id: prev_htlc_id,
4340 incoming_packet_shared_secret: incoming_shared_secret,
4341 // Phantom payments are only PendingHTLCRouting::Receive.
4342 phantom_shared_secret: None,
4343 blinded_failure: blinded.map(|_| BlindedFailure::FromIntroductionNode),
4345 let next_blinding_point = blinded.and_then(|b| {
4346 let encrypted_tlvs_ss = self.node_signer.ecdh(
4347 Recipient::Node, &b.inbound_blinding_point, None
4348 ).unwrap().secret_bytes();
4349 onion_utils::next_hop_pubkey(
4350 &self.secp_ctx, b.inbound_blinding_point, &encrypted_tlvs_ss
4353 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4354 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4355 onion_packet, skimmed_fee_msat, next_blinding_point, &self.fee_estimator,
4358 if let ChannelError::Ignore(msg) = e {
4359 log_trace!(logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4361 panic!("Stated return value requirements in send_htlc() were not met");
4363 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4364 failed_forwards.push((htlc_source, payment_hash,
4365 HTLCFailReason::reason(failure_code, data),
4366 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4371 HTLCForwardInfo::AddHTLC { .. } => {
4372 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4374 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4375 log_trace!(logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4376 if let Err(e) = chan.queue_fail_htlc(
4377 htlc_id, err_packet, &&logger
4379 if let ChannelError::Ignore(msg) = e {
4380 log_trace!(logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4382 panic!("Stated return value requirements in queue_fail_htlc() were not met");
4384 // fail-backs are best-effort, we probably already have one
4385 // pending, and if not that's OK, if not, the channel is on
4386 // the chain and sending the HTLC-Timeout is their problem.
4390 HTLCForwardInfo::FailMalformedHTLC { .. } => {
4396 forwarding_channel_not_found!();
4400 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4401 match forward_info {
4402 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4403 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4404 forward_info: PendingHTLCInfo {
4405 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4406 skimmed_fee_msat, ..
4409 let blinded_failure = routing.blinded_failure();
4410 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4411 PendingHTLCRouting::Receive {
4412 payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret,
4413 custom_tlvs, requires_blinded_error: _
4415 let _legacy_hop_data = Some(payment_data.clone());
4416 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4417 payment_metadata, custom_tlvs };
4418 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4419 Some(payment_data), phantom_shared_secret, onion_fields)
4421 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4422 let onion_fields = RecipientOnionFields {
4423 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4427 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4428 payment_data, None, onion_fields)
4431 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4434 let claimable_htlc = ClaimableHTLC {
4435 prev_hop: HTLCPreviousHopData {
4436 short_channel_id: prev_short_channel_id,
4437 user_channel_id: Some(prev_user_channel_id),
4438 outpoint: prev_funding_outpoint,
4439 htlc_id: prev_htlc_id,
4440 incoming_packet_shared_secret: incoming_shared_secret,
4441 phantom_shared_secret,
4444 // We differentiate the received value from the sender intended value
4445 // if possible so that we don't prematurely mark MPP payments complete
4446 // if routing nodes overpay
4447 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4448 sender_intended_value: outgoing_amt_msat,
4450 total_value_received: None,
4451 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4454 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4457 let mut committed_to_claimable = false;
4459 macro_rules! fail_htlc {
4460 ($htlc: expr, $payment_hash: expr) => {
4461 debug_assert!(!committed_to_claimable);
4462 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4463 htlc_msat_height_data.extend_from_slice(
4464 &self.best_block.read().unwrap().height().to_be_bytes(),
4466 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4467 short_channel_id: $htlc.prev_hop.short_channel_id,
4468 user_channel_id: $htlc.prev_hop.user_channel_id,
4469 outpoint: prev_funding_outpoint,
4470 htlc_id: $htlc.prev_hop.htlc_id,
4471 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4472 phantom_shared_secret,
4475 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4476 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4478 continue 'next_forwardable_htlc;
4481 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4482 let mut receiver_node_id = self.our_network_pubkey;
4483 if phantom_shared_secret.is_some() {
4484 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4485 .expect("Failed to get node_id for phantom node recipient");
4488 macro_rules! check_total_value {
4489 ($purpose: expr) => {{
4490 let mut payment_claimable_generated = false;
4491 let is_keysend = match $purpose {
4492 events::PaymentPurpose::SpontaneousPayment(_) => true,
4493 events::PaymentPurpose::InvoicePayment { .. } => false,
4495 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4496 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4497 fail_htlc!(claimable_htlc, payment_hash);
4499 let ref mut claimable_payment = claimable_payments.claimable_payments
4500 .entry(payment_hash)
4501 // Note that if we insert here we MUST NOT fail_htlc!()
4502 .or_insert_with(|| {
4503 committed_to_claimable = true;
4505 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4508 if $purpose != claimable_payment.purpose {
4509 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4510 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));
4511 fail_htlc!(claimable_htlc, payment_hash);
4513 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4514 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);
4515 fail_htlc!(claimable_htlc, payment_hash);
4517 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4518 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4519 fail_htlc!(claimable_htlc, payment_hash);
4522 claimable_payment.onion_fields = Some(onion_fields);
4524 let ref mut htlcs = &mut claimable_payment.htlcs;
4525 let mut total_value = claimable_htlc.sender_intended_value;
4526 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4527 for htlc in htlcs.iter() {
4528 total_value += htlc.sender_intended_value;
4529 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4530 if htlc.total_msat != claimable_htlc.total_msat {
4531 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4532 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4533 total_value = msgs::MAX_VALUE_MSAT;
4535 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4537 // The condition determining whether an MPP is complete must
4538 // match exactly the condition used in `timer_tick_occurred`
4539 if total_value >= msgs::MAX_VALUE_MSAT {
4540 fail_htlc!(claimable_htlc, payment_hash);
4541 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4542 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4544 fail_htlc!(claimable_htlc, payment_hash);
4545 } else if total_value >= claimable_htlc.total_msat {
4546 #[allow(unused_assignments)] {
4547 committed_to_claimable = true;
4549 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4550 htlcs.push(claimable_htlc);
4551 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4552 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4553 let counterparty_skimmed_fee_msat = htlcs.iter()
4554 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4555 debug_assert!(total_value.saturating_sub(amount_msat) <=
4556 counterparty_skimmed_fee_msat);
4557 new_events.push_back((events::Event::PaymentClaimable {
4558 receiver_node_id: Some(receiver_node_id),
4562 counterparty_skimmed_fee_msat,
4563 via_channel_id: Some(prev_channel_id),
4564 via_user_channel_id: Some(prev_user_channel_id),
4565 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4566 onion_fields: claimable_payment.onion_fields.clone(),
4568 payment_claimable_generated = true;
4570 // Nothing to do - we haven't reached the total
4571 // payment value yet, wait until we receive more
4573 htlcs.push(claimable_htlc);
4574 #[allow(unused_assignments)] {
4575 committed_to_claimable = true;
4578 payment_claimable_generated
4582 // Check that the payment hash and secret are known. Note that we
4583 // MUST take care to handle the "unknown payment hash" and
4584 // "incorrect payment secret" cases here identically or we'd expose
4585 // that we are the ultimate recipient of the given payment hash.
4586 // Further, we must not expose whether we have any other HTLCs
4587 // associated with the same payment_hash pending or not.
4588 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4589 match payment_secrets.entry(payment_hash) {
4590 hash_map::Entry::Vacant(_) => {
4591 match claimable_htlc.onion_payload {
4592 OnionPayload::Invoice { .. } => {
4593 let payment_data = payment_data.unwrap();
4594 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) {
4595 Ok(result) => result,
4597 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4598 fail_htlc!(claimable_htlc, payment_hash);
4601 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4602 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4603 if (cltv_expiry as u64) < expected_min_expiry_height {
4604 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4605 &payment_hash, cltv_expiry, expected_min_expiry_height);
4606 fail_htlc!(claimable_htlc, payment_hash);
4609 let purpose = events::PaymentPurpose::InvoicePayment {
4610 payment_preimage: payment_preimage.clone(),
4611 payment_secret: payment_data.payment_secret,
4613 check_total_value!(purpose);
4615 OnionPayload::Spontaneous(preimage) => {
4616 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4617 check_total_value!(purpose);
4621 hash_map::Entry::Occupied(inbound_payment) => {
4622 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4623 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);
4624 fail_htlc!(claimable_htlc, payment_hash);
4626 let payment_data = payment_data.unwrap();
4627 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4628 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4629 fail_htlc!(claimable_htlc, payment_hash);
4630 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4631 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4632 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4633 fail_htlc!(claimable_htlc, payment_hash);
4635 let purpose = events::PaymentPurpose::InvoicePayment {
4636 payment_preimage: inbound_payment.get().payment_preimage,
4637 payment_secret: payment_data.payment_secret,
4639 let payment_claimable_generated = check_total_value!(purpose);
4640 if payment_claimable_generated {
4641 inbound_payment.remove_entry();
4647 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4648 panic!("Got pending fail of our own HTLC");
4656 let best_block_height = self.best_block.read().unwrap().height();
4657 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4658 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4659 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4661 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4662 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4664 self.forward_htlcs(&mut phantom_receives);
4666 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4667 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4668 // nice to do the work now if we can rather than while we're trying to get messages in the
4670 self.check_free_holding_cells();
4672 if new_events.is_empty() { return }
4673 let mut events = self.pending_events.lock().unwrap();
4674 events.append(&mut new_events);
4677 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4679 /// Expects the caller to have a total_consistency_lock read lock.
4680 fn process_background_events(&self) -> NotifyOption {
4681 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4683 self.background_events_processed_since_startup.store(true, Ordering::Release);
4685 let mut background_events = Vec::new();
4686 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4687 if background_events.is_empty() {
4688 return NotifyOption::SkipPersistNoEvents;
4691 for event in background_events.drain(..) {
4693 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4694 // The channel has already been closed, so no use bothering to care about the
4695 // monitor updating completing.
4696 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4698 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4699 let mut updated_chan = false;
4701 let per_peer_state = self.per_peer_state.read().unwrap();
4702 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4703 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4704 let peer_state = &mut *peer_state_lock;
4705 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4706 hash_map::Entry::Occupied(mut chan_phase) => {
4707 if let ChannelPhase::Funded(chan) = chan_phase.get_mut() {
4708 updated_chan = true;
4709 handle_new_monitor_update!(self, funding_txo, update.clone(),
4710 peer_state_lock, peer_state, per_peer_state, chan);
4712 debug_assert!(false, "We shouldn't have an update for a non-funded channel");
4715 hash_map::Entry::Vacant(_) => {},
4720 // TODO: Track this as in-flight even though the channel is closed.
4721 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4724 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4725 let per_peer_state = self.per_peer_state.read().unwrap();
4726 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4727 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4728 let peer_state = &mut *peer_state_lock;
4729 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4730 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4732 let update_actions = peer_state.monitor_update_blocked_actions
4733 .remove(&channel_id).unwrap_or(Vec::new());
4734 mem::drop(peer_state_lock);
4735 mem::drop(per_peer_state);
4736 self.handle_monitor_update_completion_actions(update_actions);
4742 NotifyOption::DoPersist
4745 #[cfg(any(test, feature = "_test_utils"))]
4746 /// Process background events, for functional testing
4747 pub fn test_process_background_events(&self) {
4748 let _lck = self.total_consistency_lock.read().unwrap();
4749 let _ = self.process_background_events();
4752 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4753 if !chan.context.is_outbound() { return NotifyOption::SkipPersistNoEvents; }
4755 let logger = WithChannelContext::from(&self.logger, &chan.context);
4757 // If the feerate has decreased by less than half, don't bother
4758 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4759 if new_feerate != chan.context.get_feerate_sat_per_1000_weight() {
4760 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4761 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4763 return NotifyOption::SkipPersistNoEvents;
4765 if !chan.context.is_live() {
4766 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {} as it cannot currently be updated (probably the peer is disconnected).",
4767 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4768 return NotifyOption::SkipPersistNoEvents;
4770 log_trace!(logger, "Channel {} qualifies for a feerate change from {} to {}.",
4771 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4773 chan.queue_update_fee(new_feerate, &self.fee_estimator, &&logger);
4774 NotifyOption::DoPersist
4778 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4779 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4780 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4781 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4782 pub fn maybe_update_chan_fees(&self) {
4783 PersistenceNotifierGuard::optionally_notify(self, || {
4784 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4786 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4787 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4789 let per_peer_state = self.per_peer_state.read().unwrap();
4790 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4791 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4792 let peer_state = &mut *peer_state_lock;
4793 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4794 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4796 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4801 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4802 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4810 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4812 /// This currently includes:
4813 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4814 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4815 /// than a minute, informing the network that they should no longer attempt to route over
4817 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4818 /// with the current [`ChannelConfig`].
4819 /// * Removing peers which have disconnected but and no longer have any channels.
4820 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4821 /// * Forgetting about stale outbound payments, either those that have already been fulfilled
4822 /// or those awaiting an invoice that hasn't been delivered in the necessary amount of time.
4823 /// The latter is determined using the system clock in `std` and the highest seen block time
4824 /// minus two hours in `no-std`.
4826 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4827 /// estimate fetches.
4829 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4830 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4831 pub fn timer_tick_occurred(&self) {
4832 PersistenceNotifierGuard::optionally_notify(self, || {
4833 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4835 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4836 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4838 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4839 let mut timed_out_mpp_htlcs = Vec::new();
4840 let mut pending_peers_awaiting_removal = Vec::new();
4841 let mut shutdown_channels = Vec::new();
4843 let mut process_unfunded_channel_tick = |
4844 chan_id: &ChannelId,
4845 context: &mut ChannelContext<SP>,
4846 unfunded_context: &mut UnfundedChannelContext,
4847 pending_msg_events: &mut Vec<MessageSendEvent>,
4848 counterparty_node_id: PublicKey,
4850 context.maybe_expire_prev_config();
4851 if unfunded_context.should_expire_unfunded_channel() {
4852 let logger = WithChannelContext::from(&self.logger, context);
4854 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4855 update_maps_on_chan_removal!(self, &context);
4856 self.issue_channel_close_events(&context, ClosureReason::HolderForceClosed);
4857 shutdown_channels.push(context.force_shutdown(false));
4858 pending_msg_events.push(MessageSendEvent::HandleError {
4859 node_id: counterparty_node_id,
4860 action: msgs::ErrorAction::SendErrorMessage {
4861 msg: msgs::ErrorMessage {
4862 channel_id: *chan_id,
4863 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4874 let per_peer_state = self.per_peer_state.read().unwrap();
4875 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4876 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4877 let peer_state = &mut *peer_state_lock;
4878 let pending_msg_events = &mut peer_state.pending_msg_events;
4879 let counterparty_node_id = *counterparty_node_id;
4880 peer_state.channel_by_id.retain(|chan_id, phase| {
4882 ChannelPhase::Funded(chan) => {
4883 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4888 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4889 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4891 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4892 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4893 handle_errors.push((Err(err), counterparty_node_id));
4894 if needs_close { return false; }
4897 match chan.channel_update_status() {
4898 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4899 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4900 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4901 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4902 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4903 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4904 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4906 if n >= DISABLE_GOSSIP_TICKS {
4907 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4908 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4909 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4913 should_persist = NotifyOption::DoPersist;
4915 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4918 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4920 if n >= ENABLE_GOSSIP_TICKS {
4921 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4922 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4923 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4927 should_persist = NotifyOption::DoPersist;
4929 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4935 chan.context.maybe_expire_prev_config();
4937 if chan.should_disconnect_peer_awaiting_response() {
4938 let logger = WithChannelContext::from(&self.logger, &chan.context);
4939 log_debug!(logger, "Disconnecting peer {} due to not making any progress on channel {}",
4940 counterparty_node_id, chan_id);
4941 pending_msg_events.push(MessageSendEvent::HandleError {
4942 node_id: counterparty_node_id,
4943 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4944 msg: msgs::WarningMessage {
4945 channel_id: *chan_id,
4946 data: "Disconnecting due to timeout awaiting response".to_owned(),
4954 ChannelPhase::UnfundedInboundV1(chan) => {
4955 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4956 pending_msg_events, counterparty_node_id)
4958 ChannelPhase::UnfundedOutboundV1(chan) => {
4959 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4960 pending_msg_events, counterparty_node_id)
4965 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
4966 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
4967 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(*chan_id));
4968 log_error!(logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
4969 peer_state.pending_msg_events.push(
4970 events::MessageSendEvent::HandleError {
4971 node_id: counterparty_node_id,
4972 action: msgs::ErrorAction::SendErrorMessage {
4973 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
4979 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
4981 if peer_state.ok_to_remove(true) {
4982 pending_peers_awaiting_removal.push(counterparty_node_id);
4987 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4988 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4989 // of to that peer is later closed while still being disconnected (i.e. force closed),
4990 // we therefore need to remove the peer from `peer_state` separately.
4991 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4992 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4993 // negative effects on parallelism as much as possible.
4994 if pending_peers_awaiting_removal.len() > 0 {
4995 let mut per_peer_state = self.per_peer_state.write().unwrap();
4996 for counterparty_node_id in pending_peers_awaiting_removal {
4997 match per_peer_state.entry(counterparty_node_id) {
4998 hash_map::Entry::Occupied(entry) => {
4999 // Remove the entry if the peer is still disconnected and we still
5000 // have no channels to the peer.
5001 let remove_entry = {
5002 let peer_state = entry.get().lock().unwrap();
5003 peer_state.ok_to_remove(true)
5006 entry.remove_entry();
5009 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
5014 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
5015 if payment.htlcs.is_empty() {
5016 // This should be unreachable
5017 debug_assert!(false);
5020 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
5021 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
5022 // In this case we're not going to handle any timeouts of the parts here.
5023 // This condition determining whether the MPP is complete here must match
5024 // exactly the condition used in `process_pending_htlc_forwards`.
5025 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
5026 .fold(0, |total, htlc| total + htlc.sender_intended_value)
5029 } else if payment.htlcs.iter_mut().any(|htlc| {
5030 htlc.timer_ticks += 1;
5031 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
5033 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
5034 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
5041 for htlc_source in timed_out_mpp_htlcs.drain(..) {
5042 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
5043 let reason = HTLCFailReason::from_failure_code(23);
5044 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
5045 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
5048 for (err, counterparty_node_id) in handle_errors.drain(..) {
5049 let _ = handle_error!(self, err, counterparty_node_id);
5052 for shutdown_res in shutdown_channels {
5053 self.finish_close_channel(shutdown_res);
5056 #[cfg(feature = "std")]
5057 let duration_since_epoch = std::time::SystemTime::now()
5058 .duration_since(std::time::SystemTime::UNIX_EPOCH)
5059 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
5060 #[cfg(not(feature = "std"))]
5061 let duration_since_epoch = Duration::from_secs(
5062 self.highest_seen_timestamp.load(Ordering::Acquire).saturating_sub(7200) as u64
5065 self.pending_outbound_payments.remove_stale_payments(
5066 duration_since_epoch, &self.pending_events
5069 // Technically we don't need to do this here, but if we have holding cell entries in a
5070 // channel that need freeing, it's better to do that here and block a background task
5071 // than block the message queueing pipeline.
5072 if self.check_free_holding_cells() {
5073 should_persist = NotifyOption::DoPersist;
5080 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
5081 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
5082 /// along the path (including in our own channel on which we received it).
5084 /// Note that in some cases around unclean shutdown, it is possible the payment may have
5085 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
5086 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
5087 /// may have already been failed automatically by LDK if it was nearing its expiration time.
5089 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
5090 /// [`ChannelManager::claim_funds`]), you should still monitor for
5091 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
5092 /// startup during which time claims that were in-progress at shutdown may be replayed.
5093 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
5094 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
5097 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
5098 /// reason for the failure.
5100 /// See [`FailureCode`] for valid failure codes.
5101 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
5102 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5104 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
5105 if let Some(payment) = removed_source {
5106 for htlc in payment.htlcs {
5107 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
5108 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5109 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
5110 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5115 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
5116 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
5117 match failure_code {
5118 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
5119 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
5120 FailureCode::IncorrectOrUnknownPaymentDetails => {
5121 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5122 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5123 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
5125 FailureCode::InvalidOnionPayload(data) => {
5126 let fail_data = match data {
5127 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
5130 HTLCFailReason::reason(failure_code.into(), fail_data)
5135 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5136 /// that we want to return and a channel.
5138 /// This is for failures on the channel on which the HTLC was *received*, not failures
5140 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5141 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
5142 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
5143 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
5144 // an inbound SCID alias before the real SCID.
5145 let scid_pref = if chan.context.should_announce() {
5146 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
5148 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
5150 if let Some(scid) = scid_pref {
5151 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
5153 (0x4000|10, Vec::new())
5158 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5159 /// that we want to return and a channel.
5160 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5161 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
5162 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
5163 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
5164 if desired_err_code == 0x1000 | 20 {
5165 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
5166 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
5167 0u16.write(&mut enc).expect("Writes cannot fail");
5169 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
5170 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
5171 upd.write(&mut enc).expect("Writes cannot fail");
5172 (desired_err_code, enc.0)
5174 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
5175 // which means we really shouldn't have gotten a payment to be forwarded over this
5176 // channel yet, or if we did it's from a route hint. Either way, returning an error of
5177 // PERM|no_such_channel should be fine.
5178 (0x4000|10, Vec::new())
5182 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
5183 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
5184 // be surfaced to the user.
5185 fn fail_holding_cell_htlcs(
5186 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
5187 counterparty_node_id: &PublicKey
5189 let (failure_code, onion_failure_data) = {
5190 let per_peer_state = self.per_peer_state.read().unwrap();
5191 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5192 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5193 let peer_state = &mut *peer_state_lock;
5194 match peer_state.channel_by_id.entry(channel_id) {
5195 hash_map::Entry::Occupied(chan_phase_entry) => {
5196 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
5197 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
5199 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
5200 debug_assert!(false);
5201 (0x4000|10, Vec::new())
5204 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
5206 } else { (0x4000|10, Vec::new()) }
5209 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
5210 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
5211 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
5212 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
5216 /// Fails an HTLC backwards to the sender of it to us.
5217 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
5218 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
5219 // Ensure that no peer state channel storage lock is held when calling this function.
5220 // This ensures that future code doesn't introduce a lock-order requirement for
5221 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
5222 // this function with any `per_peer_state` peer lock acquired would.
5223 #[cfg(debug_assertions)]
5224 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
5225 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
5228 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
5229 //identify whether we sent it or not based on the (I presume) very different runtime
5230 //between the branches here. We should make this async and move it into the forward HTLCs
5233 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5234 // from block_connected which may run during initialization prior to the chain_monitor
5235 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
5237 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
5238 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
5239 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
5240 &self.pending_events, &self.logger)
5241 { self.push_pending_forwards_ev(); }
5243 HTLCSource::PreviousHopData(HTLCPreviousHopData {
5244 ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret,
5245 ref phantom_shared_secret, ref outpoint, ref blinded_failure, ..
5248 WithContext::from(&self.logger, None, Some(outpoint.to_channel_id())),
5249 "Failing {}HTLC with payment_hash {} backwards from us: {:?}",
5250 if blinded_failure.is_some() { "blinded " } else { "" }, &payment_hash, onion_error
5252 let err_packet = match blinded_failure {
5253 Some(BlindedFailure::FromIntroductionNode) => {
5254 let blinded_onion_error = HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32]);
5255 blinded_onion_error.get_encrypted_failure_packet(
5256 incoming_packet_shared_secret, phantom_shared_secret
5259 Some(BlindedFailure::FromBlindedNode) => todo!(),
5261 onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret)
5265 let mut push_forward_ev = false;
5266 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5267 if forward_htlcs.is_empty() {
5268 push_forward_ev = true;
5270 match forward_htlcs.entry(*short_channel_id) {
5271 hash_map::Entry::Occupied(mut entry) => {
5272 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
5274 hash_map::Entry::Vacant(entry) => {
5275 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
5278 mem::drop(forward_htlcs);
5279 if push_forward_ev { self.push_pending_forwards_ev(); }
5280 let mut pending_events = self.pending_events.lock().unwrap();
5281 pending_events.push_back((events::Event::HTLCHandlingFailed {
5282 prev_channel_id: outpoint.to_channel_id(),
5283 failed_next_destination: destination,
5289 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
5290 /// [`MessageSendEvent`]s needed to claim the payment.
5292 /// This method is guaranteed to ensure the payment has been claimed but only if the current
5293 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
5294 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
5295 /// successful. It will generally be available in the next [`process_pending_events`] call.
5297 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
5298 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
5299 /// event matches your expectation. If you fail to do so and call this method, you may provide
5300 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5302 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5303 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5304 /// [`claim_funds_with_known_custom_tlvs`].
5306 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5307 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5308 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5309 /// [`process_pending_events`]: EventsProvider::process_pending_events
5310 /// [`create_inbound_payment`]: Self::create_inbound_payment
5311 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5312 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5313 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5314 self.claim_payment_internal(payment_preimage, false);
5317 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5318 /// even type numbers.
5322 /// You MUST check you've understood all even TLVs before using this to
5323 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5325 /// [`claim_funds`]: Self::claim_funds
5326 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5327 self.claim_payment_internal(payment_preimage, true);
5330 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5331 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).to_byte_array());
5333 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5336 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5337 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5338 let mut receiver_node_id = self.our_network_pubkey;
5339 for htlc in payment.htlcs.iter() {
5340 if htlc.prev_hop.phantom_shared_secret.is_some() {
5341 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5342 .expect("Failed to get node_id for phantom node recipient");
5343 receiver_node_id = phantom_pubkey;
5348 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5349 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5350 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5351 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5352 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5354 if dup_purpose.is_some() {
5355 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5356 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5360 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5361 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5362 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5363 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5364 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5365 mem::drop(claimable_payments);
5366 for htlc in payment.htlcs {
5367 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5368 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5369 let receiver = HTLCDestination::FailedPayment { payment_hash };
5370 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5379 debug_assert!(!sources.is_empty());
5381 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5382 // and when we got here we need to check that the amount we're about to claim matches the
5383 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5384 // the MPP parts all have the same `total_msat`.
5385 let mut claimable_amt_msat = 0;
5386 let mut prev_total_msat = None;
5387 let mut expected_amt_msat = None;
5388 let mut valid_mpp = true;
5389 let mut errs = Vec::new();
5390 let per_peer_state = self.per_peer_state.read().unwrap();
5391 for htlc in sources.iter() {
5392 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5393 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5394 debug_assert!(false);
5398 prev_total_msat = Some(htlc.total_msat);
5400 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5401 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5402 debug_assert!(false);
5406 expected_amt_msat = htlc.total_value_received;
5407 claimable_amt_msat += htlc.value;
5409 mem::drop(per_peer_state);
5410 if sources.is_empty() || expected_amt_msat.is_none() {
5411 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5412 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5415 if claimable_amt_msat != expected_amt_msat.unwrap() {
5416 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5417 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5418 expected_amt_msat.unwrap(), claimable_amt_msat);
5422 for htlc in sources.drain(..) {
5423 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
5424 if let Err((pk, err)) = self.claim_funds_from_hop(
5425 htlc.prev_hop, payment_preimage,
5426 |_, definitely_duplicate| {
5427 debug_assert!(!definitely_duplicate, "We shouldn't claim duplicatively from a payment");
5428 Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash })
5431 if let msgs::ErrorAction::IgnoreError = err.err.action {
5432 // We got a temporary failure updating monitor, but will claim the
5433 // HTLC when the monitor updating is restored (or on chain).
5434 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
5435 log_error!(logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5436 } else { errs.push((pk, err)); }
5441 for htlc in sources.drain(..) {
5442 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5443 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5444 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5445 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5446 let receiver = HTLCDestination::FailedPayment { payment_hash };
5447 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5449 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5452 // Now we can handle any errors which were generated.
5453 for (counterparty_node_id, err) in errs.drain(..) {
5454 let res: Result<(), _> = Err(err);
5455 let _ = handle_error!(self, res, counterparty_node_id);
5459 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>, bool) -> Option<MonitorUpdateCompletionAction>>(&self,
5460 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5461 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5462 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5464 // If we haven't yet run background events assume we're still deserializing and shouldn't
5465 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5466 // `BackgroundEvent`s.
5467 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5469 // As we may call handle_monitor_update_completion_actions in rather rare cases, check that
5470 // the required mutexes are not held before we start.
5471 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5472 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5475 let per_peer_state = self.per_peer_state.read().unwrap();
5476 let chan_id = prev_hop.outpoint.to_channel_id();
5477 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5478 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5482 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5483 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5484 .map(|peer_mutex| peer_mutex.lock().unwrap())
5487 if peer_state_opt.is_some() {
5488 let mut peer_state_lock = peer_state_opt.unwrap();
5489 let peer_state = &mut *peer_state_lock;
5490 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5491 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5492 let counterparty_node_id = chan.context.get_counterparty_node_id();
5493 let logger = WithChannelContext::from(&self.logger, &chan.context);
5494 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &&logger);
5497 UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } => {
5498 if let Some(action) = completion_action(Some(htlc_value_msat), false) {
5499 log_trace!(logger, "Tracking monitor update completion action for channel {}: {:?}",
5501 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5504 handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5505 peer_state, per_peer_state, chan);
5507 // If we're running during init we cannot update a monitor directly -
5508 // they probably haven't actually been loaded yet. Instead, push the
5509 // monitor update as a background event.
5510 self.pending_background_events.lock().unwrap().push(
5511 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5512 counterparty_node_id,
5513 funding_txo: prev_hop.outpoint,
5514 update: monitor_update.clone(),
5518 UpdateFulfillCommitFetch::DuplicateClaim {} => {
5519 let action = if let Some(action) = completion_action(None, true) {
5524 mem::drop(peer_state_lock);
5526 log_trace!(logger, "Completing monitor update completion action for channel {} as claim was redundant: {:?}",
5528 let (node_id, funding_outpoint, blocker) =
5529 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5530 downstream_counterparty_node_id: node_id,
5531 downstream_funding_outpoint: funding_outpoint,
5532 blocking_action: blocker,
5534 (node_id, funding_outpoint, blocker)
5536 debug_assert!(false,
5537 "Duplicate claims should always free another channel immediately");
5540 if let Some(peer_state_mtx) = per_peer_state.get(&node_id) {
5541 let mut peer_state = peer_state_mtx.lock().unwrap();
5542 if let Some(blockers) = peer_state
5543 .actions_blocking_raa_monitor_updates
5544 .get_mut(&funding_outpoint.to_channel_id())
5546 let mut found_blocker = false;
5547 blockers.retain(|iter| {
5548 // Note that we could actually be blocked, in
5549 // which case we need to only remove the one
5550 // blocker which was added duplicatively.
5551 let first_blocker = !found_blocker;
5552 if *iter == blocker { found_blocker = true; }
5553 *iter != blocker || !first_blocker
5555 debug_assert!(found_blocker);
5558 debug_assert!(false);
5567 let preimage_update = ChannelMonitorUpdate {
5568 update_id: CLOSED_CHANNEL_UPDATE_ID,
5569 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5575 // We update the ChannelMonitor on the backward link, after
5576 // receiving an `update_fulfill_htlc` from the forward link.
5577 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5578 if update_res != ChannelMonitorUpdateStatus::Completed {
5579 // TODO: This needs to be handled somehow - if we receive a monitor update
5580 // with a preimage we *must* somehow manage to propagate it to the upstream
5581 // channel, or we must have an ability to receive the same event and try
5582 // again on restart.
5583 log_error!(WithContext::from(&self.logger, None, Some(prev_hop.outpoint.to_channel_id())), "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5584 payment_preimage, update_res);
5587 // If we're running during init we cannot update a monitor directly - they probably
5588 // haven't actually been loaded yet. Instead, push the monitor update as a background
5590 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5591 // channel is already closed) we need to ultimately handle the monitor update
5592 // completion action only after we've completed the monitor update. This is the only
5593 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5594 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5595 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5596 // complete the monitor update completion action from `completion_action`.
5597 self.pending_background_events.lock().unwrap().push(
5598 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5599 prev_hop.outpoint, preimage_update,
5602 // Note that we do process the completion action here. This totally could be a
5603 // duplicate claim, but we have no way of knowing without interrogating the
5604 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5605 // generally always allowed to be duplicative (and it's specifically noted in
5606 // `PaymentForwarded`).
5607 self.handle_monitor_update_completion_actions(completion_action(None, false));
5611 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5612 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5615 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5616 forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, startup_replay: bool,
5617 next_channel_counterparty_node_id: Option<PublicKey>, next_channel_outpoint: OutPoint
5620 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5621 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5622 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5623 if let Some(pubkey) = next_channel_counterparty_node_id {
5624 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5626 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5627 channel_funding_outpoint: next_channel_outpoint,
5628 counterparty_node_id: path.hops[0].pubkey,
5630 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5631 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5634 HTLCSource::PreviousHopData(hop_data) => {
5635 let prev_outpoint = hop_data.outpoint;
5636 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5637 #[cfg(debug_assertions)]
5638 let claiming_chan_funding_outpoint = hop_data.outpoint;
5639 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5640 |htlc_claim_value_msat, definitely_duplicate| {
5641 let chan_to_release =
5642 if let Some(node_id) = next_channel_counterparty_node_id {
5643 Some((node_id, next_channel_outpoint, completed_blocker))
5645 // We can only get `None` here if we are processing a
5646 // `ChannelMonitor`-originated event, in which case we
5647 // don't care about ensuring we wake the downstream
5648 // channel's monitor updating - the channel is already
5653 if definitely_duplicate && startup_replay {
5654 // On startup we may get redundant claims which are related to
5655 // monitor updates still in flight. In that case, we shouldn't
5656 // immediately free, but instead let that monitor update complete
5657 // in the background.
5658 #[cfg(debug_assertions)] {
5659 let background_events = self.pending_background_events.lock().unwrap();
5660 // There should be a `BackgroundEvent` pending...
5661 assert!(background_events.iter().any(|ev| {
5663 // to apply a monitor update that blocked the claiming channel,
5664 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5665 funding_txo, update, ..
5667 if *funding_txo == claiming_chan_funding_outpoint {
5668 assert!(update.updates.iter().any(|upd|
5669 if let ChannelMonitorUpdateStep::PaymentPreimage {
5670 payment_preimage: update_preimage
5672 payment_preimage == *update_preimage
5678 // or the channel we'd unblock is already closed,
5679 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup(
5680 (funding_txo, monitor_update)
5682 if *funding_txo == next_channel_outpoint {
5683 assert_eq!(monitor_update.updates.len(), 1);
5685 monitor_update.updates[0],
5686 ChannelMonitorUpdateStep::ChannelForceClosed { .. }
5691 // or the monitor update has completed and will unblock
5692 // immediately once we get going.
5693 BackgroundEvent::MonitorUpdatesComplete {
5696 *channel_id == claiming_chan_funding_outpoint.to_channel_id(),
5698 }), "{:?}", *background_events);
5701 } else if definitely_duplicate {
5702 if let Some(other_chan) = chan_to_release {
5703 Some(MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5704 downstream_counterparty_node_id: other_chan.0,
5705 downstream_funding_outpoint: other_chan.1,
5706 blocking_action: other_chan.2,
5710 let fee_earned_msat = if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5711 if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5712 Some(claimed_htlc_value - forwarded_htlc_value)
5715 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5716 event: events::Event::PaymentForwarded {
5718 claim_from_onchain_tx: from_onchain,
5719 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5720 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5721 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5723 downstream_counterparty_and_funding_outpoint: chan_to_release,
5727 if let Err((pk, err)) = res {
5728 let result: Result<(), _> = Err(err);
5729 let _ = handle_error!(self, result, pk);
5735 /// Gets the node_id held by this ChannelManager
5736 pub fn get_our_node_id(&self) -> PublicKey {
5737 self.our_network_pubkey.clone()
5740 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5741 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5742 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5743 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
5745 for action in actions.into_iter() {
5747 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5748 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5749 if let Some(ClaimingPayment {
5751 payment_purpose: purpose,
5754 sender_intended_value: sender_intended_total_msat,
5756 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5760 receiver_node_id: Some(receiver_node_id),
5762 sender_intended_total_msat,
5766 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5767 event, downstream_counterparty_and_funding_outpoint
5769 self.pending_events.lock().unwrap().push_back((event, None));
5770 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5771 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5774 MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5775 downstream_counterparty_node_id, downstream_funding_outpoint, blocking_action,
5777 self.handle_monitor_update_release(
5778 downstream_counterparty_node_id,
5779 downstream_funding_outpoint,
5780 Some(blocking_action),
5787 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5788 /// update completion.
5789 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5790 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5791 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5792 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5793 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5794 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5795 let logger = WithChannelContext::from(&self.logger, &channel.context);
5796 log_trace!(logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5797 &channel.context.channel_id(),
5798 if raa.is_some() { "an" } else { "no" },
5799 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5800 if funding_broadcastable.is_some() { "" } else { "not " },
5801 if channel_ready.is_some() { "sending" } else { "without" },
5802 if announcement_sigs.is_some() { "sending" } else { "without" });
5804 let mut htlc_forwards = None;
5806 let counterparty_node_id = channel.context.get_counterparty_node_id();
5807 if !pending_forwards.is_empty() {
5808 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5809 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5812 if let Some(msg) = channel_ready {
5813 send_channel_ready!(self, pending_msg_events, channel, msg);
5815 if let Some(msg) = announcement_sigs {
5816 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5817 node_id: counterparty_node_id,
5822 macro_rules! handle_cs { () => {
5823 if let Some(update) = commitment_update {
5824 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5825 node_id: counterparty_node_id,
5830 macro_rules! handle_raa { () => {
5831 if let Some(revoke_and_ack) = raa {
5832 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5833 node_id: counterparty_node_id,
5834 msg: revoke_and_ack,
5839 RAACommitmentOrder::CommitmentFirst => {
5843 RAACommitmentOrder::RevokeAndACKFirst => {
5849 if let Some(tx) = funding_broadcastable {
5850 log_info!(logger, "Broadcasting funding transaction with txid {}", tx.txid());
5851 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5855 let mut pending_events = self.pending_events.lock().unwrap();
5856 emit_channel_pending_event!(pending_events, channel);
5857 emit_channel_ready_event!(pending_events, channel);
5863 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5864 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5866 let counterparty_node_id = match counterparty_node_id {
5867 Some(cp_id) => cp_id.clone(),
5869 // TODO: Once we can rely on the counterparty_node_id from the
5870 // monitor event, this and the id_to_peer map should be removed.
5871 let id_to_peer = self.id_to_peer.lock().unwrap();
5872 match id_to_peer.get(&funding_txo.to_channel_id()) {
5873 Some(cp_id) => cp_id.clone(),
5878 let per_peer_state = self.per_peer_state.read().unwrap();
5879 let mut peer_state_lock;
5880 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5881 if peer_state_mutex_opt.is_none() { return }
5882 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5883 let peer_state = &mut *peer_state_lock;
5885 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5888 let update_actions = peer_state.monitor_update_blocked_actions
5889 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5890 mem::drop(peer_state_lock);
5891 mem::drop(per_peer_state);
5892 self.handle_monitor_update_completion_actions(update_actions);
5895 let remaining_in_flight =
5896 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5897 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5900 let logger = WithChannelContext::from(&self.logger, &channel.context);
5901 log_trace!(logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5902 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5903 remaining_in_flight);
5904 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5907 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5910 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5912 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5913 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5916 /// The `user_channel_id` parameter will be provided back in
5917 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5918 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5920 /// Note that this method will return an error and reject the channel, if it requires support
5921 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5922 /// used to accept such channels.
5924 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5925 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5926 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5927 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5930 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5931 /// it as confirmed immediately.
5933 /// The `user_channel_id` parameter will be provided back in
5934 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5935 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5937 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5938 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5940 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5941 /// transaction and blindly assumes that it will eventually confirm.
5943 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5944 /// does not pay to the correct script the correct amount, *you will lose funds*.
5946 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5947 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5948 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5949 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5952 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5953 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5955 let peers_without_funded_channels =
5956 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5957 let per_peer_state = self.per_peer_state.read().unwrap();
5958 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5959 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5960 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5961 let peer_state = &mut *peer_state_lock;
5962 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5964 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
5965 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
5966 // that we can delay allocating the SCID until after we're sure that the checks below will
5968 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
5969 Some(unaccepted_channel) => {
5970 let best_block_height = self.best_block.read().unwrap().height();
5971 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5972 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
5973 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
5974 &self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
5976 _ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
5980 // This should have been correctly configured by the call to InboundV1Channel::new.
5981 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
5982 } else if channel.context.get_channel_type().requires_zero_conf() {
5983 let send_msg_err_event = events::MessageSendEvent::HandleError {
5984 node_id: channel.context.get_counterparty_node_id(),
5985 action: msgs::ErrorAction::SendErrorMessage{
5986 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5989 peer_state.pending_msg_events.push(send_msg_err_event);
5990 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5992 // If this peer already has some channels, a new channel won't increase our number of peers
5993 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5994 // channels per-peer we can accept channels from a peer with existing ones.
5995 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5996 let send_msg_err_event = events::MessageSendEvent::HandleError {
5997 node_id: channel.context.get_counterparty_node_id(),
5998 action: msgs::ErrorAction::SendErrorMessage{
5999 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
6002 peer_state.pending_msg_events.push(send_msg_err_event);
6003 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
6007 // Now that we know we have a channel, assign an outbound SCID alias.
6008 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6009 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6011 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6012 node_id: channel.context.get_counterparty_node_id(),
6013 msg: channel.accept_inbound_channel(),
6016 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
6021 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
6022 /// or 0-conf channels.
6024 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
6025 /// non-0-conf channels we have with the peer.
6026 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
6027 where Filter: Fn(&PeerState<SP>) -> bool {
6028 let mut peers_without_funded_channels = 0;
6029 let best_block_height = self.best_block.read().unwrap().height();
6031 let peer_state_lock = self.per_peer_state.read().unwrap();
6032 for (_, peer_mtx) in peer_state_lock.iter() {
6033 let peer = peer_mtx.lock().unwrap();
6034 if !maybe_count_peer(&*peer) { continue; }
6035 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
6036 if num_unfunded_channels == peer.total_channel_count() {
6037 peers_without_funded_channels += 1;
6041 return peers_without_funded_channels;
6044 fn unfunded_channel_count(
6045 peer: &PeerState<SP>, best_block_height: u32
6047 let mut num_unfunded_channels = 0;
6048 for (_, phase) in peer.channel_by_id.iter() {
6050 ChannelPhase::Funded(chan) => {
6051 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
6052 // which have not yet had any confirmations on-chain.
6053 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
6054 chan.context.get_funding_tx_confirmations(best_block_height) == 0
6056 num_unfunded_channels += 1;
6059 ChannelPhase::UnfundedInboundV1(chan) => {
6060 if chan.context.minimum_depth().unwrap_or(1) != 0 {
6061 num_unfunded_channels += 1;
6064 ChannelPhase::UnfundedOutboundV1(_) => {
6065 // Outbound channels don't contribute to the unfunded count in the DoS context.
6070 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
6073 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
6074 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6075 // likely to be lost on restart!
6076 if msg.chain_hash != self.chain_hash {
6077 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
6080 if !self.default_configuration.accept_inbound_channels {
6081 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6084 // Get the number of peers with channels, but without funded ones. We don't care too much
6085 // about peers that never open a channel, so we filter by peers that have at least one
6086 // channel, and then limit the number of those with unfunded channels.
6087 let channeled_peers_without_funding =
6088 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
6090 let per_peer_state = self.per_peer_state.read().unwrap();
6091 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6093 debug_assert!(false);
6094 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id.clone())
6096 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6097 let peer_state = &mut *peer_state_lock;
6099 // If this peer already has some channels, a new channel won't increase our number of peers
6100 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6101 // channels per-peer we can accept channels from a peer with existing ones.
6102 if peer_state.total_channel_count() == 0 &&
6103 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
6104 !self.default_configuration.manually_accept_inbound_channels
6106 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6107 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
6108 msg.temporary_channel_id.clone()));
6111 let best_block_height = self.best_block.read().unwrap().height();
6112 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
6113 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6114 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
6115 msg.temporary_channel_id.clone()));
6118 let channel_id = msg.temporary_channel_id;
6119 let channel_exists = peer_state.has_channel(&channel_id);
6121 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
6124 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
6125 if self.default_configuration.manually_accept_inbound_channels {
6126 let mut pending_events = self.pending_events.lock().unwrap();
6127 pending_events.push_back((events::Event::OpenChannelRequest {
6128 temporary_channel_id: msg.temporary_channel_id.clone(),
6129 counterparty_node_id: counterparty_node_id.clone(),
6130 funding_satoshis: msg.funding_satoshis,
6131 push_msat: msg.push_msat,
6132 channel_type: msg.channel_type.clone().unwrap(),
6134 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
6135 open_channel_msg: msg.clone(),
6136 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
6141 // Otherwise create the channel right now.
6142 let mut random_bytes = [0u8; 16];
6143 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
6144 let user_channel_id = u128::from_be_bytes(random_bytes);
6145 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6146 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
6147 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
6150 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
6155 let channel_type = channel.context.get_channel_type();
6156 if channel_type.requires_zero_conf() {
6157 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6159 if channel_type.requires_anchors_zero_fee_htlc_tx() {
6160 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
6163 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6164 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6166 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6167 node_id: counterparty_node_id.clone(),
6168 msg: channel.accept_inbound_channel(),
6170 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
6174 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
6175 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6176 // likely to be lost on restart!
6177 let (value, output_script, user_id) = {
6178 let per_peer_state = self.per_peer_state.read().unwrap();
6179 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6181 debug_assert!(false);
6182 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)
6184 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6185 let peer_state = &mut *peer_state_lock;
6186 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
6187 hash_map::Entry::Occupied(mut phase) => {
6188 match phase.get_mut() {
6189 ChannelPhase::UnfundedOutboundV1(chan) => {
6190 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
6191 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
6194 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected accept_channel message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
6198 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
6201 let mut pending_events = self.pending_events.lock().unwrap();
6202 pending_events.push_back((events::Event::FundingGenerationReady {
6203 temporary_channel_id: msg.temporary_channel_id,
6204 counterparty_node_id: *counterparty_node_id,
6205 channel_value_satoshis: value,
6207 user_channel_id: user_id,
6212 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
6213 let best_block = *self.best_block.read().unwrap();
6215 let per_peer_state = self.per_peer_state.read().unwrap();
6216 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6218 debug_assert!(false);
6219 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)
6222 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6223 let peer_state = &mut *peer_state_lock;
6224 let (chan, funding_msg_opt, monitor) =
6225 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
6226 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
6227 let logger = WithChannelContext::from(&self.logger, &inbound_chan.context);
6228 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &&logger) {
6230 Err((mut inbound_chan, err)) => {
6231 // We've already removed this inbound channel from the map in `PeerState`
6232 // above so at this point we just need to clean up any lingering entries
6233 // concerning this channel as it is safe to do so.
6234 update_maps_on_chan_removal!(self, &inbound_chan.context);
6235 let user_id = inbound_chan.context.get_user_id();
6236 let shutdown_res = inbound_chan.context.force_shutdown(false);
6237 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
6238 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
6242 Some(ChannelPhase::Funded(_)) | Some(ChannelPhase::UnfundedOutboundV1(_)) => {
6243 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
6245 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))
6248 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
6249 hash_map::Entry::Occupied(_) => {
6250 Err(MsgHandleErrInternal::send_err_msg_no_close(
6251 "Already had channel with the new channel_id".to_owned(),
6252 chan.context.channel_id()
6255 hash_map::Entry::Vacant(e) => {
6256 let mut id_to_peer_lock = self.id_to_peer.lock().unwrap();
6257 match id_to_peer_lock.entry(chan.context.channel_id()) {
6258 hash_map::Entry::Occupied(_) => {
6259 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6260 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
6261 chan.context.channel_id()))
6263 hash_map::Entry::Vacant(i_e) => {
6264 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
6265 if let Ok(persist_state) = monitor_res {
6266 i_e.insert(chan.context.get_counterparty_node_id());
6267 mem::drop(id_to_peer_lock);
6269 // There's no problem signing a counterparty's funding transaction if our monitor
6270 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
6271 // accepted payment from yet. We do, however, need to wait to send our channel_ready
6272 // until we have persisted our monitor.
6273 if let Some(msg) = funding_msg_opt {
6274 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6275 node_id: counterparty_node_id.clone(),
6280 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
6281 handle_new_monitor_update!(self, persist_state, peer_state_lock, peer_state,
6282 per_peer_state, chan, INITIAL_MONITOR);
6284 unreachable!("This must be a funded channel as we just inserted it.");
6288 let logger = WithChannelContext::from(&self.logger, &chan.context);
6289 log_error!(logger, "Persisting initial ChannelMonitor failed, implying the funding outpoint was duplicated");
6290 let channel_id = match funding_msg_opt {
6291 Some(msg) => msg.channel_id,
6292 None => chan.context.channel_id(),
6294 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6295 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
6304 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
6305 let best_block = *self.best_block.read().unwrap();
6306 let per_peer_state = self.per_peer_state.read().unwrap();
6307 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6309 debug_assert!(false);
6310 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6313 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6314 let peer_state = &mut *peer_state_lock;
6315 match peer_state.channel_by_id.entry(msg.channel_id) {
6316 hash_map::Entry::Occupied(chan_phase_entry) => {
6317 if matches!(chan_phase_entry.get(), ChannelPhase::UnfundedOutboundV1(_)) {
6318 let chan = if let ChannelPhase::UnfundedOutboundV1(chan) = chan_phase_entry.remove() { chan } else { unreachable!() };
6319 let logger = WithContext::from(
6321 Some(chan.context.get_counterparty_node_id()),
6322 Some(chan.context.channel_id())
6325 chan.funding_signed(&msg, best_block, &self.signer_provider, &&logger);
6327 Ok((chan, monitor)) => {
6328 if let Ok(persist_status) = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor) {
6329 // We really should be able to insert here without doing a second
6330 // lookup, but sadly rust stdlib doesn't currently allow keeping
6331 // the original Entry around with the value removed.
6332 let mut chan = peer_state.channel_by_id.entry(msg.channel_id).or_insert(ChannelPhase::Funded(chan));
6333 if let ChannelPhase::Funded(ref mut chan) = &mut chan {
6334 handle_new_monitor_update!(self, persist_status, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
6335 } else { unreachable!(); }
6338 let e = ChannelError::Close("Channel funding outpoint was a duplicate".to_owned());
6339 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::Funded(chan), &msg.channel_id).1);
6343 debug_assert!(matches!(e, ChannelError::Close(_)),
6344 "We don't have a channel anymore, so the error better have expected close");
6345 // We've already removed this outbound channel from the map in
6346 // `PeerState` above so at this point we just need to clean up any
6347 // lingering entries concerning this channel as it is safe to do so.
6348 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::UnfundedOutboundV1(chan), &msg.channel_id).1);
6352 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
6355 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
6359 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
6360 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6361 // closing a channel), so any changes are likely to be lost on restart!
6362 let per_peer_state = self.per_peer_state.read().unwrap();
6363 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6365 debug_assert!(false);
6366 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6368 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6369 let peer_state = &mut *peer_state_lock;
6370 match peer_state.channel_by_id.entry(msg.channel_id) {
6371 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6372 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6373 let logger = WithChannelContext::from(&self.logger, &chan.context);
6374 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
6375 self.chain_hash, &self.default_configuration, &self.best_block.read().unwrap(), &&logger), chan_phase_entry);
6376 if let Some(announcement_sigs) = announcement_sigs_opt {
6377 log_trace!(logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
6378 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6379 node_id: counterparty_node_id.clone(),
6380 msg: announcement_sigs,
6382 } else if chan.context.is_usable() {
6383 // If we're sending an announcement_signatures, we'll send the (public)
6384 // channel_update after sending a channel_announcement when we receive our
6385 // counterparty's announcement_signatures. Thus, we only bother to send a
6386 // channel_update here if the channel is not public, i.e. we're not sending an
6387 // announcement_signatures.
6388 log_trace!(logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
6389 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6390 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6391 node_id: counterparty_node_id.clone(),
6398 let mut pending_events = self.pending_events.lock().unwrap();
6399 emit_channel_ready_event!(pending_events, chan);
6404 try_chan_phase_entry!(self, Err(ChannelError::Close(
6405 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
6408 hash_map::Entry::Vacant(_) => {
6409 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))
6414 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
6415 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
6416 let mut finish_shutdown = None;
6418 let per_peer_state = self.per_peer_state.read().unwrap();
6419 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6421 debug_assert!(false);
6422 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6424 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6425 let peer_state = &mut *peer_state_lock;
6426 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6427 let phase = chan_phase_entry.get_mut();
6429 ChannelPhase::Funded(chan) => {
6430 if !chan.received_shutdown() {
6431 let logger = WithChannelContext::from(&self.logger, &chan.context);
6432 log_info!(logger, "Received a shutdown message from our counterparty for channel {}{}.",
6434 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
6437 let funding_txo_opt = chan.context.get_funding_txo();
6438 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
6439 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
6440 dropped_htlcs = htlcs;
6442 if let Some(msg) = shutdown {
6443 // We can send the `shutdown` message before updating the `ChannelMonitor`
6444 // here as we don't need the monitor update to complete until we send a
6445 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
6446 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6447 node_id: *counterparty_node_id,
6451 // Update the monitor with the shutdown script if necessary.
6452 if let Some(monitor_update) = monitor_update_opt {
6453 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
6454 peer_state_lock, peer_state, per_peer_state, chan);
6457 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6458 let context = phase.context_mut();
6459 let logger = WithChannelContext::from(&self.logger, context);
6460 log_error!(logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6461 self.issue_channel_close_events(&context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
6462 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6463 finish_shutdown = Some(chan.context_mut().force_shutdown(false));
6467 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))
6470 for htlc_source in dropped_htlcs.drain(..) {
6471 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6472 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6473 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6475 if let Some(shutdown_res) = finish_shutdown {
6476 self.finish_close_channel(shutdown_res);
6482 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6483 let per_peer_state = self.per_peer_state.read().unwrap();
6484 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6486 debug_assert!(false);
6487 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6489 let (tx, chan_option, shutdown_result) = {
6490 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6491 let peer_state = &mut *peer_state_lock;
6492 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6493 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6494 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6495 let (closing_signed, tx, shutdown_result) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6496 debug_assert_eq!(shutdown_result.is_some(), chan.is_shutdown());
6497 if let Some(msg) = closing_signed {
6498 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6499 node_id: counterparty_node_id.clone(),
6504 // We're done with this channel, we've got a signed closing transaction and
6505 // will send the closing_signed back to the remote peer upon return. This
6506 // also implies there are no pending HTLCs left on the channel, so we can
6507 // fully delete it from tracking (the channel monitor is still around to
6508 // watch for old state broadcasts)!
6509 (tx, Some(remove_channel_phase!(self, chan_phase_entry)), shutdown_result)
6510 } else { (tx, None, shutdown_result) }
6512 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6513 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6516 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))
6519 if let Some(broadcast_tx) = tx {
6520 let channel_id = chan_option.as_ref().map(|channel| channel.context().channel_id());
6521 log_info!(WithContext::from(&self.logger, Some(*counterparty_node_id), channel_id), "Broadcasting {}", log_tx!(broadcast_tx));
6522 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6524 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6525 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6526 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6527 let peer_state = &mut *peer_state_lock;
6528 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6532 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6534 mem::drop(per_peer_state);
6535 if let Some(shutdown_result) = shutdown_result {
6536 self.finish_close_channel(shutdown_result);
6541 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6542 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6543 //determine the state of the payment based on our response/if we forward anything/the time
6544 //we take to respond. We should take care to avoid allowing such an attack.
6546 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6547 //us repeatedly garbled in different ways, and compare our error messages, which are
6548 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6549 //but we should prevent it anyway.
6551 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6552 // closing a channel), so any changes are likely to be lost on restart!
6554 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
6555 let per_peer_state = self.per_peer_state.read().unwrap();
6556 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6558 debug_assert!(false);
6559 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6561 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6562 let peer_state = &mut *peer_state_lock;
6563 match peer_state.channel_by_id.entry(msg.channel_id) {
6564 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6565 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6566 let pending_forward_info = match decoded_hop_res {
6567 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6568 self.construct_pending_htlc_status(
6569 msg, counterparty_node_id, shared_secret, next_hop,
6570 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
6572 Err(e) => PendingHTLCStatus::Fail(e)
6574 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6575 // If the update_add is completely bogus, the call will Err and we will close,
6576 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6577 // want to reject the new HTLC and fail it backwards instead of forwarding.
6578 match pending_forward_info {
6579 PendingHTLCStatus::Forward(PendingHTLCInfo {
6580 ref incoming_shared_secret, ref routing, ..
6582 let reason = if routing.blinded_failure().is_some() {
6583 HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32])
6584 } else if (error_code & 0x1000) != 0 {
6585 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6586 HTLCFailReason::reason(real_code, error_data)
6588 HTLCFailReason::from_failure_code(error_code)
6589 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6590 let msg = msgs::UpdateFailHTLC {
6591 channel_id: msg.channel_id,
6592 htlc_id: msg.htlc_id,
6595 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6597 _ => pending_forward_info
6600 let logger = WithChannelContext::from(&self.logger, &chan.context);
6601 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &&logger), chan_phase_entry);
6603 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6604 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6607 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))
6612 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6614 let (htlc_source, forwarded_htlc_value) = {
6615 let per_peer_state = self.per_peer_state.read().unwrap();
6616 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6618 debug_assert!(false);
6619 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6621 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6622 let peer_state = &mut *peer_state_lock;
6623 match peer_state.channel_by_id.entry(msg.channel_id) {
6624 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6625 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6626 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6627 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6628 let logger = WithChannelContext::from(&self.logger, &chan.context);
6630 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
6632 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6633 .or_insert_with(Vec::new)
6634 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6636 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6637 // entry here, even though we *do* need to block the next RAA monitor update.
6638 // We do this instead in the `claim_funds_internal` by attaching a
6639 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6640 // outbound HTLC is claimed. This is guaranteed to all complete before we
6641 // process the RAA as messages are processed from single peers serially.
6642 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6645 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6646 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6649 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))
6652 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, false, Some(*counterparty_node_id), funding_txo);
6656 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6657 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6658 // closing a channel), so any changes are likely to be lost on restart!
6659 let per_peer_state = self.per_peer_state.read().unwrap();
6660 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6662 debug_assert!(false);
6663 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6665 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6666 let peer_state = &mut *peer_state_lock;
6667 match peer_state.channel_by_id.entry(msg.channel_id) {
6668 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6669 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6670 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6672 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6673 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6676 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))
6681 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6682 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6683 // closing a channel), so any changes are likely to be lost on restart!
6684 let per_peer_state = self.per_peer_state.read().unwrap();
6685 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6687 debug_assert!(false);
6688 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6690 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6691 let peer_state = &mut *peer_state_lock;
6692 match peer_state.channel_by_id.entry(msg.channel_id) {
6693 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6694 if (msg.failure_code & 0x8000) == 0 {
6695 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6696 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6698 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6699 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);
6701 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6702 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6706 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))
6710 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6711 let per_peer_state = self.per_peer_state.read().unwrap();
6712 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6714 debug_assert!(false);
6715 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6717 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6718 let peer_state = &mut *peer_state_lock;
6719 match peer_state.channel_by_id.entry(msg.channel_id) {
6720 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6721 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6722 let logger = WithChannelContext::from(&self.logger, &chan.context);
6723 let funding_txo = chan.context.get_funding_txo();
6724 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &&logger), chan_phase_entry);
6725 if let Some(monitor_update) = monitor_update_opt {
6726 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6727 peer_state, per_peer_state, chan);
6731 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6732 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6735 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))
6740 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6741 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6742 let mut push_forward_event = false;
6743 let mut new_intercept_events = VecDeque::new();
6744 let mut failed_intercept_forwards = Vec::new();
6745 if !pending_forwards.is_empty() {
6746 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6747 let scid = match forward_info.routing {
6748 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6749 PendingHTLCRouting::Receive { .. } => 0,
6750 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6752 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6753 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6755 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6756 let forward_htlcs_empty = forward_htlcs.is_empty();
6757 match forward_htlcs.entry(scid) {
6758 hash_map::Entry::Occupied(mut entry) => {
6759 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6760 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6762 hash_map::Entry::Vacant(entry) => {
6763 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6764 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.chain_hash)
6766 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).to_byte_array());
6767 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6768 match pending_intercepts.entry(intercept_id) {
6769 hash_map::Entry::Vacant(entry) => {
6770 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6771 requested_next_hop_scid: scid,
6772 payment_hash: forward_info.payment_hash,
6773 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6774 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6777 entry.insert(PendingAddHTLCInfo {
6778 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6780 hash_map::Entry::Occupied(_) => {
6781 let logger = WithContext::from(&self.logger, None, Some(prev_funding_outpoint.to_channel_id()));
6782 log_info!(logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6783 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6784 short_channel_id: prev_short_channel_id,
6785 user_channel_id: Some(prev_user_channel_id),
6786 outpoint: prev_funding_outpoint,
6787 htlc_id: prev_htlc_id,
6788 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6789 phantom_shared_secret: None,
6790 blinded_failure: forward_info.routing.blinded_failure(),
6793 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6794 HTLCFailReason::from_failure_code(0x4000 | 10),
6795 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6800 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6801 // payments are being processed.
6802 if forward_htlcs_empty {
6803 push_forward_event = true;
6805 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6806 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6813 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6814 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6817 if !new_intercept_events.is_empty() {
6818 let mut events = self.pending_events.lock().unwrap();
6819 events.append(&mut new_intercept_events);
6821 if push_forward_event { self.push_pending_forwards_ev() }
6825 fn push_pending_forwards_ev(&self) {
6826 let mut pending_events = self.pending_events.lock().unwrap();
6827 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6828 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6829 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6831 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6832 // events is done in batches and they are not removed until we're done processing each
6833 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6834 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6835 // payments will need an additional forwarding event before being claimed to make them look
6836 // real by taking more time.
6837 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6838 pending_events.push_back((Event::PendingHTLCsForwardable {
6839 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6844 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6845 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6846 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6847 /// the [`ChannelMonitorUpdate`] in question.
6848 fn raa_monitor_updates_held(&self,
6849 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6850 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6852 actions_blocking_raa_monitor_updates
6853 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6854 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6855 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6856 channel_funding_outpoint,
6857 counterparty_node_id,
6862 #[cfg(any(test, feature = "_test_utils"))]
6863 pub(crate) fn test_raa_monitor_updates_held(&self,
6864 counterparty_node_id: PublicKey, channel_id: ChannelId
6866 let per_peer_state = self.per_peer_state.read().unwrap();
6867 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6868 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6869 let peer_state = &mut *peer_state_lck;
6871 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
6872 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6873 chan.context().get_funding_txo().unwrap(), counterparty_node_id);
6879 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6880 let htlcs_to_fail = {
6881 let per_peer_state = self.per_peer_state.read().unwrap();
6882 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6884 debug_assert!(false);
6885 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6886 }).map(|mtx| mtx.lock().unwrap())?;
6887 let peer_state = &mut *peer_state_lock;
6888 match peer_state.channel_by_id.entry(msg.channel_id) {
6889 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6890 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6891 let logger = WithChannelContext::from(&self.logger, &chan.context);
6892 let funding_txo_opt = chan.context.get_funding_txo();
6893 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6894 self.raa_monitor_updates_held(
6895 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6896 *counterparty_node_id)
6898 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
6899 chan.revoke_and_ack(&msg, &self.fee_estimator, &&logger, mon_update_blocked), chan_phase_entry);
6900 if let Some(monitor_update) = monitor_update_opt {
6901 let funding_txo = funding_txo_opt
6902 .expect("Funding outpoint must have been set for RAA handling to succeed");
6903 handle_new_monitor_update!(self, funding_txo, monitor_update,
6904 peer_state_lock, peer_state, per_peer_state, chan);
6908 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6909 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
6912 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))
6915 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6919 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6920 let per_peer_state = self.per_peer_state.read().unwrap();
6921 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6923 debug_assert!(false);
6924 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6926 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6927 let peer_state = &mut *peer_state_lock;
6928 match peer_state.channel_by_id.entry(msg.channel_id) {
6929 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6930 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6931 let logger = WithChannelContext::from(&self.logger, &chan.context);
6932 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &&logger), chan_phase_entry);
6934 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6935 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
6938 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))
6943 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6944 let per_peer_state = self.per_peer_state.read().unwrap();
6945 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6947 debug_assert!(false);
6948 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6950 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6951 let peer_state = &mut *peer_state_lock;
6952 match peer_state.channel_by_id.entry(msg.channel_id) {
6953 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6954 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6955 if !chan.context.is_usable() {
6956 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6959 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6960 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
6961 &self.node_signer, self.chain_hash, self.best_block.read().unwrap().height(),
6962 msg, &self.default_configuration
6963 ), chan_phase_entry),
6964 // Note that announcement_signatures fails if the channel cannot be announced,
6965 // so get_channel_update_for_broadcast will never fail by the time we get here.
6966 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
6969 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6970 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
6973 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))
6978 /// Returns DoPersist if anything changed, otherwise either SkipPersistNoEvents or an Err.
6979 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6980 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6981 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6983 // It's not a local channel
6984 return Ok(NotifyOption::SkipPersistNoEvents)
6987 let per_peer_state = self.per_peer_state.read().unwrap();
6988 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6989 if peer_state_mutex_opt.is_none() {
6990 return Ok(NotifyOption::SkipPersistNoEvents)
6992 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6993 let peer_state = &mut *peer_state_lock;
6994 match peer_state.channel_by_id.entry(chan_id) {
6995 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6996 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6997 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
6998 if chan.context.should_announce() {
6999 // If the announcement is about a channel of ours which is public, some
7000 // other peer may simply be forwarding all its gossip to us. Don't provide
7001 // a scary-looking error message and return Ok instead.
7002 return Ok(NotifyOption::SkipPersistNoEvents);
7004 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));
7006 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
7007 let msg_from_node_one = msg.contents.flags & 1 == 0;
7008 if were_node_one == msg_from_node_one {
7009 return Ok(NotifyOption::SkipPersistNoEvents);
7011 let logger = WithChannelContext::from(&self.logger, &chan.context);
7012 log_debug!(logger, "Received channel_update {:?} for channel {}.", msg, chan_id);
7013 let did_change = try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
7014 // If nothing changed after applying their update, we don't need to bother
7017 return Ok(NotifyOption::SkipPersistNoEvents);
7021 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7022 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
7025 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersistNoEvents)
7027 Ok(NotifyOption::DoPersist)
7030 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<NotifyOption, MsgHandleErrInternal> {
7032 let need_lnd_workaround = {
7033 let per_peer_state = self.per_peer_state.read().unwrap();
7035 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7037 debug_assert!(false);
7038 MsgHandleErrInternal::send_err_msg_no_close(
7039 format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id),
7043 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
7044 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7045 let peer_state = &mut *peer_state_lock;
7046 match peer_state.channel_by_id.entry(msg.channel_id) {
7047 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7048 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7049 // Currently, we expect all holding cell update_adds to be dropped on peer
7050 // disconnect, so Channel's reestablish will never hand us any holding cell
7051 // freed HTLCs to fail backwards. If in the future we no longer drop pending
7052 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
7053 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
7054 msg, &&logger, &self.node_signer, self.chain_hash,
7055 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
7056 let mut channel_update = None;
7057 if let Some(msg) = responses.shutdown_msg {
7058 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7059 node_id: counterparty_node_id.clone(),
7062 } else if chan.context.is_usable() {
7063 // If the channel is in a usable state (ie the channel is not being shut
7064 // down), send a unicast channel_update to our counterparty to make sure
7065 // they have the latest channel parameters.
7066 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
7067 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
7068 node_id: chan.context.get_counterparty_node_id(),
7073 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
7074 htlc_forwards = self.handle_channel_resumption(
7075 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
7076 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
7077 if let Some(upd) = channel_update {
7078 peer_state.pending_msg_events.push(upd);
7082 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7083 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
7086 hash_map::Entry::Vacant(_) => {
7087 log_debug!(logger, "Sending bogus ChannelReestablish for unknown channel {} to force channel closure",
7089 // Unfortunately, lnd doesn't force close on errors
7090 // (https://github.com/lightningnetwork/lnd/blob/abb1e3463f3a83bbb843d5c399869dbe930ad94f/htlcswitch/link.go#L2119).
7091 // One of the few ways to get an lnd counterparty to force close is by
7092 // replicating what they do when restoring static channel backups (SCBs). They
7093 // send an invalid `ChannelReestablish` with `0` commitment numbers and an
7094 // invalid `your_last_per_commitment_secret`.
7096 // Since we received a `ChannelReestablish` for a channel that doesn't exist, we
7097 // can assume it's likely the channel closed from our point of view, but it
7098 // remains open on the counterparty's side. By sending this bogus
7099 // `ChannelReestablish` message now as a response to theirs, we trigger them to
7100 // force close broadcasting their latest state. If the closing transaction from
7101 // our point of view remains unconfirmed, it'll enter a race with the
7102 // counterparty's to-be-broadcast latest commitment transaction.
7103 peer_state.pending_msg_events.push(MessageSendEvent::SendChannelReestablish {
7104 node_id: *counterparty_node_id,
7105 msg: msgs::ChannelReestablish {
7106 channel_id: msg.channel_id,
7107 next_local_commitment_number: 0,
7108 next_remote_commitment_number: 0,
7109 your_last_per_commitment_secret: [1u8; 32],
7110 my_current_per_commitment_point: PublicKey::from_slice(&[2u8; 33]).unwrap(),
7111 next_funding_txid: None,
7114 return Err(MsgHandleErrInternal::send_err_msg_no_close(
7115 format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
7116 counterparty_node_id), msg.channel_id)
7122 let mut persist = NotifyOption::SkipPersistHandleEvents;
7123 if let Some(forwards) = htlc_forwards {
7124 self.forward_htlcs(&mut [forwards][..]);
7125 persist = NotifyOption::DoPersist;
7128 if let Some(channel_ready_msg) = need_lnd_workaround {
7129 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
7134 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
7135 fn process_pending_monitor_events(&self) -> bool {
7136 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
7138 let mut failed_channels = Vec::new();
7139 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
7140 let has_pending_monitor_events = !pending_monitor_events.is_empty();
7141 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
7142 for monitor_event in monitor_events.drain(..) {
7143 match monitor_event {
7144 MonitorEvent::HTLCEvent(htlc_update) => {
7145 let logger = WithContext::from(&self.logger, counterparty_node_id, Some(funding_outpoint.to_channel_id()));
7146 if let Some(preimage) = htlc_update.payment_preimage {
7147 log_trace!(logger, "Claiming HTLC with preimage {} from our monitor", preimage);
7148 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, false, counterparty_node_id, funding_outpoint);
7150 log_trace!(logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
7151 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
7152 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7153 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
7156 MonitorEvent::HolderForceClosed(funding_outpoint) => {
7157 let counterparty_node_id_opt = match counterparty_node_id {
7158 Some(cp_id) => Some(cp_id),
7160 // TODO: Once we can rely on the counterparty_node_id from the
7161 // monitor event, this and the id_to_peer map should be removed.
7162 let id_to_peer = self.id_to_peer.lock().unwrap();
7163 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
7166 if let Some(counterparty_node_id) = counterparty_node_id_opt {
7167 let per_peer_state = self.per_peer_state.read().unwrap();
7168 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7169 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7170 let peer_state = &mut *peer_state_lock;
7171 let pending_msg_events = &mut peer_state.pending_msg_events;
7172 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
7173 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
7174 failed_channels.push(chan.context.force_shutdown(false));
7175 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7176 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7180 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
7181 pending_msg_events.push(events::MessageSendEvent::HandleError {
7182 node_id: chan.context.get_counterparty_node_id(),
7183 action: msgs::ErrorAction::DisconnectPeer {
7184 msg: Some(msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() })
7192 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
7193 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
7199 for failure in failed_channels.drain(..) {
7200 self.finish_close_channel(failure);
7203 has_pending_monitor_events
7206 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
7207 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
7208 /// update events as a separate process method here.
7210 pub fn process_monitor_events(&self) {
7211 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7212 self.process_pending_monitor_events();
7215 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
7216 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
7217 /// update was applied.
7218 fn check_free_holding_cells(&self) -> bool {
7219 let mut has_monitor_update = false;
7220 let mut failed_htlcs = Vec::new();
7222 // Walk our list of channels and find any that need to update. Note that when we do find an
7223 // update, if it includes actions that must be taken afterwards, we have to drop the
7224 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
7225 // manage to go through all our peers without finding a single channel to update.
7227 let per_peer_state = self.per_peer_state.read().unwrap();
7228 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7230 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7231 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
7232 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
7233 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
7235 let counterparty_node_id = chan.context.get_counterparty_node_id();
7236 let funding_txo = chan.context.get_funding_txo();
7237 let (monitor_opt, holding_cell_failed_htlcs) =
7238 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &&WithChannelContext::from(&self.logger, &chan.context));
7239 if !holding_cell_failed_htlcs.is_empty() {
7240 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
7242 if let Some(monitor_update) = monitor_opt {
7243 has_monitor_update = true;
7245 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
7246 peer_state_lock, peer_state, per_peer_state, chan);
7247 continue 'peer_loop;
7256 let has_update = has_monitor_update || !failed_htlcs.is_empty();
7257 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
7258 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
7264 /// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
7265 /// is (temporarily) unavailable, and the operation should be retried later.
7267 /// This method allows for that retry - either checking for any signer-pending messages to be
7268 /// attempted in every channel, or in the specifically provided channel.
7270 /// [`ChannelSigner`]: crate::sign::ChannelSigner
7271 #[cfg(test)] // This is only implemented for one signer method, and should be private until we
7272 // actually finish implementing it fully.
7273 pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
7274 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7276 let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
7277 let node_id = phase.context().get_counterparty_node_id();
7279 ChannelPhase::Funded(chan) => {
7280 let msgs = chan.signer_maybe_unblocked(&self.logger);
7281 if let Some(updates) = msgs.commitment_update {
7282 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
7287 if let Some(msg) = msgs.funding_signed {
7288 pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
7293 if let Some(msg) = msgs.channel_ready {
7294 send_channel_ready!(self, pending_msg_events, chan, msg);
7297 ChannelPhase::UnfundedOutboundV1(chan) => {
7298 if let Some(msg) = chan.signer_maybe_unblocked(&self.logger) {
7299 pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
7305 ChannelPhase::UnfundedInboundV1(_) => {},
7309 let per_peer_state = self.per_peer_state.read().unwrap();
7310 if let Some((counterparty_node_id, channel_id)) = channel_opt {
7311 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7312 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7313 let peer_state = &mut *peer_state_lock;
7314 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
7315 unblock_chan(chan, &mut peer_state.pending_msg_events);
7319 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7320 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7321 let peer_state = &mut *peer_state_lock;
7322 for (_, chan) in peer_state.channel_by_id.iter_mut() {
7323 unblock_chan(chan, &mut peer_state.pending_msg_events);
7329 /// Check whether any channels have finished removing all pending updates after a shutdown
7330 /// exchange and can now send a closing_signed.
7331 /// Returns whether any closing_signed messages were generated.
7332 fn maybe_generate_initial_closing_signed(&self) -> bool {
7333 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
7334 let mut has_update = false;
7335 let mut shutdown_results = Vec::new();
7337 let per_peer_state = self.per_peer_state.read().unwrap();
7339 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7340 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7341 let peer_state = &mut *peer_state_lock;
7342 let pending_msg_events = &mut peer_state.pending_msg_events;
7343 peer_state.channel_by_id.retain(|channel_id, phase| {
7345 ChannelPhase::Funded(chan) => {
7346 let logger = WithChannelContext::from(&self.logger, &chan.context);
7347 match chan.maybe_propose_closing_signed(&self.fee_estimator, &&logger) {
7348 Ok((msg_opt, tx_opt, shutdown_result_opt)) => {
7349 if let Some(msg) = msg_opt {
7351 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
7352 node_id: chan.context.get_counterparty_node_id(), msg,
7355 debug_assert_eq!(shutdown_result_opt.is_some(), chan.is_shutdown());
7356 if let Some(shutdown_result) = shutdown_result_opt {
7357 shutdown_results.push(shutdown_result);
7359 if let Some(tx) = tx_opt {
7360 // We're done with this channel. We got a closing_signed and sent back
7361 // a closing_signed with a closing transaction to broadcast.
7362 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7363 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7368 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
7370 log_info!(logger, "Broadcasting {}", log_tx!(tx));
7371 self.tx_broadcaster.broadcast_transactions(&[&tx]);
7372 update_maps_on_chan_removal!(self, &chan.context);
7378 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
7379 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
7384 _ => true, // Retain unfunded channels if present.
7390 for (counterparty_node_id, err) in handle_errors.drain(..) {
7391 let _ = handle_error!(self, err, counterparty_node_id);
7394 for shutdown_result in shutdown_results.drain(..) {
7395 self.finish_close_channel(shutdown_result);
7401 /// Handle a list of channel failures during a block_connected or block_disconnected call,
7402 /// pushing the channel monitor update (if any) to the background events queue and removing the
7404 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
7405 for mut failure in failed_channels.drain(..) {
7406 // Either a commitment transactions has been confirmed on-chain or
7407 // Channel::block_disconnected detected that the funding transaction has been
7408 // reorganized out of the main chain.
7409 // We cannot broadcast our latest local state via monitor update (as
7410 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
7411 // so we track the update internally and handle it when the user next calls
7412 // timer_tick_occurred, guaranteeing we're running normally.
7413 if let Some((counterparty_node_id, funding_txo, update)) = failure.monitor_update.take() {
7414 assert_eq!(update.updates.len(), 1);
7415 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
7416 assert!(should_broadcast);
7417 } else { unreachable!(); }
7418 self.pending_background_events.lock().unwrap().push(
7419 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
7420 counterparty_node_id, funding_txo, update
7423 self.finish_close_channel(failure);
7427 /// Creates an [`OfferBuilder`] such that the [`Offer`] it builds is recognized by the
7428 /// [`ChannelManager`] when handling [`InvoiceRequest`] messages for the offer. The offer will
7429 /// not have an expiration unless otherwise set on the builder.
7433 /// Uses a one-hop [`BlindedPath`] for the offer with [`ChannelManager::get_our_node_id`] as the
7434 /// introduction node and a derived signing pubkey for recipient privacy. As such, currently,
7435 /// the node must be announced. Otherwise, there is no way to find a path to the introduction
7436 /// node in order to send the [`InvoiceRequest`].
7440 /// Requires a direct connection to the introduction node in the responding [`InvoiceRequest`]'s
7443 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7445 /// [`Offer`]: crate::offers::offer::Offer
7446 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7447 pub fn create_offer_builder(
7448 &self, description: String
7449 ) -> OfferBuilder<DerivedMetadata, secp256k1::All> {
7450 let node_id = self.get_our_node_id();
7451 let expanded_key = &self.inbound_payment_key;
7452 let entropy = &*self.entropy_source;
7453 let secp_ctx = &self.secp_ctx;
7454 let path = self.create_one_hop_blinded_path();
7456 OfferBuilder::deriving_signing_pubkey(description, node_id, expanded_key, entropy, secp_ctx)
7457 .chain_hash(self.chain_hash)
7461 /// Creates a [`RefundBuilder`] such that the [`Refund`] it builds is recognized by the
7462 /// [`ChannelManager`] when handling [`Bolt12Invoice`] messages for the refund.
7466 /// The provided `payment_id` is used to ensure that only one invoice is paid for the refund.
7467 /// See [Avoiding Duplicate Payments] for other requirements once the payment has been sent.
7469 /// The builder will have the provided expiration set. Any changes to the expiration on the
7470 /// returned builder will not be honored by [`ChannelManager`]. For `no-std`, the highest seen
7471 /// block time minus two hours is used for the current time when determining if the refund has
7474 /// To revoke the refund, use [`ChannelManager::abandon_payment`] prior to receiving the
7475 /// invoice. If abandoned, or an invoice isn't received before expiration, the payment will fail
7476 /// with an [`Event::InvoiceRequestFailed`].
7478 /// If `max_total_routing_fee_msat` is not specified, The default from
7479 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7483 /// Uses a one-hop [`BlindedPath`] for the refund with [`ChannelManager::get_our_node_id`] as
7484 /// the introduction node and a derived payer id for payer privacy. As such, currently, the
7485 /// node must be announced. Otherwise, there is no way to find a path to the introduction node
7486 /// in order to send the [`Bolt12Invoice`].
7490 /// Requires a direct connection to an introduction node in the responding
7491 /// [`Bolt12Invoice::payment_paths`].
7495 /// Errors if a duplicate `payment_id` is provided given the caveats in the aforementioned link
7496 /// or if `amount_msats` is invalid.
7498 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7500 /// [`Refund`]: crate::offers::refund::Refund
7501 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7502 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7503 pub fn create_refund_builder(
7504 &self, description: String, amount_msats: u64, absolute_expiry: Duration,
7505 payment_id: PaymentId, retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
7506 ) -> Result<RefundBuilder<secp256k1::All>, Bolt12SemanticError> {
7507 let node_id = self.get_our_node_id();
7508 let expanded_key = &self.inbound_payment_key;
7509 let entropy = &*self.entropy_source;
7510 let secp_ctx = &self.secp_ctx;
7511 let path = self.create_one_hop_blinded_path();
7513 let builder = RefundBuilder::deriving_payer_id(
7514 description, node_id, expanded_key, entropy, secp_ctx, amount_msats, payment_id
7516 .chain_hash(self.chain_hash)
7517 .absolute_expiry(absolute_expiry)
7520 let expiration = StaleExpiration::AbsoluteTimeout(absolute_expiry);
7521 self.pending_outbound_payments
7522 .add_new_awaiting_invoice(
7523 payment_id, expiration, retry_strategy, max_total_routing_fee_msat,
7525 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7530 /// Pays for an [`Offer`] using the given parameters by creating an [`InvoiceRequest`] and
7531 /// enqueuing it to be sent via an onion message. [`ChannelManager`] will pay the actual
7532 /// [`Bolt12Invoice`] once it is received.
7534 /// Uses [`InvoiceRequestBuilder`] such that the [`InvoiceRequest`] it builds is recognized by
7535 /// the [`ChannelManager`] when handling a [`Bolt12Invoice`] message in response to the request.
7536 /// The optional parameters are used in the builder, if `Some`:
7537 /// - `quantity` for [`InvoiceRequest::quantity`] which must be set if
7538 /// [`Offer::expects_quantity`] is `true`.
7539 /// - `amount_msats` if overpaying what is required for the given `quantity` is desired, and
7540 /// - `payer_note` for [`InvoiceRequest::payer_note`].
7542 /// If `max_total_routing_fee_msat` is not specified, The default from
7543 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7547 /// The provided `payment_id` is used to ensure that only one invoice is paid for the request
7548 /// when received. See [Avoiding Duplicate Payments] for other requirements once the payment has
7551 /// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
7552 /// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
7553 /// payment will fail with an [`Event::InvoiceRequestFailed`].
7557 /// Uses a one-hop [`BlindedPath`] for the reply path with [`ChannelManager::get_our_node_id`]
7558 /// as the introduction node and a derived payer id for payer privacy. As such, currently, the
7559 /// node must be announced. Otherwise, there is no way to find a path to the introduction node
7560 /// in order to send the [`Bolt12Invoice`].
7564 /// Requires a direct connection to an introduction node in [`Offer::paths`] or to
7565 /// [`Offer::signing_pubkey`], if empty. A similar restriction applies to the responding
7566 /// [`Bolt12Invoice::payment_paths`].
7570 /// Errors if a duplicate `payment_id` is provided given the caveats in the aforementioned link
7571 /// or if the provided parameters are invalid for the offer.
7573 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7574 /// [`InvoiceRequest::quantity`]: crate::offers::invoice_request::InvoiceRequest::quantity
7575 /// [`InvoiceRequest::payer_note`]: crate::offers::invoice_request::InvoiceRequest::payer_note
7576 /// [`InvoiceRequestBuilder`]: crate::offers::invoice_request::InvoiceRequestBuilder
7577 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7578 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7579 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7580 pub fn pay_for_offer(
7581 &self, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>,
7582 payer_note: Option<String>, payment_id: PaymentId, retry_strategy: Retry,
7583 max_total_routing_fee_msat: Option<u64>
7584 ) -> Result<(), Bolt12SemanticError> {
7585 let expanded_key = &self.inbound_payment_key;
7586 let entropy = &*self.entropy_source;
7587 let secp_ctx = &self.secp_ctx;
7590 .request_invoice_deriving_payer_id(expanded_key, entropy, secp_ctx, payment_id)?
7591 .chain_hash(self.chain_hash)?;
7592 let builder = match quantity {
7594 Some(quantity) => builder.quantity(quantity)?,
7596 let builder = match amount_msats {
7598 Some(amount_msats) => builder.amount_msats(amount_msats)?,
7600 let builder = match payer_note {
7602 Some(payer_note) => builder.payer_note(payer_note),
7605 let invoice_request = builder.build_and_sign()?;
7606 let reply_path = self.create_one_hop_blinded_path();
7608 let expiration = StaleExpiration::TimerTicks(1);
7609 self.pending_outbound_payments
7610 .add_new_awaiting_invoice(
7611 payment_id, expiration, retry_strategy, max_total_routing_fee_msat
7613 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7615 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7616 if offer.paths().is_empty() {
7617 let message = new_pending_onion_message(
7618 OffersMessage::InvoiceRequest(invoice_request),
7619 Destination::Node(offer.signing_pubkey()),
7622 pending_offers_messages.push(message);
7624 // Send as many invoice requests as there are paths in the offer (with an upper bound).
7625 // Using only one path could result in a failure if the path no longer exists. But only
7626 // one invoice for a given payment id will be paid, even if more than one is received.
7627 const REQUEST_LIMIT: usize = 10;
7628 for path in offer.paths().into_iter().take(REQUEST_LIMIT) {
7629 let message = new_pending_onion_message(
7630 OffersMessage::InvoiceRequest(invoice_request.clone()),
7631 Destination::BlindedPath(path.clone()),
7632 Some(reply_path.clone()),
7634 pending_offers_messages.push(message);
7641 /// Creates a [`Bolt12Invoice`] for a [`Refund`] and enqueues it to be sent via an onion
7644 /// The resulting invoice uses a [`PaymentHash`] recognized by the [`ChannelManager`] and a
7645 /// [`BlindedPath`] containing the [`PaymentSecret`] needed to reconstruct the corresponding
7646 /// [`PaymentPreimage`].
7650 /// Requires a direct connection to an introduction node in [`Refund::paths`] or to
7651 /// [`Refund::payer_id`], if empty. This request is best effort; an invoice will be sent to each
7652 /// node meeting the aforementioned criteria, but there's no guarantee that they will be
7653 /// received and no retries will be made.
7655 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7656 pub fn request_refund_payment(&self, refund: &Refund) -> Result<(), Bolt12SemanticError> {
7657 let expanded_key = &self.inbound_payment_key;
7658 let entropy = &*self.entropy_source;
7659 let secp_ctx = &self.secp_ctx;
7661 let amount_msats = refund.amount_msats();
7662 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
7664 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
7665 Ok((payment_hash, payment_secret)) => {
7666 let payment_paths = vec![
7667 self.create_one_hop_blinded_payment_path(payment_secret),
7669 #[cfg(not(feature = "no-std"))]
7670 let builder = refund.respond_using_derived_keys(
7671 payment_paths, payment_hash, expanded_key, entropy
7673 #[cfg(feature = "no-std")]
7674 let created_at = Duration::from_secs(
7675 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
7677 #[cfg(feature = "no-std")]
7678 let builder = refund.respond_using_derived_keys_no_std(
7679 payment_paths, payment_hash, created_at, expanded_key, entropy
7681 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
7682 let reply_path = self.create_one_hop_blinded_path();
7684 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7685 if refund.paths().is_empty() {
7686 let message = new_pending_onion_message(
7687 OffersMessage::Invoice(invoice),
7688 Destination::Node(refund.payer_id()),
7691 pending_offers_messages.push(message);
7693 for path in refund.paths() {
7694 let message = new_pending_onion_message(
7695 OffersMessage::Invoice(invoice.clone()),
7696 Destination::BlindedPath(path.clone()),
7697 Some(reply_path.clone()),
7699 pending_offers_messages.push(message);
7705 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
7709 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
7712 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
7713 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
7715 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
7716 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
7717 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
7718 /// passed directly to [`claim_funds`].
7720 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
7722 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7723 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7727 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7728 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7730 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7732 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7733 /// on versions of LDK prior to 0.0.114.
7735 /// [`claim_funds`]: Self::claim_funds
7736 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7737 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
7738 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
7739 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
7740 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
7741 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
7742 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
7743 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
7744 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7745 min_final_cltv_expiry_delta)
7748 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
7749 /// stored external to LDK.
7751 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
7752 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
7753 /// the `min_value_msat` provided here, if one is provided.
7755 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
7756 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
7759 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
7760 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
7761 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
7762 /// sender "proof-of-payment" unless they have paid the required amount.
7764 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
7765 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
7766 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
7767 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
7768 /// invoices when no timeout is set.
7770 /// Note that we use block header time to time-out pending inbound payments (with some margin
7771 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
7772 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
7773 /// If you need exact expiry semantics, you should enforce them upon receipt of
7774 /// [`PaymentClaimable`].
7776 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
7777 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
7779 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7780 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7784 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7785 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7787 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7789 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7790 /// on versions of LDK prior to 0.0.114.
7792 /// [`create_inbound_payment`]: Self::create_inbound_payment
7793 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7794 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
7795 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
7796 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
7797 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7798 min_final_cltv_expiry)
7801 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
7802 /// previously returned from [`create_inbound_payment`].
7804 /// [`create_inbound_payment`]: Self::create_inbound_payment
7805 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
7806 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
7809 /// Creates a one-hop blinded path with [`ChannelManager::get_our_node_id`] as the introduction
7811 fn create_one_hop_blinded_path(&self) -> BlindedPath {
7812 let entropy_source = self.entropy_source.deref();
7813 let secp_ctx = &self.secp_ctx;
7814 BlindedPath::one_hop_for_message(self.get_our_node_id(), entropy_source, secp_ctx).unwrap()
7817 /// Creates a one-hop blinded path with [`ChannelManager::get_our_node_id`] as the introduction
7819 fn create_one_hop_blinded_payment_path(
7820 &self, payment_secret: PaymentSecret
7821 ) -> (BlindedPayInfo, BlindedPath) {
7822 let entropy_source = self.entropy_source.deref();
7823 let secp_ctx = &self.secp_ctx;
7825 let payee_node_id = self.get_our_node_id();
7826 let max_cltv_expiry = self.best_block.read().unwrap().height() + LATENCY_GRACE_PERIOD_BLOCKS;
7827 let payee_tlvs = ReceiveTlvs {
7829 payment_constraints: PaymentConstraints {
7831 htlc_minimum_msat: 1,
7834 // TODO: Err for overflow?
7835 BlindedPath::one_hop_for_payment(
7836 payee_node_id, payee_tlvs, entropy_source, secp_ctx
7840 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
7841 /// are used when constructing the phantom invoice's route hints.
7843 /// [phantom node payments]: crate::sign::PhantomKeysManager
7844 pub fn get_phantom_scid(&self) -> u64 {
7845 let best_block_height = self.best_block.read().unwrap().height();
7846 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7848 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7849 // Ensure the generated scid doesn't conflict with a real channel.
7850 match short_to_chan_info.get(&scid_candidate) {
7851 Some(_) => continue,
7852 None => return scid_candidate
7857 /// Gets route hints for use in receiving [phantom node payments].
7859 /// [phantom node payments]: crate::sign::PhantomKeysManager
7860 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
7862 channels: self.list_usable_channels(),
7863 phantom_scid: self.get_phantom_scid(),
7864 real_node_pubkey: self.get_our_node_id(),
7868 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
7869 /// used when constructing the route hints for HTLCs intended to be intercepted. See
7870 /// [`ChannelManager::forward_intercepted_htlc`].
7872 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
7873 /// times to get a unique scid.
7874 pub fn get_intercept_scid(&self) -> u64 {
7875 let best_block_height = self.best_block.read().unwrap().height();
7876 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7878 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7879 // Ensure the generated scid doesn't conflict with a real channel.
7880 if short_to_chan_info.contains_key(&scid_candidate) { continue }
7881 return scid_candidate
7885 /// Gets inflight HTLC information by processing pending outbound payments that are in
7886 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
7887 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
7888 let mut inflight_htlcs = InFlightHtlcs::new();
7890 let per_peer_state = self.per_peer_state.read().unwrap();
7891 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7892 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7893 let peer_state = &mut *peer_state_lock;
7894 for chan in peer_state.channel_by_id.values().filter_map(
7895 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
7897 for (htlc_source, _) in chan.inflight_htlc_sources() {
7898 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
7899 inflight_htlcs.process_path(path, self.get_our_node_id());
7908 #[cfg(any(test, feature = "_test_utils"))]
7909 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
7910 let events = core::cell::RefCell::new(Vec::new());
7911 let event_handler = |event: events::Event| events.borrow_mut().push(event);
7912 self.process_pending_events(&event_handler);
7916 #[cfg(feature = "_test_utils")]
7917 pub fn push_pending_event(&self, event: events::Event) {
7918 let mut events = self.pending_events.lock().unwrap();
7919 events.push_back((event, None));
7923 pub fn pop_pending_event(&self) -> Option<events::Event> {
7924 let mut events = self.pending_events.lock().unwrap();
7925 events.pop_front().map(|(e, _)| e)
7929 pub fn has_pending_payments(&self) -> bool {
7930 self.pending_outbound_payments.has_pending_payments()
7934 pub fn clear_pending_payments(&self) {
7935 self.pending_outbound_payments.clear_pending_payments()
7938 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
7939 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
7940 /// operation. It will double-check that nothing *else* is also blocking the same channel from
7941 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
7942 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
7943 let logger = WithContext::from(
7944 &self.logger, Some(counterparty_node_id), Some(channel_funding_outpoint.to_channel_id())
7947 let per_peer_state = self.per_peer_state.read().unwrap();
7948 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
7949 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
7950 let peer_state = &mut *peer_state_lck;
7951 if let Some(blocker) = completed_blocker.take() {
7952 // Only do this on the first iteration of the loop.
7953 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
7954 .get_mut(&channel_funding_outpoint.to_channel_id())
7956 blockers.retain(|iter| iter != &blocker);
7960 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
7961 channel_funding_outpoint, counterparty_node_id) {
7962 // Check that, while holding the peer lock, we don't have anything else
7963 // blocking monitor updates for this channel. If we do, release the monitor
7964 // update(s) when those blockers complete.
7965 log_trace!(logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
7966 &channel_funding_outpoint.to_channel_id());
7970 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
7971 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7972 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
7973 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
7974 log_debug!(logger, "Unlocking monitor updating for channel {} and updating monitor",
7975 channel_funding_outpoint.to_channel_id());
7976 handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
7977 peer_state_lck, peer_state, per_peer_state, chan);
7978 if further_update_exists {
7979 // If there are more `ChannelMonitorUpdate`s to process, restart at the
7984 log_trace!(logger, "Unlocked monitor updating for channel {} without monitors to update",
7985 channel_funding_outpoint.to_channel_id());
7991 "Got a release post-RAA monitor update for peer {} but the channel is gone",
7992 log_pubkey!(counterparty_node_id));
7998 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
7999 for action in actions {
8001 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
8002 channel_funding_outpoint, counterparty_node_id
8004 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
8010 /// Processes any events asynchronously in the order they were generated since the last call
8011 /// using the given event handler.
8013 /// See the trait-level documentation of [`EventsProvider`] for requirements.
8014 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
8018 process_events_body!(self, ev, { handler(ev).await });
8022 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>
8024 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8025 T::Target: BroadcasterInterface,
8026 ES::Target: EntropySource,
8027 NS::Target: NodeSigner,
8028 SP::Target: SignerProvider,
8029 F::Target: FeeEstimator,
8033 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
8034 /// The returned array will contain `MessageSendEvent`s for different peers if
8035 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
8036 /// is always placed next to each other.
8038 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
8039 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
8040 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
8041 /// will randomly be placed first or last in the returned array.
8043 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
8044 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
8045 /// the `MessageSendEvent`s to the specific peer they were generated under.
8046 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
8047 let events = RefCell::new(Vec::new());
8048 PersistenceNotifierGuard::optionally_notify(self, || {
8049 let mut result = NotifyOption::SkipPersistNoEvents;
8051 // TODO: This behavior should be documented. It's unintuitive that we query
8052 // ChannelMonitors when clearing other events.
8053 if self.process_pending_monitor_events() {
8054 result = NotifyOption::DoPersist;
8057 if self.check_free_holding_cells() {
8058 result = NotifyOption::DoPersist;
8060 if self.maybe_generate_initial_closing_signed() {
8061 result = NotifyOption::DoPersist;
8064 let mut pending_events = Vec::new();
8065 let per_peer_state = self.per_peer_state.read().unwrap();
8066 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8067 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8068 let peer_state = &mut *peer_state_lock;
8069 if peer_state.pending_msg_events.len() > 0 {
8070 pending_events.append(&mut peer_state.pending_msg_events);
8074 if !pending_events.is_empty() {
8075 events.replace(pending_events);
8084 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>
8086 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8087 T::Target: BroadcasterInterface,
8088 ES::Target: EntropySource,
8089 NS::Target: NodeSigner,
8090 SP::Target: SignerProvider,
8091 F::Target: FeeEstimator,
8095 /// Processes events that must be periodically handled.
8097 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
8098 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
8099 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
8101 process_events_body!(self, ev, handler.handle_event(ev));
8105 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>
8107 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8108 T::Target: BroadcasterInterface,
8109 ES::Target: EntropySource,
8110 NS::Target: NodeSigner,
8111 SP::Target: SignerProvider,
8112 F::Target: FeeEstimator,
8116 fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
8118 let best_block = self.best_block.read().unwrap();
8119 assert_eq!(best_block.block_hash(), header.prev_blockhash,
8120 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
8121 assert_eq!(best_block.height(), height - 1,
8122 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
8125 self.transactions_confirmed(header, txdata, height);
8126 self.best_block_updated(header, height);
8129 fn block_disconnected(&self, header: &Header, height: u32) {
8130 let _persistence_guard =
8131 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8132 self, || -> NotifyOption { NotifyOption::DoPersist });
8133 let new_height = height - 1;
8135 let mut best_block = self.best_block.write().unwrap();
8136 assert_eq!(best_block.block_hash(), header.block_hash(),
8137 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
8138 assert_eq!(best_block.height(), height,
8139 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
8140 *best_block = BestBlock::new(header.prev_blockhash, new_height)
8143 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)));
8147 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>
8149 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8150 T::Target: BroadcasterInterface,
8151 ES::Target: EntropySource,
8152 NS::Target: NodeSigner,
8153 SP::Target: SignerProvider,
8154 F::Target: FeeEstimator,
8158 fn transactions_confirmed(&self, header: &Header, txdata: &TransactionData, height: u32) {
8159 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8160 // during initialization prior to the chain_monitor being fully configured in some cases.
8161 // See the docs for `ChannelManagerReadArgs` for more.
8163 let block_hash = header.block_hash();
8164 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
8166 let _persistence_guard =
8167 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8168 self, || -> NotifyOption { NotifyOption::DoPersist });
8169 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))
8170 .map(|(a, b)| (a, Vec::new(), b)));
8172 let last_best_block_height = self.best_block.read().unwrap().height();
8173 if height < last_best_block_height {
8174 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
8175 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)));
8179 fn best_block_updated(&self, header: &Header, height: u32) {
8180 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8181 // during initialization prior to the chain_monitor being fully configured in some cases.
8182 // See the docs for `ChannelManagerReadArgs` for more.
8184 let block_hash = header.block_hash();
8185 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
8187 let _persistence_guard =
8188 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8189 self, || -> NotifyOption { NotifyOption::DoPersist });
8190 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
8192 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)));
8194 macro_rules! max_time {
8195 ($timestamp: expr) => {
8197 // Update $timestamp to be the max of its current value and the block
8198 // timestamp. This should keep us close to the current time without relying on
8199 // having an explicit local time source.
8200 // Just in case we end up in a race, we loop until we either successfully
8201 // update $timestamp or decide we don't need to.
8202 let old_serial = $timestamp.load(Ordering::Acquire);
8203 if old_serial >= header.time as usize { break; }
8204 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
8210 max_time!(self.highest_seen_timestamp);
8211 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
8212 payment_secrets.retain(|_, inbound_payment| {
8213 inbound_payment.expiry_time > header.time as u64
8217 fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
8218 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
8219 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
8220 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8221 let peer_state = &mut *peer_state_lock;
8222 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
8223 let txid_opt = chan.context.get_funding_txo();
8224 let height_opt = chan.context.get_funding_tx_confirmation_height();
8225 let hash_opt = chan.context.get_funding_tx_confirmed_in();
8226 if let (Some(funding_txo), Some(conf_height), Some(block_hash)) = (txid_opt, height_opt, hash_opt) {
8227 res.push((funding_txo.txid, conf_height, Some(block_hash)));
8234 fn transaction_unconfirmed(&self, txid: &Txid) {
8235 let _persistence_guard =
8236 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8237 self, || -> NotifyOption { NotifyOption::DoPersist });
8238 self.do_chain_event(None, |channel| {
8239 if let Some(funding_txo) = channel.context.get_funding_txo() {
8240 if funding_txo.txid == *txid {
8241 channel.funding_transaction_unconfirmed(&&WithChannelContext::from(&self.logger, &channel.context)).map(|()| (None, Vec::new(), None))
8242 } else { Ok((None, Vec::new(), None)) }
8243 } else { Ok((None, Vec::new(), None)) }
8248 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>
8250 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8251 T::Target: BroadcasterInterface,
8252 ES::Target: EntropySource,
8253 NS::Target: NodeSigner,
8254 SP::Target: SignerProvider,
8255 F::Target: FeeEstimator,
8259 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
8260 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
8262 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
8263 (&self, height_opt: Option<u32>, f: FN) {
8264 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8265 // during initialization prior to the chain_monitor being fully configured in some cases.
8266 // See the docs for `ChannelManagerReadArgs` for more.
8268 let mut failed_channels = Vec::new();
8269 let mut timed_out_htlcs = Vec::new();
8271 let per_peer_state = self.per_peer_state.read().unwrap();
8272 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8273 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8274 let peer_state = &mut *peer_state_lock;
8275 let pending_msg_events = &mut peer_state.pending_msg_events;
8276 peer_state.channel_by_id.retain(|_, phase| {
8278 // Retain unfunded channels.
8279 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
8280 ChannelPhase::Funded(channel) => {
8281 let res = f(channel);
8282 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
8283 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
8284 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
8285 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
8286 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
8288 let logger = WithChannelContext::from(&self.logger, &channel.context);
8289 if let Some(channel_ready) = channel_ready_opt {
8290 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
8291 if channel.context.is_usable() {
8292 log_trace!(logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
8293 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
8294 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
8295 node_id: channel.context.get_counterparty_node_id(),
8300 log_trace!(logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
8305 let mut pending_events = self.pending_events.lock().unwrap();
8306 emit_channel_ready_event!(pending_events, channel);
8309 if let Some(announcement_sigs) = announcement_sigs {
8310 log_trace!(logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
8311 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
8312 node_id: channel.context.get_counterparty_node_id(),
8313 msg: announcement_sigs,
8315 if let Some(height) = height_opt {
8316 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.chain_hash, height, &self.default_configuration) {
8317 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
8319 // Note that announcement_signatures fails if the channel cannot be announced,
8320 // so get_channel_update_for_broadcast will never fail by the time we get here.
8321 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
8326 if channel.is_our_channel_ready() {
8327 if let Some(real_scid) = channel.context.get_short_channel_id() {
8328 // If we sent a 0conf channel_ready, and now have an SCID, we add it
8329 // to the short_to_chan_info map here. Note that we check whether we
8330 // can relay using the real SCID at relay-time (i.e.
8331 // enforce option_scid_alias then), and if the funding tx is ever
8332 // un-confirmed we force-close the channel, ensuring short_to_chan_info
8333 // is always consistent.
8334 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
8335 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8336 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
8337 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
8338 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
8341 } else if let Err(reason) = res {
8342 update_maps_on_chan_removal!(self, &channel.context);
8343 // It looks like our counterparty went on-chain or funding transaction was
8344 // reorged out of the main chain. Close the channel.
8345 failed_channels.push(channel.context.force_shutdown(true));
8346 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
8347 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
8351 let reason_message = format!("{}", reason);
8352 self.issue_channel_close_events(&channel.context, reason);
8353 pending_msg_events.push(events::MessageSendEvent::HandleError {
8354 node_id: channel.context.get_counterparty_node_id(),
8355 action: msgs::ErrorAction::DisconnectPeer {
8356 msg: Some(msgs::ErrorMessage {
8357 channel_id: channel.context.channel_id(),
8358 data: reason_message,
8371 if let Some(height) = height_opt {
8372 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
8373 payment.htlcs.retain(|htlc| {
8374 // If height is approaching the number of blocks we think it takes us to get
8375 // our commitment transaction confirmed before the HTLC expires, plus the
8376 // number of blocks we generally consider it to take to do a commitment update,
8377 // just give up on it and fail the HTLC.
8378 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
8379 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
8380 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
8382 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
8383 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
8384 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
8388 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
8391 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
8392 intercepted_htlcs.retain(|_, htlc| {
8393 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
8394 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
8395 short_channel_id: htlc.prev_short_channel_id,
8396 user_channel_id: Some(htlc.prev_user_channel_id),
8397 htlc_id: htlc.prev_htlc_id,
8398 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
8399 phantom_shared_secret: None,
8400 outpoint: htlc.prev_funding_outpoint,
8401 blinded_failure: htlc.forward_info.routing.blinded_failure(),
8404 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
8405 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
8406 _ => unreachable!(),
8408 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
8409 HTLCFailReason::from_failure_code(0x2000 | 2),
8410 HTLCDestination::InvalidForward { requested_forward_scid }));
8411 let logger = WithContext::from(
8412 &self.logger, None, Some(htlc.prev_funding_outpoint.to_channel_id())
8414 log_trace!(logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
8420 self.handle_init_event_channel_failures(failed_channels);
8422 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
8423 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
8427 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
8428 /// may have events that need processing.
8430 /// In order to check if this [`ChannelManager`] needs persisting, call
8431 /// [`Self::get_and_clear_needs_persistence`].
8433 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
8434 /// [`ChannelManager`] and should instead register actions to be taken later.
8435 pub fn get_event_or_persistence_needed_future(&self) -> Future {
8436 self.event_persist_notifier.get_future()
8439 /// Returns true if this [`ChannelManager`] needs to be persisted.
8440 pub fn get_and_clear_needs_persistence(&self) -> bool {
8441 self.needs_persist_flag.swap(false, Ordering::AcqRel)
8444 #[cfg(any(test, feature = "_test_utils"))]
8445 pub fn get_event_or_persist_condvar_value(&self) -> bool {
8446 self.event_persist_notifier.notify_pending()
8449 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
8450 /// [`chain::Confirm`] interfaces.
8451 pub fn current_best_block(&self) -> BestBlock {
8452 self.best_block.read().unwrap().clone()
8455 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
8456 /// [`ChannelManager`].
8457 pub fn node_features(&self) -> NodeFeatures {
8458 provided_node_features(&self.default_configuration)
8461 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
8462 /// [`ChannelManager`].
8464 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8465 /// or not. Thus, this method is not public.
8466 #[cfg(any(feature = "_test_utils", test))]
8467 pub fn bolt11_invoice_features(&self) -> Bolt11InvoiceFeatures {
8468 provided_bolt11_invoice_features(&self.default_configuration)
8471 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
8472 /// [`ChannelManager`].
8473 fn bolt12_invoice_features(&self) -> Bolt12InvoiceFeatures {
8474 provided_bolt12_invoice_features(&self.default_configuration)
8477 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
8478 /// [`ChannelManager`].
8479 pub fn channel_features(&self) -> ChannelFeatures {
8480 provided_channel_features(&self.default_configuration)
8483 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
8484 /// [`ChannelManager`].
8485 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
8486 provided_channel_type_features(&self.default_configuration)
8489 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
8490 /// [`ChannelManager`].
8491 pub fn init_features(&self) -> InitFeatures {
8492 provided_init_features(&self.default_configuration)
8496 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8497 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
8499 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8500 T::Target: BroadcasterInterface,
8501 ES::Target: EntropySource,
8502 NS::Target: NodeSigner,
8503 SP::Target: SignerProvider,
8504 F::Target: FeeEstimator,
8508 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
8509 // Note that we never need to persist the updated ChannelManager for an inbound
8510 // open_channel message - pre-funded channels are never written so there should be no
8511 // change to the contents.
8512 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8513 let res = self.internal_open_channel(counterparty_node_id, msg);
8514 let persist = match &res {
8515 Err(e) if e.closes_channel() => {
8516 debug_assert!(false, "We shouldn't close a new channel");
8517 NotifyOption::DoPersist
8519 _ => NotifyOption::SkipPersistHandleEvents,
8521 let _ = handle_error!(self, res, *counterparty_node_id);
8526 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
8527 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8528 "Dual-funded channels not supported".to_owned(),
8529 msg.temporary_channel_id.clone())), *counterparty_node_id);
8532 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
8533 // Note that we never need to persist the updated ChannelManager for an inbound
8534 // accept_channel message - pre-funded channels are never written so there should be no
8535 // change to the contents.
8536 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8537 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
8538 NotifyOption::SkipPersistHandleEvents
8542 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
8543 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8544 "Dual-funded channels not supported".to_owned(),
8545 msg.temporary_channel_id.clone())), *counterparty_node_id);
8548 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
8549 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8550 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
8553 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
8554 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8555 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
8558 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
8559 // Note that we never need to persist the updated ChannelManager for an inbound
8560 // channel_ready message - while the channel's state will change, any channel_ready message
8561 // will ultimately be re-sent on startup and the `ChannelMonitor` won't be updated so we
8562 // will not force-close the channel on startup.
8563 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8564 let res = self.internal_channel_ready(counterparty_node_id, msg);
8565 let persist = match &res {
8566 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8567 _ => NotifyOption::SkipPersistHandleEvents,
8569 let _ = handle_error!(self, res, *counterparty_node_id);
8574 fn handle_stfu(&self, counterparty_node_id: &PublicKey, msg: &msgs::Stfu) {
8575 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8576 "Quiescence not supported".to_owned(),
8577 msg.channel_id.clone())), *counterparty_node_id);
8580 fn handle_splice(&self, counterparty_node_id: &PublicKey, msg: &msgs::Splice) {
8581 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8582 "Splicing not supported".to_owned(),
8583 msg.channel_id.clone())), *counterparty_node_id);
8586 fn handle_splice_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceAck) {
8587 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8588 "Splicing not supported (splice_ack)".to_owned(),
8589 msg.channel_id.clone())), *counterparty_node_id);
8592 fn handle_splice_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
8593 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8594 "Splicing not supported (splice_locked)".to_owned(),
8595 msg.channel_id.clone())), *counterparty_node_id);
8598 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
8599 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8600 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
8603 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
8604 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8605 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
8608 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
8609 // Note that we never need to persist the updated ChannelManager for an inbound
8610 // update_add_htlc message - the message itself doesn't change our channel state only the
8611 // `commitment_signed` message afterwards will.
8612 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8613 let res = self.internal_update_add_htlc(counterparty_node_id, msg);
8614 let persist = match &res {
8615 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8616 Err(_) => NotifyOption::SkipPersistHandleEvents,
8617 Ok(()) => NotifyOption::SkipPersistNoEvents,
8619 let _ = handle_error!(self, res, *counterparty_node_id);
8624 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
8625 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8626 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
8629 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
8630 // Note that we never need to persist the updated ChannelManager for an inbound
8631 // update_fail_htlc message - the message itself doesn't change our channel state only the
8632 // `commitment_signed` message afterwards will.
8633 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8634 let res = self.internal_update_fail_htlc(counterparty_node_id, msg);
8635 let persist = match &res {
8636 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8637 Err(_) => NotifyOption::SkipPersistHandleEvents,
8638 Ok(()) => NotifyOption::SkipPersistNoEvents,
8640 let _ = handle_error!(self, res, *counterparty_node_id);
8645 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
8646 // Note that we never need to persist the updated ChannelManager for an inbound
8647 // update_fail_malformed_htlc message - the message itself doesn't change our channel state
8648 // only the `commitment_signed` message afterwards will.
8649 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8650 let res = self.internal_update_fail_malformed_htlc(counterparty_node_id, msg);
8651 let persist = match &res {
8652 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8653 Err(_) => NotifyOption::SkipPersistHandleEvents,
8654 Ok(()) => NotifyOption::SkipPersistNoEvents,
8656 let _ = handle_error!(self, res, *counterparty_node_id);
8661 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
8662 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8663 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
8666 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
8667 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8668 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
8671 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
8672 // Note that we never need to persist the updated ChannelManager for an inbound
8673 // update_fee message - the message itself doesn't change our channel state only the
8674 // `commitment_signed` message afterwards will.
8675 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8676 let res = self.internal_update_fee(counterparty_node_id, msg);
8677 let persist = match &res {
8678 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8679 Err(_) => NotifyOption::SkipPersistHandleEvents,
8680 Ok(()) => NotifyOption::SkipPersistNoEvents,
8682 let _ = handle_error!(self, res, *counterparty_node_id);
8687 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
8688 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8689 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
8692 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
8693 PersistenceNotifierGuard::optionally_notify(self, || {
8694 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
8697 NotifyOption::DoPersist
8702 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
8703 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8704 let res = self.internal_channel_reestablish(counterparty_node_id, msg);
8705 let persist = match &res {
8706 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8707 Err(_) => NotifyOption::SkipPersistHandleEvents,
8708 Ok(persist) => *persist,
8710 let _ = handle_error!(self, res, *counterparty_node_id);
8715 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
8716 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(
8717 self, || NotifyOption::SkipPersistHandleEvents);
8718 let mut failed_channels = Vec::new();
8719 let mut per_peer_state = self.per_peer_state.write().unwrap();
8722 WithContext::from(&self.logger, Some(*counterparty_node_id), None),
8723 "Marking channels with {} disconnected and generating channel_updates.",
8724 log_pubkey!(counterparty_node_id)
8726 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8727 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8728 let peer_state = &mut *peer_state_lock;
8729 let pending_msg_events = &mut peer_state.pending_msg_events;
8730 peer_state.channel_by_id.retain(|_, phase| {
8731 let context = match phase {
8732 ChannelPhase::Funded(chan) => {
8733 let logger = WithChannelContext::from(&self.logger, &chan.context);
8734 if chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok() {
8735 // We only retain funded channels that are not shutdown.
8740 // Unfunded channels will always be removed.
8741 ChannelPhase::UnfundedOutboundV1(chan) => {
8744 ChannelPhase::UnfundedInboundV1(chan) => {
8748 // Clean up for removal.
8749 update_maps_on_chan_removal!(self, &context);
8750 self.issue_channel_close_events(&context, ClosureReason::DisconnectedPeer);
8751 failed_channels.push(context.force_shutdown(false));
8754 // Note that we don't bother generating any events for pre-accept channels -
8755 // they're not considered "channels" yet from the PoV of our events interface.
8756 peer_state.inbound_channel_request_by_id.clear();
8757 pending_msg_events.retain(|msg| {
8759 // V1 Channel Establishment
8760 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
8761 &events::MessageSendEvent::SendOpenChannel { .. } => false,
8762 &events::MessageSendEvent::SendFundingCreated { .. } => false,
8763 &events::MessageSendEvent::SendFundingSigned { .. } => false,
8764 // V2 Channel Establishment
8765 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
8766 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
8767 // Common Channel Establishment
8768 &events::MessageSendEvent::SendChannelReady { .. } => false,
8769 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
8771 &events::MessageSendEvent::SendStfu { .. } => false,
8773 &events::MessageSendEvent::SendSplice { .. } => false,
8774 &events::MessageSendEvent::SendSpliceAck { .. } => false,
8775 &events::MessageSendEvent::SendSpliceLocked { .. } => false,
8776 // Interactive Transaction Construction
8777 &events::MessageSendEvent::SendTxAddInput { .. } => false,
8778 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
8779 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
8780 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
8781 &events::MessageSendEvent::SendTxComplete { .. } => false,
8782 &events::MessageSendEvent::SendTxSignatures { .. } => false,
8783 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
8784 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
8785 &events::MessageSendEvent::SendTxAbort { .. } => false,
8786 // Channel Operations
8787 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
8788 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
8789 &events::MessageSendEvent::SendClosingSigned { .. } => false,
8790 &events::MessageSendEvent::SendShutdown { .. } => false,
8791 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
8792 &events::MessageSendEvent::HandleError { .. } => false,
8794 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
8795 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
8796 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
8797 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
8798 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
8799 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
8800 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
8801 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
8802 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
8805 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
8806 peer_state.is_connected = false;
8807 peer_state.ok_to_remove(true)
8808 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
8811 per_peer_state.remove(counterparty_node_id);
8813 mem::drop(per_peer_state);
8815 for failure in failed_channels.drain(..) {
8816 self.finish_close_channel(failure);
8820 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
8821 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), None);
8822 if !init_msg.features.supports_static_remote_key() {
8823 log_debug!(logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
8827 let mut res = Ok(());
8829 PersistenceNotifierGuard::optionally_notify(self, || {
8830 // If we have too many peers connected which don't have funded channels, disconnect the
8831 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
8832 // unfunded channels taking up space in memory for disconnected peers, we still let new
8833 // peers connect, but we'll reject new channels from them.
8834 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
8835 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
8838 let mut peer_state_lock = self.per_peer_state.write().unwrap();
8839 match peer_state_lock.entry(counterparty_node_id.clone()) {
8840 hash_map::Entry::Vacant(e) => {
8841 if inbound_peer_limited {
8843 return NotifyOption::SkipPersistNoEvents;
8845 e.insert(Mutex::new(PeerState {
8846 channel_by_id: HashMap::new(),
8847 inbound_channel_request_by_id: HashMap::new(),
8848 latest_features: init_msg.features.clone(),
8849 pending_msg_events: Vec::new(),
8850 in_flight_monitor_updates: BTreeMap::new(),
8851 monitor_update_blocked_actions: BTreeMap::new(),
8852 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8856 hash_map::Entry::Occupied(e) => {
8857 let mut peer_state = e.get().lock().unwrap();
8858 peer_state.latest_features = init_msg.features.clone();
8860 let best_block_height = self.best_block.read().unwrap().height();
8861 if inbound_peer_limited &&
8862 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
8863 peer_state.channel_by_id.len()
8866 return NotifyOption::SkipPersistNoEvents;
8869 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
8870 peer_state.is_connected = true;
8875 log_debug!(logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
8877 let per_peer_state = self.per_peer_state.read().unwrap();
8878 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8879 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8880 let peer_state = &mut *peer_state_lock;
8881 let pending_msg_events = &mut peer_state.pending_msg_events;
8883 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
8884 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else {
8885 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
8886 // (so won't be recovered after a crash), they shouldn't exist here and we would never need to
8887 // worry about closing and removing them.
8888 debug_assert!(false);
8892 let logger = WithChannelContext::from(&self.logger, &chan.context);
8893 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
8894 node_id: chan.context.get_counterparty_node_id(),
8895 msg: chan.get_channel_reestablish(&&logger),
8900 return NotifyOption::SkipPersistHandleEvents;
8901 //TODO: Also re-broadcast announcement_signatures
8906 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
8907 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8909 match &msg.data as &str {
8910 "cannot co-op close channel w/ active htlcs"|
8911 "link failed to shutdown" =>
8913 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
8914 // send one while HTLCs are still present. The issue is tracked at
8915 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
8916 // to fix it but none so far have managed to land upstream. The issue appears to be
8917 // very low priority for the LND team despite being marked "P1".
8918 // We're not going to bother handling this in a sensible way, instead simply
8919 // repeating the Shutdown message on repeat until morale improves.
8920 if !msg.channel_id.is_zero() {
8921 let per_peer_state = self.per_peer_state.read().unwrap();
8922 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8923 if peer_state_mutex_opt.is_none() { return; }
8924 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
8925 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
8926 if let Some(msg) = chan.get_outbound_shutdown() {
8927 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
8928 node_id: *counterparty_node_id,
8932 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
8933 node_id: *counterparty_node_id,
8934 action: msgs::ErrorAction::SendWarningMessage {
8935 msg: msgs::WarningMessage {
8936 channel_id: msg.channel_id,
8937 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
8939 log_level: Level::Trace,
8949 if msg.channel_id.is_zero() {
8950 let channel_ids: Vec<ChannelId> = {
8951 let per_peer_state = self.per_peer_state.read().unwrap();
8952 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8953 if peer_state_mutex_opt.is_none() { return; }
8954 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
8955 let peer_state = &mut *peer_state_lock;
8956 // Note that we don't bother generating any events for pre-accept channels -
8957 // they're not considered "channels" yet from the PoV of our events interface.
8958 peer_state.inbound_channel_request_by_id.clear();
8959 peer_state.channel_by_id.keys().cloned().collect()
8961 for channel_id in channel_ids {
8962 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
8963 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
8967 // First check if we can advance the channel type and try again.
8968 let per_peer_state = self.per_peer_state.read().unwrap();
8969 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8970 if peer_state_mutex_opt.is_none() { return; }
8971 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
8972 let peer_state = &mut *peer_state_lock;
8973 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
8974 if let Ok(msg) = chan.maybe_handle_error_without_close(self.chain_hash, &self.fee_estimator) {
8975 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
8976 node_id: *counterparty_node_id,
8984 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
8985 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
8989 fn provided_node_features(&self) -> NodeFeatures {
8990 provided_node_features(&self.default_configuration)
8993 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
8994 provided_init_features(&self.default_configuration)
8997 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
8998 Some(vec![self.chain_hash])
9001 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
9002 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9003 "Dual-funded channels not supported".to_owned(),
9004 msg.channel_id.clone())), *counterparty_node_id);
9007 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
9008 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9009 "Dual-funded channels not supported".to_owned(),
9010 msg.channel_id.clone())), *counterparty_node_id);
9013 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
9014 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9015 "Dual-funded channels not supported".to_owned(),
9016 msg.channel_id.clone())), *counterparty_node_id);
9019 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
9020 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9021 "Dual-funded channels not supported".to_owned(),
9022 msg.channel_id.clone())), *counterparty_node_id);
9025 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
9026 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9027 "Dual-funded channels not supported".to_owned(),
9028 msg.channel_id.clone())), *counterparty_node_id);
9031 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
9032 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9033 "Dual-funded channels not supported".to_owned(),
9034 msg.channel_id.clone())), *counterparty_node_id);
9037 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
9038 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9039 "Dual-funded channels not supported".to_owned(),
9040 msg.channel_id.clone())), *counterparty_node_id);
9043 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
9044 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9045 "Dual-funded channels not supported".to_owned(),
9046 msg.channel_id.clone())), *counterparty_node_id);
9049 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
9050 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9051 "Dual-funded channels not supported".to_owned(),
9052 msg.channel_id.clone())), *counterparty_node_id);
9056 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9057 OffersMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
9059 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9060 T::Target: BroadcasterInterface,
9061 ES::Target: EntropySource,
9062 NS::Target: NodeSigner,
9063 SP::Target: SignerProvider,
9064 F::Target: FeeEstimator,
9068 fn handle_message(&self, message: OffersMessage) -> Option<OffersMessage> {
9069 let secp_ctx = &self.secp_ctx;
9070 let expanded_key = &self.inbound_payment_key;
9073 OffersMessage::InvoiceRequest(invoice_request) => {
9074 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
9077 Ok(amount_msats) => Some(amount_msats),
9078 Err(error) => return Some(OffersMessage::InvoiceError(error.into())),
9080 let invoice_request = match invoice_request.verify(expanded_key, secp_ctx) {
9081 Ok(invoice_request) => invoice_request,
9083 let error = Bolt12SemanticError::InvalidMetadata;
9084 return Some(OffersMessage::InvoiceError(error.into()));
9087 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
9089 match self.create_inbound_payment(amount_msats, relative_expiry, None) {
9090 Ok((payment_hash, payment_secret)) if invoice_request.keys.is_some() => {
9091 let payment_paths = vec![
9092 self.create_one_hop_blinded_payment_path(payment_secret),
9094 #[cfg(not(feature = "no-std"))]
9095 let builder = invoice_request.respond_using_derived_keys(
9096 payment_paths, payment_hash
9098 #[cfg(feature = "no-std")]
9099 let created_at = Duration::from_secs(
9100 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9102 #[cfg(feature = "no-std")]
9103 let builder = invoice_request.respond_using_derived_keys_no_std(
9104 payment_paths, payment_hash, created_at
9106 match builder.and_then(|b| b.allow_mpp().build_and_sign(secp_ctx)) {
9107 Ok(invoice) => Some(OffersMessage::Invoice(invoice)),
9108 Err(error) => Some(OffersMessage::InvoiceError(error.into())),
9111 Ok((payment_hash, payment_secret)) => {
9112 let payment_paths = vec![
9113 self.create_one_hop_blinded_payment_path(payment_secret),
9115 #[cfg(not(feature = "no-std"))]
9116 let builder = invoice_request.respond_with(payment_paths, payment_hash);
9117 #[cfg(feature = "no-std")]
9118 let created_at = Duration::from_secs(
9119 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9121 #[cfg(feature = "no-std")]
9122 let builder = invoice_request.respond_with_no_std(
9123 payment_paths, payment_hash, created_at
9125 let response = builder.and_then(|builder| builder.allow_mpp().build())
9126 .map_err(|e| OffersMessage::InvoiceError(e.into()))
9128 match invoice.sign(|invoice| self.node_signer.sign_bolt12_invoice(invoice)) {
9129 Ok(invoice) => Ok(OffersMessage::Invoice(invoice)),
9130 Err(SignError::Signing(())) => Err(OffersMessage::InvoiceError(
9131 InvoiceError::from_string("Failed signing invoice".to_string())
9133 Err(SignError::Verification(_)) => Err(OffersMessage::InvoiceError(
9134 InvoiceError::from_string("Failed invoice signature verification".to_string())
9138 Ok(invoice) => Some(invoice),
9139 Err(error) => Some(error),
9143 Some(OffersMessage::InvoiceError(Bolt12SemanticError::InvalidAmount.into()))
9147 OffersMessage::Invoice(invoice) => {
9148 match invoice.verify(expanded_key, secp_ctx) {
9150 Some(OffersMessage::InvoiceError(InvoiceError::from_string("Unrecognized invoice".to_owned())))
9152 Ok(_) if invoice.invoice_features().requires_unknown_bits_from(&self.bolt12_invoice_features()) => {
9153 Some(OffersMessage::InvoiceError(Bolt12SemanticError::UnknownRequiredFeatures.into()))
9156 if let Err(e) = self.send_payment_for_bolt12_invoice(&invoice, payment_id) {
9157 log_trace!(self.logger, "Failed paying invoice: {:?}", e);
9158 Some(OffersMessage::InvoiceError(InvoiceError::from_string(format!("{:?}", e))))
9165 OffersMessage::InvoiceError(invoice_error) => {
9166 log_trace!(self.logger, "Received invoice_error: {}", invoice_error);
9172 fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> {
9173 core::mem::take(&mut self.pending_offers_messages.lock().unwrap())
9177 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
9178 /// [`ChannelManager`].
9179 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
9180 let mut node_features = provided_init_features(config).to_context();
9181 node_features.set_keysend_optional();
9185 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
9186 /// [`ChannelManager`].
9188 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
9189 /// or not. Thus, this method is not public.
9190 #[cfg(any(feature = "_test_utils", test))]
9191 pub(crate) fn provided_bolt11_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
9192 provided_init_features(config).to_context()
9195 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
9196 /// [`ChannelManager`].
9197 pub(crate) fn provided_bolt12_invoice_features(config: &UserConfig) -> Bolt12InvoiceFeatures {
9198 provided_init_features(config).to_context()
9201 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
9202 /// [`ChannelManager`].
9203 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
9204 provided_init_features(config).to_context()
9207 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
9208 /// [`ChannelManager`].
9209 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
9210 ChannelTypeFeatures::from_init(&provided_init_features(config))
9213 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
9214 /// [`ChannelManager`].
9215 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
9216 // Note that if new features are added here which other peers may (eventually) require, we
9217 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
9218 // [`ErroringMessageHandler`].
9219 let mut features = InitFeatures::empty();
9220 features.set_data_loss_protect_required();
9221 features.set_upfront_shutdown_script_optional();
9222 features.set_variable_length_onion_required();
9223 features.set_static_remote_key_required();
9224 features.set_payment_secret_required();
9225 features.set_basic_mpp_optional();
9226 features.set_wumbo_optional();
9227 features.set_shutdown_any_segwit_optional();
9228 features.set_channel_type_optional();
9229 features.set_scid_privacy_optional();
9230 features.set_zero_conf_optional();
9231 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
9232 features.set_anchors_zero_fee_htlc_tx_optional();
9237 const SERIALIZATION_VERSION: u8 = 1;
9238 const MIN_SERIALIZATION_VERSION: u8 = 1;
9240 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
9241 (2, fee_base_msat, required),
9242 (4, fee_proportional_millionths, required),
9243 (6, cltv_expiry_delta, required),
9246 impl_writeable_tlv_based!(ChannelCounterparty, {
9247 (2, node_id, required),
9248 (4, features, required),
9249 (6, unspendable_punishment_reserve, required),
9250 (8, forwarding_info, option),
9251 (9, outbound_htlc_minimum_msat, option),
9252 (11, outbound_htlc_maximum_msat, option),
9255 impl Writeable for ChannelDetails {
9256 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9257 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9258 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9259 let user_channel_id_low = self.user_channel_id as u64;
9260 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
9261 write_tlv_fields!(writer, {
9262 (1, self.inbound_scid_alias, option),
9263 (2, self.channel_id, required),
9264 (3, self.channel_type, option),
9265 (4, self.counterparty, required),
9266 (5, self.outbound_scid_alias, option),
9267 (6, self.funding_txo, option),
9268 (7, self.config, option),
9269 (8, self.short_channel_id, option),
9270 (9, self.confirmations, option),
9271 (10, self.channel_value_satoshis, required),
9272 (12, self.unspendable_punishment_reserve, option),
9273 (14, user_channel_id_low, required),
9274 (16, self.balance_msat, required),
9275 (18, self.outbound_capacity_msat, required),
9276 (19, self.next_outbound_htlc_limit_msat, required),
9277 (20, self.inbound_capacity_msat, required),
9278 (21, self.next_outbound_htlc_minimum_msat, required),
9279 (22, self.confirmations_required, option),
9280 (24, self.force_close_spend_delay, option),
9281 (26, self.is_outbound, required),
9282 (28, self.is_channel_ready, required),
9283 (30, self.is_usable, required),
9284 (32, self.is_public, required),
9285 (33, self.inbound_htlc_minimum_msat, option),
9286 (35, self.inbound_htlc_maximum_msat, option),
9287 (37, user_channel_id_high_opt, option),
9288 (39, self.feerate_sat_per_1000_weight, option),
9289 (41, self.channel_shutdown_state, option),
9295 impl Readable for ChannelDetails {
9296 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9297 _init_and_read_len_prefixed_tlv_fields!(reader, {
9298 (1, inbound_scid_alias, option),
9299 (2, channel_id, required),
9300 (3, channel_type, option),
9301 (4, counterparty, required),
9302 (5, outbound_scid_alias, option),
9303 (6, funding_txo, option),
9304 (7, config, option),
9305 (8, short_channel_id, option),
9306 (9, confirmations, option),
9307 (10, channel_value_satoshis, required),
9308 (12, unspendable_punishment_reserve, option),
9309 (14, user_channel_id_low, required),
9310 (16, balance_msat, required),
9311 (18, outbound_capacity_msat, required),
9312 // Note that by the time we get past the required read above, outbound_capacity_msat will be
9313 // filled in, so we can safely unwrap it here.
9314 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
9315 (20, inbound_capacity_msat, required),
9316 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
9317 (22, confirmations_required, option),
9318 (24, force_close_spend_delay, option),
9319 (26, is_outbound, required),
9320 (28, is_channel_ready, required),
9321 (30, is_usable, required),
9322 (32, is_public, required),
9323 (33, inbound_htlc_minimum_msat, option),
9324 (35, inbound_htlc_maximum_msat, option),
9325 (37, user_channel_id_high_opt, option),
9326 (39, feerate_sat_per_1000_weight, option),
9327 (41, channel_shutdown_state, option),
9330 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9331 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9332 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
9333 let user_channel_id = user_channel_id_low as u128 +
9334 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
9338 channel_id: channel_id.0.unwrap(),
9340 counterparty: counterparty.0.unwrap(),
9341 outbound_scid_alias,
9345 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
9346 unspendable_punishment_reserve,
9348 balance_msat: balance_msat.0.unwrap(),
9349 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
9350 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
9351 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
9352 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
9353 confirmations_required,
9355 force_close_spend_delay,
9356 is_outbound: is_outbound.0.unwrap(),
9357 is_channel_ready: is_channel_ready.0.unwrap(),
9358 is_usable: is_usable.0.unwrap(),
9359 is_public: is_public.0.unwrap(),
9360 inbound_htlc_minimum_msat,
9361 inbound_htlc_maximum_msat,
9362 feerate_sat_per_1000_weight,
9363 channel_shutdown_state,
9368 impl_writeable_tlv_based!(PhantomRouteHints, {
9369 (2, channels, required_vec),
9370 (4, phantom_scid, required),
9371 (6, real_node_pubkey, required),
9374 impl_writeable_tlv_based!(BlindedForward, {
9375 (0, inbound_blinding_point, required),
9378 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
9380 (0, onion_packet, required),
9381 (1, blinded, option),
9382 (2, short_channel_id, required),
9385 (0, payment_data, required),
9386 (1, phantom_shared_secret, option),
9387 (2, incoming_cltv_expiry, required),
9388 (3, payment_metadata, option),
9389 (5, custom_tlvs, optional_vec),
9390 (7, requires_blinded_error, (default_value, false)),
9392 (2, ReceiveKeysend) => {
9393 (0, payment_preimage, required),
9394 (2, incoming_cltv_expiry, required),
9395 (3, payment_metadata, option),
9396 (4, payment_data, option), // Added in 0.0.116
9397 (5, custom_tlvs, optional_vec),
9401 impl_writeable_tlv_based!(PendingHTLCInfo, {
9402 (0, routing, required),
9403 (2, incoming_shared_secret, required),
9404 (4, payment_hash, required),
9405 (6, outgoing_amt_msat, required),
9406 (8, outgoing_cltv_value, required),
9407 (9, incoming_amt_msat, option),
9408 (10, skimmed_fee_msat, option),
9412 impl Writeable for HTLCFailureMsg {
9413 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9415 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
9417 channel_id.write(writer)?;
9418 htlc_id.write(writer)?;
9419 reason.write(writer)?;
9421 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9422 channel_id, htlc_id, sha256_of_onion, failure_code
9425 channel_id.write(writer)?;
9426 htlc_id.write(writer)?;
9427 sha256_of_onion.write(writer)?;
9428 failure_code.write(writer)?;
9435 impl Readable for HTLCFailureMsg {
9436 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9437 let id: u8 = Readable::read(reader)?;
9440 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
9441 channel_id: Readable::read(reader)?,
9442 htlc_id: Readable::read(reader)?,
9443 reason: Readable::read(reader)?,
9447 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9448 channel_id: Readable::read(reader)?,
9449 htlc_id: Readable::read(reader)?,
9450 sha256_of_onion: Readable::read(reader)?,
9451 failure_code: Readable::read(reader)?,
9454 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
9455 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
9456 // messages contained in the variants.
9457 // In version 0.0.101, support for reading the variants with these types was added, and
9458 // we should migrate to writing these variants when UpdateFailHTLC or
9459 // UpdateFailMalformedHTLC get TLV fields.
9461 let length: BigSize = Readable::read(reader)?;
9462 let mut s = FixedLengthReader::new(reader, length.0);
9463 let res = Readable::read(&mut s)?;
9464 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9465 Ok(HTLCFailureMsg::Relay(res))
9468 let length: BigSize = Readable::read(reader)?;
9469 let mut s = FixedLengthReader::new(reader, length.0);
9470 let res = Readable::read(&mut s)?;
9471 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9472 Ok(HTLCFailureMsg::Malformed(res))
9474 _ => Err(DecodeError::UnknownRequiredFeature),
9479 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
9484 impl_writeable_tlv_based_enum!(BlindedFailure,
9485 (0, FromIntroductionNode) => {},
9486 (2, FromBlindedNode) => {}, ;
9489 impl_writeable_tlv_based!(HTLCPreviousHopData, {
9490 (0, short_channel_id, required),
9491 (1, phantom_shared_secret, option),
9492 (2, outpoint, required),
9493 (3, blinded_failure, option),
9494 (4, htlc_id, required),
9495 (6, incoming_packet_shared_secret, required),
9496 (7, user_channel_id, option),
9499 impl Writeable for ClaimableHTLC {
9500 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9501 let (payment_data, keysend_preimage) = match &self.onion_payload {
9502 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
9503 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
9505 write_tlv_fields!(writer, {
9506 (0, self.prev_hop, required),
9507 (1, self.total_msat, required),
9508 (2, self.value, required),
9509 (3, self.sender_intended_value, required),
9510 (4, payment_data, option),
9511 (5, self.total_value_received, option),
9512 (6, self.cltv_expiry, required),
9513 (8, keysend_preimage, option),
9514 (10, self.counterparty_skimmed_fee_msat, option),
9520 impl Readable for ClaimableHTLC {
9521 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9522 _init_and_read_len_prefixed_tlv_fields!(reader, {
9523 (0, prev_hop, required),
9524 (1, total_msat, option),
9525 (2, value_ser, required),
9526 (3, sender_intended_value, option),
9527 (4, payment_data_opt, option),
9528 (5, total_value_received, option),
9529 (6, cltv_expiry, required),
9530 (8, keysend_preimage, option),
9531 (10, counterparty_skimmed_fee_msat, option),
9533 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
9534 let value = value_ser.0.unwrap();
9535 let onion_payload = match keysend_preimage {
9537 if payment_data.is_some() {
9538 return Err(DecodeError::InvalidValue)
9540 if total_msat.is_none() {
9541 total_msat = Some(value);
9543 OnionPayload::Spontaneous(p)
9546 if total_msat.is_none() {
9547 if payment_data.is_none() {
9548 return Err(DecodeError::InvalidValue)
9550 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
9552 OnionPayload::Invoice { _legacy_hop_data: payment_data }
9556 prev_hop: prev_hop.0.unwrap(),
9559 sender_intended_value: sender_intended_value.unwrap_or(value),
9560 total_value_received,
9561 total_msat: total_msat.unwrap(),
9563 cltv_expiry: cltv_expiry.0.unwrap(),
9564 counterparty_skimmed_fee_msat,
9569 impl Readable for HTLCSource {
9570 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9571 let id: u8 = Readable::read(reader)?;
9574 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
9575 let mut first_hop_htlc_msat: u64 = 0;
9576 let mut path_hops = Vec::new();
9577 let mut payment_id = None;
9578 let mut payment_params: Option<PaymentParameters> = None;
9579 let mut blinded_tail: Option<BlindedTail> = None;
9580 read_tlv_fields!(reader, {
9581 (0, session_priv, required),
9582 (1, payment_id, option),
9583 (2, first_hop_htlc_msat, required),
9584 (4, path_hops, required_vec),
9585 (5, payment_params, (option: ReadableArgs, 0)),
9586 (6, blinded_tail, option),
9588 if payment_id.is_none() {
9589 // For backwards compat, if there was no payment_id written, use the session_priv bytes
9591 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
9593 let path = Path { hops: path_hops, blinded_tail };
9594 if path.hops.len() == 0 {
9595 return Err(DecodeError::InvalidValue);
9597 if let Some(params) = payment_params.as_mut() {
9598 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
9599 if final_cltv_expiry_delta == &0 {
9600 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
9604 Ok(HTLCSource::OutboundRoute {
9605 session_priv: session_priv.0.unwrap(),
9606 first_hop_htlc_msat,
9608 payment_id: payment_id.unwrap(),
9611 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
9612 _ => Err(DecodeError::UnknownRequiredFeature),
9617 impl Writeable for HTLCSource {
9618 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
9620 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
9622 let payment_id_opt = Some(payment_id);
9623 write_tlv_fields!(writer, {
9624 (0, session_priv, required),
9625 (1, payment_id_opt, option),
9626 (2, first_hop_htlc_msat, required),
9627 // 3 was previously used to write a PaymentSecret for the payment.
9628 (4, path.hops, required_vec),
9629 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
9630 (6, path.blinded_tail, option),
9633 HTLCSource::PreviousHopData(ref field) => {
9635 field.write(writer)?;
9642 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
9643 (0, forward_info, required),
9644 (1, prev_user_channel_id, (default_value, 0)),
9645 (2, prev_short_channel_id, required),
9646 (4, prev_htlc_id, required),
9647 (6, prev_funding_outpoint, required),
9650 impl Writeable for HTLCForwardInfo {
9651 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9652 const FAIL_HTLC_VARIANT_ID: u8 = 1;
9654 Self::AddHTLC(info) => {
9658 Self::FailHTLC { htlc_id, err_packet } => {
9659 FAIL_HTLC_VARIANT_ID.write(w)?;
9660 write_tlv_fields!(w, {
9661 (0, htlc_id, required),
9662 (2, err_packet, required),
9665 Self::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
9666 // Since this variant was added in 0.0.119, write this as `::FailHTLC` with an empty error
9667 // packet so older versions have something to fail back with, but serialize the real data as
9668 // optional TLVs for the benefit of newer versions.
9669 FAIL_HTLC_VARIANT_ID.write(w)?;
9670 let dummy_err_packet = msgs::OnionErrorPacket { data: Vec::new() };
9671 write_tlv_fields!(w, {
9672 (0, htlc_id, required),
9673 (1, failure_code, required),
9674 (2, dummy_err_packet, required),
9675 (3, sha256_of_onion, required),
9683 impl Readable for HTLCForwardInfo {
9684 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
9685 let id: u8 = Readable::read(r)?;
9687 0 => Self::AddHTLC(Readable::read(r)?),
9689 _init_and_read_len_prefixed_tlv_fields!(r, {
9690 (0, htlc_id, required),
9691 (1, malformed_htlc_failure_code, option),
9692 (2, err_packet, required),
9693 (3, sha256_of_onion, option),
9695 if let Some(failure_code) = malformed_htlc_failure_code {
9696 Self::FailMalformedHTLC {
9697 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9699 sha256_of_onion: sha256_of_onion.ok_or(DecodeError::InvalidValue)?,
9703 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9704 err_packet: _init_tlv_based_struct_field!(err_packet, required),
9708 _ => return Err(DecodeError::InvalidValue),
9713 impl_writeable_tlv_based!(PendingInboundPayment, {
9714 (0, payment_secret, required),
9715 (2, expiry_time, required),
9716 (4, user_payment_id, required),
9717 (6, payment_preimage, required),
9718 (8, min_value_msat, required),
9721 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>
9723 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9724 T::Target: BroadcasterInterface,
9725 ES::Target: EntropySource,
9726 NS::Target: NodeSigner,
9727 SP::Target: SignerProvider,
9728 F::Target: FeeEstimator,
9732 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9733 let _consistency_lock = self.total_consistency_lock.write().unwrap();
9735 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
9737 self.chain_hash.write(writer)?;
9739 let best_block = self.best_block.read().unwrap();
9740 best_block.height().write(writer)?;
9741 best_block.block_hash().write(writer)?;
9744 let mut serializable_peer_count: u64 = 0;
9746 let per_peer_state = self.per_peer_state.read().unwrap();
9747 let mut number_of_funded_channels = 0;
9748 for (_, peer_state_mutex) in per_peer_state.iter() {
9749 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9750 let peer_state = &mut *peer_state_lock;
9751 if !peer_state.ok_to_remove(false) {
9752 serializable_peer_count += 1;
9755 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
9756 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_broadcast() } else { false }
9760 (number_of_funded_channels as u64).write(writer)?;
9762 for (_, peer_state_mutex) in per_peer_state.iter() {
9763 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9764 let peer_state = &mut *peer_state_lock;
9765 for channel in peer_state.channel_by_id.iter().filter_map(
9766 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
9767 if channel.context.is_funding_broadcast() { Some(channel) } else { None }
9770 channel.write(writer)?;
9776 let forward_htlcs = self.forward_htlcs.lock().unwrap();
9777 (forward_htlcs.len() as u64).write(writer)?;
9778 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
9779 short_channel_id.write(writer)?;
9780 (pending_forwards.len() as u64).write(writer)?;
9781 for forward in pending_forwards {
9782 forward.write(writer)?;
9787 let per_peer_state = self.per_peer_state.write().unwrap();
9789 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
9790 let claimable_payments = self.claimable_payments.lock().unwrap();
9791 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
9793 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
9794 let mut htlc_onion_fields: Vec<&_> = Vec::new();
9795 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
9796 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
9797 payment_hash.write(writer)?;
9798 (payment.htlcs.len() as u64).write(writer)?;
9799 for htlc in payment.htlcs.iter() {
9800 htlc.write(writer)?;
9802 htlc_purposes.push(&payment.purpose);
9803 htlc_onion_fields.push(&payment.onion_fields);
9806 let mut monitor_update_blocked_actions_per_peer = None;
9807 let mut peer_states = Vec::new();
9808 for (_, peer_state_mutex) in per_peer_state.iter() {
9809 // Because we're holding the owning `per_peer_state` write lock here there's no chance
9810 // of a lockorder violation deadlock - no other thread can be holding any
9811 // per_peer_state lock at all.
9812 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
9815 (serializable_peer_count).write(writer)?;
9816 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9817 // Peers which we have no channels to should be dropped once disconnected. As we
9818 // disconnect all peers when shutting down and serializing the ChannelManager, we
9819 // consider all peers as disconnected here. There's therefore no need write peers with
9821 if !peer_state.ok_to_remove(false) {
9822 peer_pubkey.write(writer)?;
9823 peer_state.latest_features.write(writer)?;
9824 if !peer_state.monitor_update_blocked_actions.is_empty() {
9825 monitor_update_blocked_actions_per_peer
9826 .get_or_insert_with(Vec::new)
9827 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
9832 let events = self.pending_events.lock().unwrap();
9833 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
9834 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
9835 // refuse to read the new ChannelManager.
9836 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
9837 if events_not_backwards_compatible {
9838 // If we're gonna write a even TLV that will overwrite our events anyway we might as
9839 // well save the space and not write any events here.
9840 0u64.write(writer)?;
9842 (events.len() as u64).write(writer)?;
9843 for (event, _) in events.iter() {
9844 event.write(writer)?;
9848 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
9849 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
9850 // the closing monitor updates were always effectively replayed on startup (either directly
9851 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
9852 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
9853 0u64.write(writer)?;
9855 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
9856 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
9857 // likely to be identical.
9858 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
9859 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
9861 (pending_inbound_payments.len() as u64).write(writer)?;
9862 for (hash, pending_payment) in pending_inbound_payments.iter() {
9863 hash.write(writer)?;
9864 pending_payment.write(writer)?;
9867 // For backwards compat, write the session privs and their total length.
9868 let mut num_pending_outbounds_compat: u64 = 0;
9869 for (_, outbound) in pending_outbound_payments.iter() {
9870 if !outbound.is_fulfilled() && !outbound.abandoned() {
9871 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
9874 num_pending_outbounds_compat.write(writer)?;
9875 for (_, outbound) in pending_outbound_payments.iter() {
9877 PendingOutboundPayment::Legacy { session_privs } |
9878 PendingOutboundPayment::Retryable { session_privs, .. } => {
9879 for session_priv in session_privs.iter() {
9880 session_priv.write(writer)?;
9883 PendingOutboundPayment::AwaitingInvoice { .. } => {},
9884 PendingOutboundPayment::InvoiceReceived { .. } => {},
9885 PendingOutboundPayment::Fulfilled { .. } => {},
9886 PendingOutboundPayment::Abandoned { .. } => {},
9890 // Encode without retry info for 0.0.101 compatibility.
9891 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
9892 for (id, outbound) in pending_outbound_payments.iter() {
9894 PendingOutboundPayment::Legacy { session_privs } |
9895 PendingOutboundPayment::Retryable { session_privs, .. } => {
9896 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
9902 let mut pending_intercepted_htlcs = None;
9903 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
9904 if our_pending_intercepts.len() != 0 {
9905 pending_intercepted_htlcs = Some(our_pending_intercepts);
9908 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
9909 if pending_claiming_payments.as_ref().unwrap().is_empty() {
9910 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
9911 // map. Thus, if there are no entries we skip writing a TLV for it.
9912 pending_claiming_payments = None;
9915 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
9916 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9917 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
9918 if !updates.is_empty() {
9919 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
9920 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
9925 write_tlv_fields!(writer, {
9926 (1, pending_outbound_payments_no_retry, required),
9927 (2, pending_intercepted_htlcs, option),
9928 (3, pending_outbound_payments, required),
9929 (4, pending_claiming_payments, option),
9930 (5, self.our_network_pubkey, required),
9931 (6, monitor_update_blocked_actions_per_peer, option),
9932 (7, self.fake_scid_rand_bytes, required),
9933 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
9934 (9, htlc_purposes, required_vec),
9935 (10, in_flight_monitor_updates, option),
9936 (11, self.probing_cookie_secret, required),
9937 (13, htlc_onion_fields, optional_vec),
9944 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
9945 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9946 (self.len() as u64).write(w)?;
9947 for (event, action) in self.iter() {
9950 #[cfg(debug_assertions)] {
9951 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
9952 // be persisted and are regenerated on restart. However, if such an event has a
9953 // post-event-handling action we'll write nothing for the event and would have to
9954 // either forget the action or fail on deserialization (which we do below). Thus,
9955 // check that the event is sane here.
9956 let event_encoded = event.encode();
9957 let event_read: Option<Event> =
9958 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
9959 if action.is_some() { assert!(event_read.is_some()); }
9965 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
9966 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9967 let len: u64 = Readable::read(reader)?;
9968 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
9969 let mut events: Self = VecDeque::with_capacity(cmp::min(
9970 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
9973 let ev_opt = MaybeReadable::read(reader)?;
9974 let action = Readable::read(reader)?;
9975 if let Some(ev) = ev_opt {
9976 events.push_back((ev, action));
9977 } else if action.is_some() {
9978 return Err(DecodeError::InvalidValue);
9985 impl_writeable_tlv_based_enum!(ChannelShutdownState,
9986 (0, NotShuttingDown) => {},
9987 (2, ShutdownInitiated) => {},
9988 (4, ResolvingHTLCs) => {},
9989 (6, NegotiatingClosingFee) => {},
9990 (8, ShutdownComplete) => {}, ;
9993 /// Arguments for the creation of a ChannelManager that are not deserialized.
9995 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
9997 /// 1) Deserialize all stored [`ChannelMonitor`]s.
9998 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
9999 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
10000 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
10001 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
10002 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
10003 /// same way you would handle a [`chain::Filter`] call using
10004 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
10005 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
10006 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
10007 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
10008 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
10009 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
10011 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
10012 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
10014 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
10015 /// call any other methods on the newly-deserialized [`ChannelManager`].
10017 /// Note that because some channels may be closed during deserialization, it is critical that you
10018 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
10019 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
10020 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
10021 /// not force-close the same channels but consider them live), you may end up revoking a state for
10022 /// which you've already broadcasted the transaction.
10024 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
10025 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10027 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10028 T::Target: BroadcasterInterface,
10029 ES::Target: EntropySource,
10030 NS::Target: NodeSigner,
10031 SP::Target: SignerProvider,
10032 F::Target: FeeEstimator,
10036 /// A cryptographically secure source of entropy.
10037 pub entropy_source: ES,
10039 /// A signer that is able to perform node-scoped cryptographic operations.
10040 pub node_signer: NS,
10042 /// The keys provider which will give us relevant keys. Some keys will be loaded during
10043 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
10045 pub signer_provider: SP,
10047 /// The fee_estimator for use in the ChannelManager in the future.
10049 /// No calls to the FeeEstimator will be made during deserialization.
10050 pub fee_estimator: F,
10051 /// The chain::Watch for use in the ChannelManager in the future.
10053 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
10054 /// you have deserialized ChannelMonitors separately and will add them to your
10055 /// chain::Watch after deserializing this ChannelManager.
10056 pub chain_monitor: M,
10058 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
10059 /// used to broadcast the latest local commitment transactions of channels which must be
10060 /// force-closed during deserialization.
10061 pub tx_broadcaster: T,
10062 /// The router which will be used in the ChannelManager in the future for finding routes
10063 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
10065 /// No calls to the router will be made during deserialization.
10067 /// The Logger for use in the ChannelManager and which may be used to log information during
10068 /// deserialization.
10070 /// Default settings used for new channels. Any existing channels will continue to use the
10071 /// runtime settings which were stored when the ChannelManager was serialized.
10072 pub default_config: UserConfig,
10074 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
10075 /// value.context.get_funding_txo() should be the key).
10077 /// If a monitor is inconsistent with the channel state during deserialization the channel will
10078 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
10079 /// is true for missing channels as well. If there is a monitor missing for which we find
10080 /// channel data Err(DecodeError::InvalidValue) will be returned.
10082 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
10085 /// This is not exported to bindings users because we have no HashMap bindings
10086 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>,
10089 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10090 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
10092 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10093 T::Target: BroadcasterInterface,
10094 ES::Target: EntropySource,
10095 NS::Target: NodeSigner,
10096 SP::Target: SignerProvider,
10097 F::Target: FeeEstimator,
10101 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
10102 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
10103 /// populate a HashMap directly from C.
10104 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,
10105 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>) -> Self {
10107 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
10108 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
10113 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
10114 // SipmleArcChannelManager type:
10115 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10116 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
10118 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10119 T::Target: BroadcasterInterface,
10120 ES::Target: EntropySource,
10121 NS::Target: NodeSigner,
10122 SP::Target: SignerProvider,
10123 F::Target: FeeEstimator,
10127 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10128 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
10129 Ok((blockhash, Arc::new(chan_manager)))
10133 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10134 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
10136 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10137 T::Target: BroadcasterInterface,
10138 ES::Target: EntropySource,
10139 NS::Target: NodeSigner,
10140 SP::Target: SignerProvider,
10141 F::Target: FeeEstimator,
10145 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10146 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
10148 let chain_hash: ChainHash = Readable::read(reader)?;
10149 let best_block_height: u32 = Readable::read(reader)?;
10150 let best_block_hash: BlockHash = Readable::read(reader)?;
10152 let mut failed_htlcs = Vec::new();
10154 let channel_count: u64 = Readable::read(reader)?;
10155 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
10156 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10157 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10158 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10159 let mut channel_closures = VecDeque::new();
10160 let mut close_background_events = Vec::new();
10161 for _ in 0..channel_count {
10162 let mut channel: Channel<SP> = Channel::read(reader, (
10163 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
10165 let logger = WithChannelContext::from(&args.logger, &channel.context);
10166 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10167 funding_txo_set.insert(funding_txo.clone());
10168 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
10169 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
10170 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
10171 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
10172 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10173 // But if the channel is behind of the monitor, close the channel:
10174 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
10175 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
10176 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10177 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
10178 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
10180 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
10181 log_error!(logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
10182 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
10184 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
10185 log_error!(logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
10186 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
10188 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
10189 log_error!(logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
10190 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
10192 let mut shutdown_result = channel.context.force_shutdown(true);
10193 if shutdown_result.unbroadcasted_batch_funding_txid.is_some() {
10194 return Err(DecodeError::InvalidValue);
10196 if let Some((counterparty_node_id, funding_txo, update)) = shutdown_result.monitor_update {
10197 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10198 counterparty_node_id, funding_txo, update
10201 failed_htlcs.append(&mut shutdown_result.dropped_outbound_htlcs);
10202 channel_closures.push_back((events::Event::ChannelClosed {
10203 channel_id: channel.context.channel_id(),
10204 user_channel_id: channel.context.get_user_id(),
10205 reason: ClosureReason::OutdatedChannelManager,
10206 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10207 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10209 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
10210 let mut found_htlc = false;
10211 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
10212 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
10215 // If we have some HTLCs in the channel which are not present in the newer
10216 // ChannelMonitor, they have been removed and should be failed back to
10217 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
10218 // were actually claimed we'd have generated and ensured the previous-hop
10219 // claim update ChannelMonitor updates were persisted prior to persising
10220 // the ChannelMonitor update for the forward leg, so attempting to fail the
10221 // backwards leg of the HTLC will simply be rejected.
10223 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
10224 &channel.context.channel_id(), &payment_hash);
10225 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10229 log_info!(logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
10230 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
10231 monitor.get_latest_update_id());
10232 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
10233 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10235 if channel.context.is_funding_broadcast() {
10236 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
10238 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
10239 hash_map::Entry::Occupied(mut entry) => {
10240 let by_id_map = entry.get_mut();
10241 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10243 hash_map::Entry::Vacant(entry) => {
10244 let mut by_id_map = HashMap::new();
10245 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10246 entry.insert(by_id_map);
10250 } else if channel.is_awaiting_initial_mon_persist() {
10251 // If we were persisted and shut down while the initial ChannelMonitor persistence
10252 // was in-progress, we never broadcasted the funding transaction and can still
10253 // safely discard the channel.
10254 let _ = channel.context.force_shutdown(false);
10255 channel_closures.push_back((events::Event::ChannelClosed {
10256 channel_id: channel.context.channel_id(),
10257 user_channel_id: channel.context.get_user_id(),
10258 reason: ClosureReason::DisconnectedPeer,
10259 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10260 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10263 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
10264 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10265 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10266 log_error!(logger, " Without the ChannelMonitor we cannot continue without risking funds.");
10267 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10268 return Err(DecodeError::InvalidValue);
10272 for (funding_txo, monitor) in args.channel_monitors.iter() {
10273 if !funding_txo_set.contains(funding_txo) {
10274 let logger = WithChannelMonitor::from(&args.logger, monitor);
10275 log_info!(logger, "Queueing monitor update to ensure missing channel {} is force closed",
10276 &funding_txo.to_channel_id());
10277 let monitor_update = ChannelMonitorUpdate {
10278 update_id: CLOSED_CHANNEL_UPDATE_ID,
10279 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
10281 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
10285 const MAX_ALLOC_SIZE: usize = 1024 * 64;
10286 let forward_htlcs_count: u64 = Readable::read(reader)?;
10287 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
10288 for _ in 0..forward_htlcs_count {
10289 let short_channel_id = Readable::read(reader)?;
10290 let pending_forwards_count: u64 = Readable::read(reader)?;
10291 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
10292 for _ in 0..pending_forwards_count {
10293 pending_forwards.push(Readable::read(reader)?);
10295 forward_htlcs.insert(short_channel_id, pending_forwards);
10298 let claimable_htlcs_count: u64 = Readable::read(reader)?;
10299 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
10300 for _ in 0..claimable_htlcs_count {
10301 let payment_hash = Readable::read(reader)?;
10302 let previous_hops_len: u64 = Readable::read(reader)?;
10303 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
10304 for _ in 0..previous_hops_len {
10305 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
10307 claimable_htlcs_list.push((payment_hash, previous_hops));
10310 let peer_state_from_chans = |channel_by_id| {
10313 inbound_channel_request_by_id: HashMap::new(),
10314 latest_features: InitFeatures::empty(),
10315 pending_msg_events: Vec::new(),
10316 in_flight_monitor_updates: BTreeMap::new(),
10317 monitor_update_blocked_actions: BTreeMap::new(),
10318 actions_blocking_raa_monitor_updates: BTreeMap::new(),
10319 is_connected: false,
10323 let peer_count: u64 = Readable::read(reader)?;
10324 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
10325 for _ in 0..peer_count {
10326 let peer_pubkey = Readable::read(reader)?;
10327 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
10328 let mut peer_state = peer_state_from_chans(peer_chans);
10329 peer_state.latest_features = Readable::read(reader)?;
10330 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
10333 let event_count: u64 = Readable::read(reader)?;
10334 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
10335 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
10336 for _ in 0..event_count {
10337 match MaybeReadable::read(reader)? {
10338 Some(event) => pending_events_read.push_back((event, None)),
10343 let background_event_count: u64 = Readable::read(reader)?;
10344 for _ in 0..background_event_count {
10345 match <u8 as Readable>::read(reader)? {
10347 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
10348 // however we really don't (and never did) need them - we regenerate all
10349 // on-startup monitor updates.
10350 let _: OutPoint = Readable::read(reader)?;
10351 let _: ChannelMonitorUpdate = Readable::read(reader)?;
10353 _ => return Err(DecodeError::InvalidValue),
10357 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
10358 let highest_seen_timestamp: u32 = Readable::read(reader)?;
10360 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
10361 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
10362 for _ in 0..pending_inbound_payment_count {
10363 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
10364 return Err(DecodeError::InvalidValue);
10368 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
10369 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
10370 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
10371 for _ in 0..pending_outbound_payments_count_compat {
10372 let session_priv = Readable::read(reader)?;
10373 let payment = PendingOutboundPayment::Legacy {
10374 session_privs: [session_priv].iter().cloned().collect()
10376 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
10377 return Err(DecodeError::InvalidValue)
10381 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
10382 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
10383 let mut pending_outbound_payments = None;
10384 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
10385 let mut received_network_pubkey: Option<PublicKey> = None;
10386 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
10387 let mut probing_cookie_secret: Option<[u8; 32]> = None;
10388 let mut claimable_htlc_purposes = None;
10389 let mut claimable_htlc_onion_fields = None;
10390 let mut pending_claiming_payments = Some(HashMap::new());
10391 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
10392 let mut events_override = None;
10393 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
10394 read_tlv_fields!(reader, {
10395 (1, pending_outbound_payments_no_retry, option),
10396 (2, pending_intercepted_htlcs, option),
10397 (3, pending_outbound_payments, option),
10398 (4, pending_claiming_payments, option),
10399 (5, received_network_pubkey, option),
10400 (6, monitor_update_blocked_actions_per_peer, option),
10401 (7, fake_scid_rand_bytes, option),
10402 (8, events_override, option),
10403 (9, claimable_htlc_purposes, optional_vec),
10404 (10, in_flight_monitor_updates, option),
10405 (11, probing_cookie_secret, option),
10406 (13, claimable_htlc_onion_fields, optional_vec),
10408 if fake_scid_rand_bytes.is_none() {
10409 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
10412 if probing_cookie_secret.is_none() {
10413 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
10416 if let Some(events) = events_override {
10417 pending_events_read = events;
10420 if !channel_closures.is_empty() {
10421 pending_events_read.append(&mut channel_closures);
10424 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
10425 pending_outbound_payments = Some(pending_outbound_payments_compat);
10426 } else if pending_outbound_payments.is_none() {
10427 let mut outbounds = HashMap::new();
10428 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
10429 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
10431 pending_outbound_payments = Some(outbounds);
10433 let pending_outbounds = OutboundPayments {
10434 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
10435 retry_lock: Mutex::new(())
10438 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
10439 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
10440 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
10441 // replayed, and for each monitor update we have to replay we have to ensure there's a
10442 // `ChannelMonitor` for it.
10444 // In order to do so we first walk all of our live channels (so that we can check their
10445 // state immediately after doing the update replays, when we have the `update_id`s
10446 // available) and then walk any remaining in-flight updates.
10448 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
10449 let mut pending_background_events = Vec::new();
10450 macro_rules! handle_in_flight_updates {
10451 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
10452 $monitor: expr, $peer_state: expr, $logger: expr, $channel_info_log: expr
10454 let mut max_in_flight_update_id = 0;
10455 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
10456 for update in $chan_in_flight_upds.iter() {
10457 log_trace!($logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
10458 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
10459 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
10460 pending_background_events.push(
10461 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10462 counterparty_node_id: $counterparty_node_id,
10463 funding_txo: $funding_txo,
10464 update: update.clone(),
10467 if $chan_in_flight_upds.is_empty() {
10468 // We had some updates to apply, but it turns out they had completed before we
10469 // were serialized, we just weren't notified of that. Thus, we may have to run
10470 // the completion actions for any monitor updates, but otherwise are done.
10471 pending_background_events.push(
10472 BackgroundEvent::MonitorUpdatesComplete {
10473 counterparty_node_id: $counterparty_node_id,
10474 channel_id: $funding_txo.to_channel_id(),
10477 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
10478 log_error!($logger, "Duplicate in-flight monitor update set for the same channel!");
10479 return Err(DecodeError::InvalidValue);
10481 max_in_flight_update_id
10485 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
10486 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
10487 let peer_state = &mut *peer_state_lock;
10488 for phase in peer_state.channel_by_id.values() {
10489 if let ChannelPhase::Funded(chan) = phase {
10490 let logger = WithChannelContext::from(&args.logger, &chan.context);
10492 // Channels that were persisted have to be funded, otherwise they should have been
10494 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10495 let monitor = args.channel_monitors.get(&funding_txo)
10496 .expect("We already checked for monitor presence when loading channels");
10497 let mut max_in_flight_update_id = monitor.get_latest_update_id();
10498 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
10499 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
10500 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
10501 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
10502 funding_txo, monitor, peer_state, logger, ""));
10505 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
10506 // If the channel is ahead of the monitor, return InvalidValue:
10507 log_error!(logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
10508 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
10509 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
10510 log_error!(logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
10511 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10512 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10513 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10514 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10515 return Err(DecodeError::InvalidValue);
10518 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10519 // created in this `channel_by_id` map.
10520 debug_assert!(false);
10521 return Err(DecodeError::InvalidValue);
10526 if let Some(in_flight_upds) = in_flight_monitor_updates {
10527 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
10528 let logger = WithContext::from(&args.logger, Some(counterparty_id), Some(funding_txo.to_channel_id()));
10529 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
10530 // Now that we've removed all the in-flight monitor updates for channels that are
10531 // still open, we need to replay any monitor updates that are for closed channels,
10532 // creating the neccessary peer_state entries as we go.
10533 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
10534 Mutex::new(peer_state_from_chans(HashMap::new()))
10536 let mut peer_state = peer_state_mutex.lock().unwrap();
10537 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
10538 funding_txo, monitor, peer_state, logger, "closed ");
10540 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!");
10541 log_error!(logger, " The ChannelMonitor for channel {} is missing.",
10542 &funding_txo.to_channel_id());
10543 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10544 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10545 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10546 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10547 return Err(DecodeError::InvalidValue);
10552 // Note that we have to do the above replays before we push new monitor updates.
10553 pending_background_events.append(&mut close_background_events);
10555 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
10556 // should ensure we try them again on the inbound edge. We put them here and do so after we
10557 // have a fully-constructed `ChannelManager` at the end.
10558 let mut pending_claims_to_replay = Vec::new();
10561 // If we're tracking pending payments, ensure we haven't lost any by looking at the
10562 // ChannelMonitor data for any channels for which we do not have authorative state
10563 // (i.e. those for which we just force-closed above or we otherwise don't have a
10564 // corresponding `Channel` at all).
10565 // This avoids several edge-cases where we would otherwise "forget" about pending
10566 // payments which are still in-flight via their on-chain state.
10567 // We only rebuild the pending payments map if we were most recently serialized by
10569 for (_, monitor) in args.channel_monitors.iter() {
10570 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
10571 let chan_id = monitor.get_funding_txo().0.to_channel_id();
10572 if counterparty_opt.is_none() {
10573 let logger = WithChannelMonitor::from(&args.logger, monitor);
10574 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
10575 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
10576 if path.hops.is_empty() {
10577 log_error!(logger, "Got an empty path for a pending payment");
10578 return Err(DecodeError::InvalidValue);
10581 let path_amt = path.final_value_msat();
10582 let mut session_priv_bytes = [0; 32];
10583 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
10584 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
10585 hash_map::Entry::Occupied(mut entry) => {
10586 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
10587 log_info!(logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
10588 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), htlc.payment_hash);
10590 hash_map::Entry::Vacant(entry) => {
10591 let path_fee = path.fee_msat();
10592 entry.insert(PendingOutboundPayment::Retryable {
10593 retry_strategy: None,
10594 attempts: PaymentAttempts::new(),
10595 payment_params: None,
10596 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
10597 payment_hash: htlc.payment_hash,
10598 payment_secret: None, // only used for retries, and we'll never retry on startup
10599 payment_metadata: None, // only used for retries, and we'll never retry on startup
10600 keysend_preimage: None, // only used for retries, and we'll never retry on startup
10601 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
10602 pending_amt_msat: path_amt,
10603 pending_fee_msat: Some(path_fee),
10604 total_msat: path_amt,
10605 starting_block_height: best_block_height,
10606 remaining_max_total_routing_fee_msat: None, // only used for retries, and we'll never retry on startup
10608 log_info!(logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
10609 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
10614 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
10615 match htlc_source {
10616 HTLCSource::PreviousHopData(prev_hop_data) => {
10617 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
10618 info.prev_funding_outpoint == prev_hop_data.outpoint &&
10619 info.prev_htlc_id == prev_hop_data.htlc_id
10621 // The ChannelMonitor is now responsible for this HTLC's
10622 // failure/success and will let us know what its outcome is. If we
10623 // still have an entry for this HTLC in `forward_htlcs` or
10624 // `pending_intercepted_htlcs`, we were apparently not persisted after
10625 // the monitor was when forwarding the payment.
10626 forward_htlcs.retain(|_, forwards| {
10627 forwards.retain(|forward| {
10628 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
10629 if pending_forward_matches_htlc(&htlc_info) {
10630 log_info!(logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
10631 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
10636 !forwards.is_empty()
10638 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
10639 if pending_forward_matches_htlc(&htlc_info) {
10640 log_info!(logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
10641 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
10642 pending_events_read.retain(|(event, _)| {
10643 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
10644 intercepted_id != ev_id
10651 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
10652 if let Some(preimage) = preimage_opt {
10653 let pending_events = Mutex::new(pending_events_read);
10654 // Note that we set `from_onchain` to "false" here,
10655 // deliberately keeping the pending payment around forever.
10656 // Given it should only occur when we have a channel we're
10657 // force-closing for being stale that's okay.
10658 // The alternative would be to wipe the state when claiming,
10659 // generating a `PaymentPathSuccessful` event but regenerating
10660 // it and the `PaymentSent` on every restart until the
10661 // `ChannelMonitor` is removed.
10663 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
10664 channel_funding_outpoint: monitor.get_funding_txo().0,
10665 counterparty_node_id: path.hops[0].pubkey,
10667 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
10668 path, false, compl_action, &pending_events, &&logger);
10669 pending_events_read = pending_events.into_inner().unwrap();
10676 // Whether the downstream channel was closed or not, try to re-apply any payment
10677 // preimages from it which may be needed in upstream channels for forwarded
10679 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
10681 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
10682 if let HTLCSource::PreviousHopData(_) = htlc_source {
10683 if let Some(payment_preimage) = preimage_opt {
10684 Some((htlc_source, payment_preimage, htlc.amount_msat,
10685 // Check if `counterparty_opt.is_none()` to see if the
10686 // downstream chan is closed (because we don't have a
10687 // channel_id -> peer map entry).
10688 counterparty_opt.is_none(),
10689 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
10690 monitor.get_funding_txo().0))
10693 // If it was an outbound payment, we've handled it above - if a preimage
10694 // came in and we persisted the `ChannelManager` we either handled it and
10695 // are good to go or the channel force-closed - we don't have to handle the
10696 // channel still live case here.
10700 for tuple in outbound_claimed_htlcs_iter {
10701 pending_claims_to_replay.push(tuple);
10706 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
10707 // If we have pending HTLCs to forward, assume we either dropped a
10708 // `PendingHTLCsForwardable` or the user received it but never processed it as they
10709 // shut down before the timer hit. Either way, set the time_forwardable to a small
10710 // constant as enough time has likely passed that we should simply handle the forwards
10711 // now, or at least after the user gets a chance to reconnect to our peers.
10712 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
10713 time_forwardable: Duration::from_secs(2),
10717 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
10718 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
10720 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
10721 if let Some(purposes) = claimable_htlc_purposes {
10722 if purposes.len() != claimable_htlcs_list.len() {
10723 return Err(DecodeError::InvalidValue);
10725 if let Some(onion_fields) = claimable_htlc_onion_fields {
10726 if onion_fields.len() != claimable_htlcs_list.len() {
10727 return Err(DecodeError::InvalidValue);
10729 for (purpose, (onion, (payment_hash, htlcs))) in
10730 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
10732 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10733 purpose, htlcs, onion_fields: onion,
10735 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10738 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
10739 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10740 purpose, htlcs, onion_fields: None,
10742 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10746 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
10747 // include a `_legacy_hop_data` in the `OnionPayload`.
10748 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
10749 if htlcs.is_empty() {
10750 return Err(DecodeError::InvalidValue);
10752 let purpose = match &htlcs[0].onion_payload {
10753 OnionPayload::Invoice { _legacy_hop_data } => {
10754 if let Some(hop_data) = _legacy_hop_data {
10755 events::PaymentPurpose::InvoicePayment {
10756 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
10757 Some(inbound_payment) => inbound_payment.payment_preimage,
10758 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
10759 Ok((payment_preimage, _)) => payment_preimage,
10761 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);
10762 return Err(DecodeError::InvalidValue);
10766 payment_secret: hop_data.payment_secret,
10768 } else { return Err(DecodeError::InvalidValue); }
10770 OnionPayload::Spontaneous(payment_preimage) =>
10771 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
10773 claimable_payments.insert(payment_hash, ClaimablePayment {
10774 purpose, htlcs, onion_fields: None,
10779 let mut secp_ctx = Secp256k1::new();
10780 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
10782 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
10784 Err(()) => return Err(DecodeError::InvalidValue)
10786 if let Some(network_pubkey) = received_network_pubkey {
10787 if network_pubkey != our_network_pubkey {
10788 log_error!(args.logger, "Key that was generated does not match the existing key.");
10789 return Err(DecodeError::InvalidValue);
10793 let mut outbound_scid_aliases = HashSet::new();
10794 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
10795 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
10796 let peer_state = &mut *peer_state_lock;
10797 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
10798 if let ChannelPhase::Funded(chan) = phase {
10799 let logger = WithChannelContext::from(&args.logger, &chan.context);
10800 if chan.context.outbound_scid_alias() == 0 {
10801 let mut outbound_scid_alias;
10803 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
10804 .get_fake_scid(best_block_height, &chain_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
10805 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
10807 chan.context.set_outbound_scid_alias(outbound_scid_alias);
10808 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
10809 // Note that in rare cases its possible to hit this while reading an older
10810 // channel if we just happened to pick a colliding outbound alias above.
10811 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
10812 return Err(DecodeError::InvalidValue);
10814 if chan.context.is_usable() {
10815 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
10816 // Note that in rare cases its possible to hit this while reading an older
10817 // channel if we just happened to pick a colliding outbound alias above.
10818 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
10819 return Err(DecodeError::InvalidValue);
10823 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10824 // created in this `channel_by_id` map.
10825 debug_assert!(false);
10826 return Err(DecodeError::InvalidValue);
10831 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
10833 for (_, monitor) in args.channel_monitors.iter() {
10834 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
10835 if let Some(payment) = claimable_payments.remove(&payment_hash) {
10836 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
10837 let mut claimable_amt_msat = 0;
10838 let mut receiver_node_id = Some(our_network_pubkey);
10839 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
10840 if phantom_shared_secret.is_some() {
10841 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
10842 .expect("Failed to get node_id for phantom node recipient");
10843 receiver_node_id = Some(phantom_pubkey)
10845 for claimable_htlc in &payment.htlcs {
10846 claimable_amt_msat += claimable_htlc.value;
10848 // Add a holding-cell claim of the payment to the Channel, which should be
10849 // applied ~immediately on peer reconnection. Because it won't generate a
10850 // new commitment transaction we can just provide the payment preimage to
10851 // the corresponding ChannelMonitor and nothing else.
10853 // We do so directly instead of via the normal ChannelMonitor update
10854 // procedure as the ChainMonitor hasn't yet been initialized, implying
10855 // we're not allowed to call it directly yet. Further, we do the update
10856 // without incrementing the ChannelMonitor update ID as there isn't any
10858 // If we were to generate a new ChannelMonitor update ID here and then
10859 // crash before the user finishes block connect we'd end up force-closing
10860 // this channel as well. On the flip side, there's no harm in restarting
10861 // without the new monitor persisted - we'll end up right back here on
10863 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
10864 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
10865 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
10866 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
10867 let peer_state = &mut *peer_state_lock;
10868 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
10869 let logger = WithChannelContext::from(&args.logger, &channel.context);
10870 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &&logger);
10873 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
10874 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
10877 pending_events_read.push_back((events::Event::PaymentClaimed {
10880 purpose: payment.purpose,
10881 amount_msat: claimable_amt_msat,
10882 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
10883 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
10889 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
10890 if let Some(peer_state) = per_peer_state.get(&node_id) {
10891 for (channel_id, actions) in monitor_update_blocked_actions.iter() {
10892 let logger = WithContext::from(&args.logger, Some(node_id), Some(*channel_id));
10893 for action in actions.iter() {
10894 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
10895 downstream_counterparty_and_funding_outpoint:
10896 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
10898 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
10900 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
10901 blocked_channel_outpoint.to_channel_id());
10902 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
10903 .entry(blocked_channel_outpoint.to_channel_id())
10904 .or_insert_with(Vec::new).push(blocking_action.clone());
10906 // If the channel we were blocking has closed, we don't need to
10907 // worry about it - the blocked monitor update should never have
10908 // been released from the `Channel` object so it can't have
10909 // completed, and if the channel closed there's no reason to bother
10913 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately { .. } = action {
10914 debug_assert!(false, "Non-event-generating channel freeing should not appear in our queue");
10918 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
10920 log_error!(WithContext::from(&args.logger, Some(node_id), None), "Got blocked actions without a per-peer-state for {}", node_id);
10921 return Err(DecodeError::InvalidValue);
10925 let channel_manager = ChannelManager {
10927 fee_estimator: bounded_fee_estimator,
10928 chain_monitor: args.chain_monitor,
10929 tx_broadcaster: args.tx_broadcaster,
10930 router: args.router,
10932 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
10934 inbound_payment_key: expanded_inbound_key,
10935 pending_inbound_payments: Mutex::new(pending_inbound_payments),
10936 pending_outbound_payments: pending_outbounds,
10937 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
10939 forward_htlcs: Mutex::new(forward_htlcs),
10940 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
10941 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
10942 id_to_peer: Mutex::new(id_to_peer),
10943 short_to_chan_info: FairRwLock::new(short_to_chan_info),
10944 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
10946 probing_cookie_secret: probing_cookie_secret.unwrap(),
10948 our_network_pubkey,
10951 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
10953 per_peer_state: FairRwLock::new(per_peer_state),
10955 pending_events: Mutex::new(pending_events_read),
10956 pending_events_processor: AtomicBool::new(false),
10957 pending_background_events: Mutex::new(pending_background_events),
10958 total_consistency_lock: RwLock::new(()),
10959 background_events_processed_since_startup: AtomicBool::new(false),
10961 event_persist_notifier: Notifier::new(),
10962 needs_persist_flag: AtomicBool::new(false),
10964 funding_batch_states: Mutex::new(BTreeMap::new()),
10966 pending_offers_messages: Mutex::new(Vec::new()),
10968 entropy_source: args.entropy_source,
10969 node_signer: args.node_signer,
10970 signer_provider: args.signer_provider,
10972 logger: args.logger,
10973 default_configuration: args.default_config,
10976 for htlc_source in failed_htlcs.drain(..) {
10977 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
10978 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
10979 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
10980 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
10983 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding) in pending_claims_to_replay {
10984 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
10985 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
10986 // channel is closed we just assume that it probably came from an on-chain claim.
10987 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
10988 downstream_closed, true, downstream_node_id, downstream_funding);
10991 //TODO: Broadcast channel update for closed channels, but only after we've made a
10992 //connection or two.
10994 Ok((best_block_hash.clone(), channel_manager))
11000 use bitcoin::hashes::Hash;
11001 use bitcoin::hashes::sha256::Hash as Sha256;
11002 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
11003 use core::sync::atomic::Ordering;
11004 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
11005 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
11006 use crate::ln::ChannelId;
11007 use crate::ln::channelmanager::{create_recv_pending_htlc_info, inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
11008 use crate::ln::functional_test_utils::*;
11009 use crate::ln::msgs::{self, ErrorAction};
11010 use crate::ln::msgs::ChannelMessageHandler;
11011 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
11012 use crate::util::errors::APIError;
11013 use crate::util::test_utils;
11014 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
11015 use crate::sign::EntropySource;
11018 fn test_notify_limits() {
11019 // Check that a few cases which don't require the persistence of a new ChannelManager,
11020 // indeed, do not cause the persistence of a new ChannelManager.
11021 let chanmon_cfgs = create_chanmon_cfgs(3);
11022 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
11023 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
11024 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
11026 // All nodes start with a persistable update pending as `create_network` connects each node
11027 // with all other nodes to make most tests simpler.
11028 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11029 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11030 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11032 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11034 // We check that the channel info nodes have doesn't change too early, even though we try
11035 // to connect messages with new values
11036 chan.0.contents.fee_base_msat *= 2;
11037 chan.1.contents.fee_base_msat *= 2;
11038 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
11039 &nodes[1].node.get_our_node_id()).pop().unwrap();
11040 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
11041 &nodes[0].node.get_our_node_id()).pop().unwrap();
11043 // The first two nodes (which opened a channel) should now require fresh persistence
11044 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11045 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11046 // ... but the last node should not.
11047 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11048 // After persisting the first two nodes they should no longer need fresh persistence.
11049 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11050 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11052 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
11053 // about the channel.
11054 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
11055 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
11056 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11058 // The nodes which are a party to the channel should also ignore messages from unrelated
11060 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11061 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11062 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11063 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11064 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11065 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11067 // At this point the channel info given by peers should still be the same.
11068 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11069 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11071 // An earlier version of handle_channel_update didn't check the directionality of the
11072 // update message and would always update the local fee info, even if our peer was
11073 // (spuriously) forwarding us our own channel_update.
11074 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
11075 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
11076 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
11078 // First deliver each peers' own message, checking that the node doesn't need to be
11079 // persisted and that its channel info remains the same.
11080 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
11081 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
11082 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11083 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11084 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11085 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11087 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
11088 // the channel info has updated.
11089 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
11090 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
11091 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11092 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11093 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
11094 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
11098 fn test_keysend_dup_hash_partial_mpp() {
11099 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
11101 let chanmon_cfgs = create_chanmon_cfgs(2);
11102 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11103 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11104 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11105 create_announced_chan_between_nodes(&nodes, 0, 1);
11107 // First, send a partial MPP payment.
11108 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
11109 let mut mpp_route = route.clone();
11110 mpp_route.paths.push(mpp_route.paths[0].clone());
11112 let payment_id = PaymentId([42; 32]);
11113 // Use the utility function send_payment_along_path to send the payment with MPP data which
11114 // indicates there are more HTLCs coming.
11115 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.
11116 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
11117 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
11118 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
11119 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
11120 check_added_monitors!(nodes[0], 1);
11121 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11122 assert_eq!(events.len(), 1);
11123 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
11125 // Next, send a keysend payment with the same payment_hash and make sure it fails.
11126 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11127 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11128 check_added_monitors!(nodes[0], 1);
11129 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11130 assert_eq!(events.len(), 1);
11131 let ev = events.drain(..).next().unwrap();
11132 let payment_event = SendEvent::from_event(ev);
11133 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11134 check_added_monitors!(nodes[1], 0);
11135 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11136 expect_pending_htlcs_forwardable!(nodes[1]);
11137 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
11138 check_added_monitors!(nodes[1], 1);
11139 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11140 assert!(updates.update_add_htlcs.is_empty());
11141 assert!(updates.update_fulfill_htlcs.is_empty());
11142 assert_eq!(updates.update_fail_htlcs.len(), 1);
11143 assert!(updates.update_fail_malformed_htlcs.is_empty());
11144 assert!(updates.update_fee.is_none());
11145 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11146 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11147 expect_payment_failed!(nodes[0], our_payment_hash, true);
11149 // Send the second half of the original MPP payment.
11150 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
11151 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
11152 check_added_monitors!(nodes[0], 1);
11153 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11154 assert_eq!(events.len(), 1);
11155 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
11157 // Claim the full MPP payment. Note that we can't use a test utility like
11158 // claim_funds_along_route because the ordering of the messages causes the second half of the
11159 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
11160 // lightning messages manually.
11161 nodes[1].node.claim_funds(payment_preimage);
11162 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
11163 check_added_monitors!(nodes[1], 2);
11165 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11166 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
11167 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
11168 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
11169 check_added_monitors!(nodes[0], 1);
11170 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11171 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
11172 check_added_monitors!(nodes[1], 1);
11173 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11174 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
11175 check_added_monitors!(nodes[1], 1);
11176 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11177 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
11178 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
11179 check_added_monitors!(nodes[0], 1);
11180 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
11181 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
11182 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11183 check_added_monitors!(nodes[0], 1);
11184 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
11185 check_added_monitors!(nodes[1], 1);
11186 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
11187 check_added_monitors!(nodes[1], 1);
11188 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11189 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
11190 check_added_monitors!(nodes[0], 1);
11192 // Note that successful MPP payments will generate a single PaymentSent event upon the first
11193 // path's success and a PaymentPathSuccessful event for each path's success.
11194 let events = nodes[0].node.get_and_clear_pending_events();
11195 assert_eq!(events.len(), 2);
11197 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11198 assert_eq!(payment_id, *actual_payment_id);
11199 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11200 assert_eq!(route.paths[0], *path);
11202 _ => panic!("Unexpected event"),
11205 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11206 assert_eq!(payment_id, *actual_payment_id);
11207 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11208 assert_eq!(route.paths[0], *path);
11210 _ => panic!("Unexpected event"),
11215 fn test_keysend_dup_payment_hash() {
11216 do_test_keysend_dup_payment_hash(false);
11217 do_test_keysend_dup_payment_hash(true);
11220 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
11221 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
11222 // outbound regular payment fails as expected.
11223 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
11224 // fails as expected.
11225 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
11226 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
11227 // reject MPP keysend payments, since in this case where the payment has no payment
11228 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
11229 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
11230 // payment secrets and reject otherwise.
11231 let chanmon_cfgs = create_chanmon_cfgs(2);
11232 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11233 let mut mpp_keysend_cfg = test_default_channel_config();
11234 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
11235 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
11236 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11237 create_announced_chan_between_nodes(&nodes, 0, 1);
11238 let scorer = test_utils::TestScorer::new();
11239 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11241 // To start (1), send a regular payment but don't claim it.
11242 let expected_route = [&nodes[1]];
11243 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
11245 // Next, attempt a keysend payment and make sure it fails.
11246 let route_params = RouteParameters::from_payment_params_and_value(
11247 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
11248 TEST_FINAL_CLTV, false), 100_000);
11249 let route = find_route(
11250 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11251 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11253 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11254 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11255 check_added_monitors!(nodes[0], 1);
11256 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11257 assert_eq!(events.len(), 1);
11258 let ev = events.drain(..).next().unwrap();
11259 let payment_event = SendEvent::from_event(ev);
11260 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11261 check_added_monitors!(nodes[1], 0);
11262 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11263 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
11264 // fails), the second will process the resulting failure and fail the HTLC backward
11265 expect_pending_htlcs_forwardable!(nodes[1]);
11266 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11267 check_added_monitors!(nodes[1], 1);
11268 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11269 assert!(updates.update_add_htlcs.is_empty());
11270 assert!(updates.update_fulfill_htlcs.is_empty());
11271 assert_eq!(updates.update_fail_htlcs.len(), 1);
11272 assert!(updates.update_fail_malformed_htlcs.is_empty());
11273 assert!(updates.update_fee.is_none());
11274 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11275 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11276 expect_payment_failed!(nodes[0], payment_hash, true);
11278 // Finally, claim the original payment.
11279 claim_payment(&nodes[0], &expected_route, payment_preimage);
11281 // To start (2), send a keysend payment but don't claim it.
11282 let payment_preimage = PaymentPreimage([42; 32]);
11283 let route = find_route(
11284 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11285 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11287 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11288 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11289 check_added_monitors!(nodes[0], 1);
11290 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11291 assert_eq!(events.len(), 1);
11292 let event = events.pop().unwrap();
11293 let path = vec![&nodes[1]];
11294 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11296 // Next, attempt a regular payment and make sure it fails.
11297 let payment_secret = PaymentSecret([43; 32]);
11298 nodes[0].node.send_payment_with_route(&route, payment_hash,
11299 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
11300 check_added_monitors!(nodes[0], 1);
11301 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11302 assert_eq!(events.len(), 1);
11303 let ev = events.drain(..).next().unwrap();
11304 let payment_event = SendEvent::from_event(ev);
11305 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11306 check_added_monitors!(nodes[1], 0);
11307 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11308 expect_pending_htlcs_forwardable!(nodes[1]);
11309 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11310 check_added_monitors!(nodes[1], 1);
11311 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11312 assert!(updates.update_add_htlcs.is_empty());
11313 assert!(updates.update_fulfill_htlcs.is_empty());
11314 assert_eq!(updates.update_fail_htlcs.len(), 1);
11315 assert!(updates.update_fail_malformed_htlcs.is_empty());
11316 assert!(updates.update_fee.is_none());
11317 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11318 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11319 expect_payment_failed!(nodes[0], payment_hash, true);
11321 // Finally, succeed the keysend payment.
11322 claim_payment(&nodes[0], &expected_route, payment_preimage);
11324 // To start (3), send a keysend payment but don't claim it.
11325 let payment_id_1 = PaymentId([44; 32]);
11326 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11327 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
11328 check_added_monitors!(nodes[0], 1);
11329 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11330 assert_eq!(events.len(), 1);
11331 let event = events.pop().unwrap();
11332 let path = vec![&nodes[1]];
11333 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11335 // Next, attempt a keysend payment and make sure it fails.
11336 let route_params = RouteParameters::from_payment_params_and_value(
11337 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
11340 let route = find_route(
11341 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11342 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11344 let payment_id_2 = PaymentId([45; 32]);
11345 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11346 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
11347 check_added_monitors!(nodes[0], 1);
11348 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11349 assert_eq!(events.len(), 1);
11350 let ev = events.drain(..).next().unwrap();
11351 let payment_event = SendEvent::from_event(ev);
11352 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11353 check_added_monitors!(nodes[1], 0);
11354 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11355 expect_pending_htlcs_forwardable!(nodes[1]);
11356 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11357 check_added_monitors!(nodes[1], 1);
11358 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11359 assert!(updates.update_add_htlcs.is_empty());
11360 assert!(updates.update_fulfill_htlcs.is_empty());
11361 assert_eq!(updates.update_fail_htlcs.len(), 1);
11362 assert!(updates.update_fail_malformed_htlcs.is_empty());
11363 assert!(updates.update_fee.is_none());
11364 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11365 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11366 expect_payment_failed!(nodes[0], payment_hash, true);
11368 // Finally, claim the original payment.
11369 claim_payment(&nodes[0], &expected_route, payment_preimage);
11373 fn test_keysend_hash_mismatch() {
11374 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
11375 // preimage doesn't match the msg's payment hash.
11376 let chanmon_cfgs = create_chanmon_cfgs(2);
11377 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11378 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11379 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11381 let payer_pubkey = nodes[0].node.get_our_node_id();
11382 let payee_pubkey = nodes[1].node.get_our_node_id();
11384 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11385 let route_params = RouteParameters::from_payment_params_and_value(
11386 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11387 let network_graph = nodes[0].network_graph;
11388 let first_hops = nodes[0].node.list_usable_channels();
11389 let scorer = test_utils::TestScorer::new();
11390 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11391 let route = find_route(
11392 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11393 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11396 let test_preimage = PaymentPreimage([42; 32]);
11397 let mismatch_payment_hash = PaymentHash([43; 32]);
11398 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
11399 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
11400 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
11401 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
11402 check_added_monitors!(nodes[0], 1);
11404 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11405 assert_eq!(updates.update_add_htlcs.len(), 1);
11406 assert!(updates.update_fulfill_htlcs.is_empty());
11407 assert!(updates.update_fail_htlcs.is_empty());
11408 assert!(updates.update_fail_malformed_htlcs.is_empty());
11409 assert!(updates.update_fee.is_none());
11410 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11412 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
11416 fn test_keysend_msg_with_secret_err() {
11417 // Test that we error as expected if we receive a keysend payment that includes a payment
11418 // secret when we don't support MPP keysend.
11419 let mut reject_mpp_keysend_cfg = test_default_channel_config();
11420 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
11421 let chanmon_cfgs = create_chanmon_cfgs(2);
11422 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11423 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
11424 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11426 let payer_pubkey = nodes[0].node.get_our_node_id();
11427 let payee_pubkey = nodes[1].node.get_our_node_id();
11429 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11430 let route_params = RouteParameters::from_payment_params_and_value(
11431 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11432 let network_graph = nodes[0].network_graph;
11433 let first_hops = nodes[0].node.list_usable_channels();
11434 let scorer = test_utils::TestScorer::new();
11435 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11436 let route = find_route(
11437 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11438 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11441 let test_preimage = PaymentPreimage([42; 32]);
11442 let test_secret = PaymentSecret([43; 32]);
11443 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).to_byte_array());
11444 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
11445 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
11446 nodes[0].node.test_send_payment_internal(&route, payment_hash,
11447 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
11448 PaymentId(payment_hash.0), None, session_privs).unwrap();
11449 check_added_monitors!(nodes[0], 1);
11451 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11452 assert_eq!(updates.update_add_htlcs.len(), 1);
11453 assert!(updates.update_fulfill_htlcs.is_empty());
11454 assert!(updates.update_fail_htlcs.is_empty());
11455 assert!(updates.update_fail_malformed_htlcs.is_empty());
11456 assert!(updates.update_fee.is_none());
11457 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11459 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
11463 fn test_multi_hop_missing_secret() {
11464 let chanmon_cfgs = create_chanmon_cfgs(4);
11465 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
11466 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
11467 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
11469 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
11470 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
11471 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
11472 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
11474 // Marshall an MPP route.
11475 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
11476 let path = route.paths[0].clone();
11477 route.paths.push(path);
11478 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
11479 route.paths[0].hops[0].short_channel_id = chan_1_id;
11480 route.paths[0].hops[1].short_channel_id = chan_3_id;
11481 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
11482 route.paths[1].hops[0].short_channel_id = chan_2_id;
11483 route.paths[1].hops[1].short_channel_id = chan_4_id;
11485 match nodes[0].node.send_payment_with_route(&route, payment_hash,
11486 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
11488 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
11489 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
11491 _ => panic!("unexpected error")
11496 fn test_drop_disconnected_peers_when_removing_channels() {
11497 let chanmon_cfgs = create_chanmon_cfgs(2);
11498 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11499 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11500 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11502 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11504 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
11505 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11507 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
11508 check_closed_broadcast!(nodes[0], true);
11509 check_added_monitors!(nodes[0], 1);
11510 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
11513 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
11514 // disconnected and the channel between has been force closed.
11515 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
11516 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
11517 assert_eq!(nodes_0_per_peer_state.len(), 1);
11518 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
11521 nodes[0].node.timer_tick_occurred();
11524 // Assert that nodes[1] has now been removed.
11525 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
11530 fn bad_inbound_payment_hash() {
11531 // Add coverage for checking that a user-provided payment hash matches the payment secret.
11532 let chanmon_cfgs = create_chanmon_cfgs(2);
11533 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11534 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11535 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11537 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
11538 let payment_data = msgs::FinalOnionHopData {
11540 total_msat: 100_000,
11543 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
11544 // payment verification fails as expected.
11545 let mut bad_payment_hash = payment_hash.clone();
11546 bad_payment_hash.0[0] += 1;
11547 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) {
11548 Ok(_) => panic!("Unexpected ok"),
11550 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
11554 // Check that using the original payment hash succeeds.
11555 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());
11559 fn test_id_to_peer_coverage() {
11560 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
11561 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
11562 // the channel is successfully closed.
11563 let chanmon_cfgs = create_chanmon_cfgs(2);
11564 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11565 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11566 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11568 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, None).unwrap();
11569 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11570 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
11571 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11572 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11574 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
11575 let channel_id = ChannelId::from_bytes(tx.txid().to_byte_array());
11577 // Ensure that the `id_to_peer` map is empty until either party has received the
11578 // funding transaction, and have the real `channel_id`.
11579 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
11580 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
11583 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
11585 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
11586 // as it has the funding transaction.
11587 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
11588 assert_eq!(nodes_0_lock.len(), 1);
11589 assert!(nodes_0_lock.contains_key(&channel_id));
11592 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
11594 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11596 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11598 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
11599 assert_eq!(nodes_0_lock.len(), 1);
11600 assert!(nodes_0_lock.contains_key(&channel_id));
11602 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11605 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
11606 // as it has the funding transaction.
11607 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
11608 assert_eq!(nodes_1_lock.len(), 1);
11609 assert!(nodes_1_lock.contains_key(&channel_id));
11611 check_added_monitors!(nodes[1], 1);
11612 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11613 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11614 check_added_monitors!(nodes[0], 1);
11615 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11616 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
11617 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
11618 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
11620 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
11621 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()));
11622 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
11623 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
11625 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
11626 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
11628 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
11629 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
11630 // fee for the closing transaction has been negotiated and the parties has the other
11631 // party's signature for the fee negotiated closing transaction.)
11632 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
11633 assert_eq!(nodes_0_lock.len(), 1);
11634 assert!(nodes_0_lock.contains_key(&channel_id));
11638 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
11639 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
11640 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
11641 // kept in the `nodes[1]`'s `id_to_peer` map.
11642 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
11643 assert_eq!(nodes_1_lock.len(), 1);
11644 assert!(nodes_1_lock.contains_key(&channel_id));
11647 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()));
11649 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
11650 // therefore has all it needs to fully close the channel (both signatures for the
11651 // closing transaction).
11652 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
11653 // fully closed by `nodes[0]`.
11654 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
11656 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
11657 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
11658 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
11659 assert_eq!(nodes_1_lock.len(), 1);
11660 assert!(nodes_1_lock.contains_key(&channel_id));
11663 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
11665 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
11667 // Assert that the channel has now been removed from both parties `id_to_peer` map once
11668 // they both have everything required to fully close the channel.
11669 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
11671 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
11673 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
11674 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
11677 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11678 let expected_message = format!("Not connected to node: {}", expected_public_key);
11679 check_api_error_message(expected_message, res_err)
11682 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11683 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
11684 check_api_error_message(expected_message, res_err)
11687 fn check_channel_unavailable_error<T>(res_err: Result<T, APIError>, expected_channel_id: ChannelId, peer_node_id: PublicKey) {
11688 let expected_message = format!("Channel with id {} not found for the passed counterparty node_id {}", expected_channel_id, peer_node_id);
11689 check_api_error_message(expected_message, res_err)
11692 fn check_api_misuse_error<T>(res_err: Result<T, APIError>) {
11693 let expected_message = "No such channel awaiting to be accepted.".to_string();
11694 check_api_error_message(expected_message, res_err)
11697 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
11699 Err(APIError::APIMisuseError { err }) => {
11700 assert_eq!(err, expected_err_message);
11702 Err(APIError::ChannelUnavailable { err }) => {
11703 assert_eq!(err, expected_err_message);
11705 Ok(_) => panic!("Unexpected Ok"),
11706 Err(_) => panic!("Unexpected Error"),
11711 fn test_api_calls_with_unkown_counterparty_node() {
11712 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
11713 // expected if the `counterparty_node_id` is an unkown peer in the
11714 // `ChannelManager::per_peer_state` map.
11715 let chanmon_cfg = create_chanmon_cfgs(2);
11716 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11717 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11718 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11721 let channel_id = ChannelId::from_bytes([4; 32]);
11722 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
11723 let intercept_id = InterceptId([0; 32]);
11725 // Test the API functions.
11726 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);
11728 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
11730 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
11732 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
11734 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
11736 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
11738 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
11742 fn test_api_calls_with_unavailable_channel() {
11743 // Tests that our API functions that expects a `counterparty_node_id` and a `channel_id`
11744 // as input, behaves as expected if the `counterparty_node_id` is a known peer in the
11745 // `ChannelManager::per_peer_state` map, but the peer state doesn't contain a channel with
11746 // the given `channel_id`.
11747 let chanmon_cfg = create_chanmon_cfgs(2);
11748 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11749 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11750 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11752 let counterparty_node_id = nodes[1].node.get_our_node_id();
11755 let channel_id = ChannelId::from_bytes([4; 32]);
11757 // Test the API functions.
11758 check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42));
11760 check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11762 check_channel_unavailable_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11764 check_channel_unavailable_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11766 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);
11768 check_channel_unavailable_error(nodes[0].node.update_channel_config(&counterparty_node_id, &[channel_id], &ChannelConfig::default()), channel_id, counterparty_node_id);
11772 fn test_connection_limiting() {
11773 // Test that we limit un-channel'd peers and un-funded channels properly.
11774 let chanmon_cfgs = create_chanmon_cfgs(2);
11775 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11776 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11777 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11779 // Note that create_network connects the nodes together for us
11781 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11782 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11784 let mut funding_tx = None;
11785 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
11786 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11787 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11790 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11791 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
11792 funding_tx = Some(tx.clone());
11793 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
11794 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11796 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11797 check_added_monitors!(nodes[1], 1);
11798 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11800 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11802 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11803 check_added_monitors!(nodes[0], 1);
11804 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11806 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11809 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
11810 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11811 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11812 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11813 open_channel_msg.temporary_channel_id);
11815 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
11816 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
11818 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
11819 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
11820 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11821 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11822 peer_pks.push(random_pk);
11823 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
11824 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11827 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11828 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11829 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11830 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11831 }, true).unwrap_err();
11833 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
11834 // them if we have too many un-channel'd peers.
11835 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11836 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
11837 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
11838 for ev in chan_closed_events {
11839 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
11841 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11842 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11844 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11845 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11846 }, true).unwrap_err();
11848 // but of course if the connection is outbound its allowed...
11849 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11850 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11851 }, false).unwrap();
11852 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11854 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
11855 // Even though we accept one more connection from new peers, we won't actually let them
11857 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
11858 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
11859 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
11860 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
11861 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11863 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11864 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
11865 open_channel_msg.temporary_channel_id);
11867 // Of course, however, outbound channels are always allowed
11868 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None, None).unwrap();
11869 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
11871 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
11872 // "protected" and can connect again.
11873 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
11874 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11875 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11877 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
11879 // Further, because the first channel was funded, we can open another channel with
11881 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11882 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
11886 fn test_outbound_chans_unlimited() {
11887 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
11888 let chanmon_cfgs = create_chanmon_cfgs(2);
11889 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11890 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11891 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11893 // Note that create_network connects the nodes together for us
11895 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11896 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11898 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
11899 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11900 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11901 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11904 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
11906 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11907 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11908 open_channel_msg.temporary_channel_id);
11910 // but we can still open an outbound channel.
11911 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11912 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
11914 // but even with such an outbound channel, additional inbound channels will still fail.
11915 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11916 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11917 open_channel_msg.temporary_channel_id);
11921 fn test_0conf_limiting() {
11922 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
11923 // flag set and (sometimes) accept channels as 0conf.
11924 let chanmon_cfgs = create_chanmon_cfgs(2);
11925 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11926 let mut settings = test_default_channel_config();
11927 settings.manually_accept_inbound_channels = true;
11928 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
11929 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11931 // Note that create_network connects the nodes together for us
11933 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11934 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11936 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
11937 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
11938 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11939 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11940 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
11941 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11944 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
11945 let events = nodes[1].node.get_and_clear_pending_events();
11947 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11948 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
11950 _ => panic!("Unexpected event"),
11952 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
11953 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11956 // If we try to accept a channel from another peer non-0conf it will fail.
11957 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11958 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11959 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11960 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11962 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11963 let events = nodes[1].node.get_and_clear_pending_events();
11965 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11966 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
11967 Err(APIError::APIMisuseError { err }) =>
11968 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
11972 _ => panic!("Unexpected event"),
11974 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
11975 open_channel_msg.temporary_channel_id);
11977 // ...however if we accept the same channel 0conf it should work just fine.
11978 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11979 let events = nodes[1].node.get_and_clear_pending_events();
11981 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11982 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
11984 _ => panic!("Unexpected event"),
11986 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
11990 fn reject_excessively_underpaying_htlcs() {
11991 let chanmon_cfg = create_chanmon_cfgs(1);
11992 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
11993 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
11994 let node = create_network(1, &node_cfg, &node_chanmgr);
11995 let sender_intended_amt_msat = 100;
11996 let extra_fee_msat = 10;
11997 let hop_data = msgs::InboundOnionPayload::Receive {
11999 outgoing_cltv_value: 42,
12000 payment_metadata: None,
12001 keysend_preimage: None,
12002 payment_data: Some(msgs::FinalOnionHopData {
12003 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12005 custom_tlvs: Vec::new(),
12007 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
12008 // intended amount, we fail the payment.
12009 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12010 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
12011 create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12012 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat),
12013 current_height, node[0].node.default_configuration.accept_mpp_keysend)
12015 assert_eq!(err_code, 19);
12016 } else { panic!(); }
12018 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
12019 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
12021 outgoing_cltv_value: 42,
12022 payment_metadata: None,
12023 keysend_preimage: None,
12024 payment_data: Some(msgs::FinalOnionHopData {
12025 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12027 custom_tlvs: Vec::new(),
12029 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12030 assert!(create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12031 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat),
12032 current_height, node[0].node.default_configuration.accept_mpp_keysend).is_ok());
12036 fn test_final_incorrect_cltv(){
12037 let chanmon_cfg = create_chanmon_cfgs(1);
12038 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12039 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12040 let node = create_network(1, &node_cfg, &node_chanmgr);
12042 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12043 let result = create_recv_pending_htlc_info(msgs::InboundOnionPayload::Receive {
12045 outgoing_cltv_value: 22,
12046 payment_metadata: None,
12047 keysend_preimage: None,
12048 payment_data: Some(msgs::FinalOnionHopData {
12049 payment_secret: PaymentSecret([0; 32]), total_msat: 100,
12051 custom_tlvs: Vec::new(),
12052 }, [0; 32], PaymentHash([0; 32]), 100, 23, None, true, None, current_height,
12053 node[0].node.default_configuration.accept_mpp_keysend);
12055 // Should not return an error as this condition:
12056 // https://github.com/lightning/bolts/blob/4dcc377209509b13cf89a4b91fde7d478f5b46d8/04-onion-routing.md?plain=1#L334
12057 // is not satisfied.
12058 assert!(result.is_ok());
12062 fn test_inbound_anchors_manual_acceptance() {
12063 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12064 // flag set and (sometimes) accept channels as 0conf.
12065 let mut anchors_cfg = test_default_channel_config();
12066 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12068 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
12069 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
12071 let chanmon_cfgs = create_chanmon_cfgs(3);
12072 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
12073 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
12074 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
12075 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
12077 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12078 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12080 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12081 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12082 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
12083 match &msg_events[0] {
12084 MessageSendEvent::HandleError { node_id, action } => {
12085 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
12087 ErrorAction::SendErrorMessage { msg } =>
12088 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
12089 _ => panic!("Unexpected error action"),
12092 _ => panic!("Unexpected event"),
12095 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12096 let events = nodes[2].node.get_and_clear_pending_events();
12098 Event::OpenChannelRequest { temporary_channel_id, .. } =>
12099 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
12100 _ => panic!("Unexpected event"),
12102 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12106 fn test_anchors_zero_fee_htlc_tx_fallback() {
12107 // Tests that if both nodes support anchors, but the remote node does not want to accept
12108 // anchor channels at the moment, an error it sent to the local node such that it can retry
12109 // the channel without the anchors feature.
12110 let chanmon_cfgs = create_chanmon_cfgs(2);
12111 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12112 let mut anchors_config = test_default_channel_config();
12113 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12114 anchors_config.manually_accept_inbound_channels = true;
12115 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
12116 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12118 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None, None).unwrap();
12119 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12120 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
12122 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12123 let events = nodes[1].node.get_and_clear_pending_events();
12125 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12126 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
12128 _ => panic!("Unexpected event"),
12131 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
12132 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
12134 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12135 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
12137 // Since nodes[1] should not have accepted the channel, it should
12138 // not have generated any events.
12139 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12143 fn test_update_channel_config() {
12144 let chanmon_cfg = create_chanmon_cfgs(2);
12145 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12146 let mut user_config = test_default_channel_config();
12147 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12148 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12149 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
12150 let channel = &nodes[0].node.list_channels()[0];
12152 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12153 let events = nodes[0].node.get_and_clear_pending_msg_events();
12154 assert_eq!(events.len(), 0);
12156 user_config.channel_config.forwarding_fee_base_msat += 10;
12157 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12158 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
12159 let events = nodes[0].node.get_and_clear_pending_msg_events();
12160 assert_eq!(events.len(), 1);
12162 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12163 _ => panic!("expected BroadcastChannelUpdate event"),
12166 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
12167 let events = nodes[0].node.get_and_clear_pending_msg_events();
12168 assert_eq!(events.len(), 0);
12170 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
12171 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12172 cltv_expiry_delta: Some(new_cltv_expiry_delta),
12173 ..Default::default()
12175 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12176 let events = nodes[0].node.get_and_clear_pending_msg_events();
12177 assert_eq!(events.len(), 1);
12179 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12180 _ => panic!("expected BroadcastChannelUpdate event"),
12183 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
12184 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12185 forwarding_fee_proportional_millionths: Some(new_fee),
12186 ..Default::default()
12188 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12189 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
12190 let events = nodes[0].node.get_and_clear_pending_msg_events();
12191 assert_eq!(events.len(), 1);
12193 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12194 _ => panic!("expected BroadcastChannelUpdate event"),
12197 // If we provide a channel_id not associated with the peer, we should get an error and no updates
12198 // should be applied to ensure update atomicity as specified in the API docs.
12199 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
12200 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
12201 let new_fee = current_fee + 100;
12204 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
12205 forwarding_fee_proportional_millionths: Some(new_fee),
12206 ..Default::default()
12208 Err(APIError::ChannelUnavailable { err: _ }),
12211 // Check that the fee hasn't changed for the channel that exists.
12212 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
12213 let events = nodes[0].node.get_and_clear_pending_msg_events();
12214 assert_eq!(events.len(), 0);
12218 fn test_payment_display() {
12219 let payment_id = PaymentId([42; 32]);
12220 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12221 let payment_hash = PaymentHash([42; 32]);
12222 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12223 let payment_preimage = PaymentPreimage([42; 32]);
12224 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12228 fn test_trigger_lnd_force_close() {
12229 let chanmon_cfg = create_chanmon_cfgs(2);
12230 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12231 let user_config = test_default_channel_config();
12232 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12233 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12235 // Open a channel, immediately disconnect each other, and broadcast Alice's latest state.
12236 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
12237 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
12238 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12239 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
12240 check_closed_broadcast(&nodes[0], 1, true);
12241 check_added_monitors(&nodes[0], 1);
12242 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
12244 let txn = nodes[0].tx_broadcaster.txn_broadcast();
12245 assert_eq!(txn.len(), 1);
12246 check_spends!(txn[0], funding_tx);
12249 // Since they're disconnected, Bob won't receive Alice's `Error` message. Reconnect them
12250 // such that Bob sends a `ChannelReestablish` to Alice since the channel is still open from
12252 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
12253 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
12255 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12256 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12257 }, false).unwrap();
12258 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
12259 let channel_reestablish = get_event_msg!(
12260 nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()
12262 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &channel_reestablish);
12264 // Alice should respond with an error since the channel isn't known, but a bogus
12265 // `ChannelReestablish` should be sent first, such that we actually trigger Bob to force
12266 // close even if it was an lnd node.
12267 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
12268 assert_eq!(msg_events.len(), 2);
12269 if let MessageSendEvent::SendChannelReestablish { node_id, msg } = &msg_events[0] {
12270 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
12271 assert_eq!(msg.next_local_commitment_number, 0);
12272 assert_eq!(msg.next_remote_commitment_number, 0);
12273 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &msg);
12274 } else { panic!() };
12275 check_closed_broadcast(&nodes[1], 1, true);
12276 check_added_monitors(&nodes[1], 1);
12277 let expected_close_reason = ClosureReason::ProcessingError {
12278 err: "Peer sent an invalid channel_reestablish to force close in a non-standard way".to_string()
12280 check_closed_event!(nodes[1], 1, expected_close_reason, [nodes[0].node.get_our_node_id()], 100000);
12282 let txn = nodes[1].tx_broadcaster.txn_broadcast();
12283 assert_eq!(txn.len(), 1);
12284 check_spends!(txn[0], funding_tx);
12291 use crate::chain::Listen;
12292 use crate::chain::chainmonitor::{ChainMonitor, Persist};
12293 use crate::sign::{KeysManager, InMemorySigner};
12294 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
12295 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
12296 use crate::ln::functional_test_utils::*;
12297 use crate::ln::msgs::{ChannelMessageHandler, Init};
12298 use crate::routing::gossip::NetworkGraph;
12299 use crate::routing::router::{PaymentParameters, RouteParameters};
12300 use crate::util::test_utils;
12301 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
12303 use bitcoin::blockdata::locktime::absolute::LockTime;
12304 use bitcoin::hashes::Hash;
12305 use bitcoin::hashes::sha256::Hash as Sha256;
12306 use bitcoin::{Block, Transaction, TxOut};
12308 use crate::sync::{Arc, Mutex, RwLock};
12310 use criterion::Criterion;
12312 type Manager<'a, P> = ChannelManager<
12313 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
12314 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
12315 &'a test_utils::TestLogger, &'a P>,
12316 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
12317 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
12318 &'a test_utils::TestLogger>;
12320 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
12321 node: &'node_cfg Manager<'chan_mon_cfg, P>,
12323 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
12324 type CM = Manager<'chan_mon_cfg, P>;
12326 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
12328 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
12331 pub fn bench_sends(bench: &mut Criterion) {
12332 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
12335 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
12336 // Do a simple benchmark of sending a payment back and forth between two nodes.
12337 // Note that this is unrealistic as each payment send will require at least two fsync
12339 let network = bitcoin::Network::Testnet;
12340 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
12342 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
12343 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
12344 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
12345 let scorer = RwLock::new(test_utils::TestScorer::new());
12346 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
12348 let mut config: UserConfig = Default::default();
12349 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
12350 config.channel_handshake_config.minimum_depth = 1;
12352 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
12353 let seed_a = [1u8; 32];
12354 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
12355 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 {
12357 best_block: BestBlock::from_network(network),
12358 }, genesis_block.header.time);
12359 let node_a_holder = ANodeHolder { node: &node_a };
12361 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
12362 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
12363 let seed_b = [2u8; 32];
12364 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
12365 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 {
12367 best_block: BestBlock::from_network(network),
12368 }, genesis_block.header.time);
12369 let node_b_holder = ANodeHolder { node: &node_b };
12371 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
12372 features: node_b.init_features(), networks: None, remote_network_address: None
12374 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
12375 features: node_a.init_features(), networks: None, remote_network_address: None
12376 }, false).unwrap();
12377 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None, None).unwrap();
12378 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()));
12379 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()));
12382 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
12383 tx = Transaction { version: 2, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
12384 value: 8_000_000, script_pubkey: output_script,
12386 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
12387 } else { panic!(); }
12389 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()));
12390 let events_b = node_b.get_and_clear_pending_events();
12391 assert_eq!(events_b.len(), 1);
12392 match events_b[0] {
12393 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12394 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12396 _ => panic!("Unexpected event"),
12399 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()));
12400 let events_a = node_a.get_and_clear_pending_events();
12401 assert_eq!(events_a.len(), 1);
12402 match events_a[0] {
12403 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12404 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12406 _ => panic!("Unexpected event"),
12409 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
12411 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
12412 Listen::block_connected(&node_a, &block, 1);
12413 Listen::block_connected(&node_b, &block, 1);
12415 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()));
12416 let msg_events = node_a.get_and_clear_pending_msg_events();
12417 assert_eq!(msg_events.len(), 2);
12418 match msg_events[0] {
12419 MessageSendEvent::SendChannelReady { ref msg, .. } => {
12420 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
12421 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
12425 match msg_events[1] {
12426 MessageSendEvent::SendChannelUpdate { .. } => {},
12430 let events_a = node_a.get_and_clear_pending_events();
12431 assert_eq!(events_a.len(), 1);
12432 match events_a[0] {
12433 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12434 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12436 _ => panic!("Unexpected event"),
12439 let events_b = node_b.get_and_clear_pending_events();
12440 assert_eq!(events_b.len(), 1);
12441 match events_b[0] {
12442 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12443 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12445 _ => panic!("Unexpected event"),
12448 let mut payment_count: u64 = 0;
12449 macro_rules! send_payment {
12450 ($node_a: expr, $node_b: expr) => {
12451 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
12452 .with_bolt11_features($node_b.bolt11_invoice_features()).unwrap();
12453 let mut payment_preimage = PaymentPreimage([0; 32]);
12454 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
12455 payment_count += 1;
12456 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
12457 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
12459 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
12460 PaymentId(payment_hash.0),
12461 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
12462 Retry::Attempts(0)).unwrap();
12463 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
12464 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
12465 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
12466 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
12467 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
12468 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
12469 $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()));
12471 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
12472 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
12473 $node_b.claim_funds(payment_preimage);
12474 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
12476 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
12477 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
12478 assert_eq!(node_id, $node_a.get_our_node_id());
12479 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
12480 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
12482 _ => panic!("Failed to generate claim event"),
12485 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
12486 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
12487 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
12488 $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()));
12490 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
12494 bench.bench_function(bench_name, |b| b.iter(|| {
12495 send_payment!(node_a, node_b);
12496 send_payment!(node_b, node_a);