1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The [`ChannelManager`] is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`Router`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 use bitcoin::blockdata::block::Header;
21 use bitcoin::blockdata::transaction::Transaction;
22 use bitcoin::blockdata::constants::ChainHash;
23 use bitcoin::key::constants::SECRET_KEY_SIZE;
24 use bitcoin::network::constants::Network;
26 use bitcoin::hashes::Hash;
27 use bitcoin::hashes::sha256::Hash as Sha256;
28 use bitcoin::hash_types::{BlockHash, Txid};
30 use bitcoin::secp256k1::{SecretKey,PublicKey};
31 use bitcoin::secp256k1::Secp256k1;
32 use bitcoin::{secp256k1, Sequence};
34 use crate::blinded_path::BlindedPath;
35 use crate::blinded_path::payment::{PaymentConstraints, ReceiveTlvs};
37 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
38 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
39 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, WithChannelMonitor, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
40 use crate::chain::transaction::{OutPoint, TransactionData};
42 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
43 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
44 // construct one themselves.
45 use crate::ln::{inbound_payment, ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
46 use crate::ln::channel::{self, Channel, ChannelPhase, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UnfundedChannelContext, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel, WithChannelContext};
47 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::router::{BlindedTail, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
51 use crate::ln::onion_payment::{check_incoming_htlc_cltv, create_recv_pending_htlc_info, create_fwd_pending_htlc_info, decode_incoming_update_add_htlc_onion, InboundHTLCErr, NextPacketDetails};
53 use crate::ln::onion_utils;
54 use crate::ln::onion_utils::{HTLCFailReason, INVALID_ONION_BLINDING};
55 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
57 use crate::ln::outbound_payment;
58 use crate::ln::outbound_payment::{Bolt12PaymentError, OutboundPayments, PaymentAttempts, PendingOutboundPayment, SendAlongPathArgs, StaleExpiration};
59 use crate::ln::wire::Encode;
60 use crate::offers::invoice::{BlindedPayInfo, Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, DerivedSigningPubkey, InvoiceBuilder};
61 use crate::offers::invoice_error::InvoiceError;
62 use crate::offers::merkle::SignError;
63 use crate::offers::offer::{DerivedMetadata, Offer, OfferBuilder};
64 use crate::offers::parse::Bolt12SemanticError;
65 use crate::offers::refund::{Refund, RefundBuilder};
66 use crate::onion_message::messenger::{Destination, MessageRouter, PendingOnionMessage, new_pending_onion_message};
67 use crate::onion_message::offers::{OffersMessage, OffersMessageHandler};
68 use crate::sign::{EntropySource, NodeSigner, Recipient, SignerProvider};
69 use crate::sign::ecdsa::WriteableEcdsaChannelSigner;
70 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
71 use crate::util::wakers::{Future, Notifier};
72 use crate::util::scid_utils::fake_scid;
73 use crate::util::string::UntrustedString;
74 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
75 use crate::util::logger::{Level, Logger, WithContext};
76 use crate::util::errors::APIError;
77 #[cfg(not(c_bindings))]
79 crate::routing::router::DefaultRouter,
80 crate::routing::gossip::NetworkGraph,
81 crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters},
82 crate::sign::KeysManager,
85 use alloc::collections::{btree_map, BTreeMap};
88 use crate::prelude::*;
90 use core::cell::RefCell;
92 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
93 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
94 use core::time::Duration;
97 // Re-export this for use in the public API.
98 pub use crate::ln::outbound_payment::{PaymentSendFailure, ProbeSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
99 use crate::ln::script::ShutdownScript;
101 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
103 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
104 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
105 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
107 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
108 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
109 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
110 // before we forward it.
112 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
113 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
114 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
115 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
116 // our payment, which we can use to decode errors or inform the user that the payment was sent.
118 /// Information about where a received HTLC('s onion) has indicated the HTLC should go.
119 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
120 #[cfg_attr(test, derive(Debug, PartialEq))]
121 pub enum PendingHTLCRouting {
122 /// An HTLC which should be forwarded on to another node.
124 /// The onion which should be included in the forwarded HTLC, telling the next hop what to
125 /// do with the HTLC.
126 onion_packet: msgs::OnionPacket,
127 /// The short channel ID of the channel which we were instructed to forward this HTLC to.
129 /// This could be a real on-chain SCID, an SCID alias, or some other SCID which has meaning
130 /// to the receiving node, such as one returned from
131 /// [`ChannelManager::get_intercept_scid`] or [`ChannelManager::get_phantom_scid`].
132 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
133 /// Set if this HTLC is being forwarded within a blinded path.
134 blinded: Option<BlindedForward>,
136 /// The onion indicates that this is a payment for an invoice (supposedly) generated by us.
138 /// Note that at this point, we have not checked that the invoice being paid was actually
139 /// generated by us, but rather it's claiming to pay an invoice of ours.
141 /// Information about the amount the sender intended to pay and (potential) proof that this
142 /// is a payment for an invoice we generated. This proof of payment is is also used for
143 /// linking MPP parts of a larger payment.
144 payment_data: msgs::FinalOnionHopData,
145 /// Additional data which we (allegedly) instructed the sender to include in the onion.
147 /// For HTLCs received by LDK, this will ultimately be exposed in
148 /// [`Event::PaymentClaimable::onion_fields`] as
149 /// [`RecipientOnionFields::payment_metadata`].
150 payment_metadata: Option<Vec<u8>>,
151 /// CLTV expiry of the received HTLC.
153 /// Used to track when we should expire pending HTLCs that go unclaimed.
154 incoming_cltv_expiry: u32,
155 /// If the onion had forwarding instructions to one of our phantom node SCIDs, this will
156 /// provide the onion shared secret used to decrypt the next level of forwarding
158 phantom_shared_secret: Option<[u8; 32]>,
159 /// Custom TLVs which were set by the sender.
161 /// For HTLCs received by LDK, this will ultimately be exposed in
162 /// [`Event::PaymentClaimable::onion_fields`] as
163 /// [`RecipientOnionFields::custom_tlvs`].
164 custom_tlvs: Vec<(u64, Vec<u8>)>,
165 /// Set if this HTLC is the final hop in a multi-hop blinded path.
166 requires_blinded_error: bool,
168 /// The onion indicates that this is for payment to us but which contains the preimage for
169 /// claiming included, and is unrelated to any invoice we'd previously generated (aka a
170 /// "keysend" or "spontaneous" payment).
172 /// Information about the amount the sender intended to pay and possibly a token to
173 /// associate MPP parts of a larger payment.
175 /// This will only be filled in if receiving MPP keysend payments is enabled, and it being
176 /// present will cause deserialization to fail on versions of LDK prior to 0.0.116.
177 payment_data: Option<msgs::FinalOnionHopData>,
178 /// Preimage for this onion payment. This preimage is provided by the sender and will be
179 /// used to settle the spontaneous payment.
180 payment_preimage: PaymentPreimage,
181 /// Additional data which we (allegedly) instructed the sender to include in the onion.
183 /// For HTLCs received by LDK, this will ultimately bubble back up as
184 /// [`RecipientOnionFields::payment_metadata`].
185 payment_metadata: Option<Vec<u8>>,
186 /// CLTV expiry of the received HTLC.
188 /// Used to track when we should expire pending HTLCs that go unclaimed.
189 incoming_cltv_expiry: u32,
190 /// Custom TLVs which were set by the sender.
192 /// For HTLCs received by LDK, these will ultimately bubble back up as
193 /// [`RecipientOnionFields::custom_tlvs`].
194 custom_tlvs: Vec<(u64, Vec<u8>)>,
198 /// Information used to forward or fail this HTLC that is being forwarded within a blinded path.
199 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
200 pub struct BlindedForward {
201 /// The `blinding_point` that was set in the inbound [`msgs::UpdateAddHTLC`], or in the inbound
202 /// onion payload if we're the introduction node. Useful for calculating the next hop's
203 /// [`msgs::UpdateAddHTLC::blinding_point`].
204 pub inbound_blinding_point: PublicKey,
205 /// If needed, this determines how this HTLC should be failed backwards, based on whether we are
206 /// the introduction node.
207 pub failure: BlindedFailure,
210 impl PendingHTLCRouting {
211 // Used to override the onion failure code and data if the HTLC is blinded.
212 fn blinded_failure(&self) -> Option<BlindedFailure> {
214 Self::Forward { blinded: Some(BlindedForward { failure, .. }), .. } => Some(*failure),
215 Self::Receive { requires_blinded_error: true, .. } => Some(BlindedFailure::FromBlindedNode),
221 /// Information about an incoming HTLC, including the [`PendingHTLCRouting`] describing where it
223 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
224 #[cfg_attr(test, derive(Debug, PartialEq))]
225 pub struct PendingHTLCInfo {
226 /// Further routing details based on whether the HTLC is being forwarded or received.
227 pub routing: PendingHTLCRouting,
228 /// The onion shared secret we build with the sender used to decrypt the onion.
230 /// This is later used to encrypt failure packets in the event that the HTLC is failed.
231 pub incoming_shared_secret: [u8; 32],
232 /// Hash of the payment preimage, to lock the payment until the receiver releases the preimage.
233 pub payment_hash: PaymentHash,
234 /// Amount received in the incoming HTLC.
236 /// This field was added in LDK 0.0.113 and will be `None` for objects written by prior
238 pub incoming_amt_msat: Option<u64>,
239 /// The amount the sender indicated should be forwarded on to the next hop or amount the sender
240 /// intended for us to receive for received payments.
242 /// If the received amount is less than this for received payments, an intermediary hop has
243 /// attempted to steal some of our funds and we should fail the HTLC (the sender should retry
244 /// it along another path).
246 /// Because nodes can take less than their required fees, and because senders may wish to
247 /// improve their own privacy, this amount may be less than [`Self::incoming_amt_msat`] for
248 /// received payments. In such cases, recipients must handle this HTLC as if it had received
249 /// [`Self::outgoing_amt_msat`].
250 pub outgoing_amt_msat: u64,
251 /// The CLTV the sender has indicated we should set on the forwarded HTLC (or has indicated
252 /// should have been set on the received HTLC for received payments).
253 pub outgoing_cltv_value: u32,
254 /// The fee taken for this HTLC in addition to the standard protocol HTLC fees.
256 /// If this is a payment for forwarding, this is the fee we are taking before forwarding the
259 /// If this is a received payment, this is the fee that our counterparty took.
261 /// This is used to allow LSPs to take fees as a part of payments, without the sender having to
263 pub skimmed_fee_msat: Option<u64>,
266 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
267 pub(super) enum HTLCFailureMsg {
268 Relay(msgs::UpdateFailHTLC),
269 Malformed(msgs::UpdateFailMalformedHTLC),
272 /// Stores whether we can't forward an HTLC or relevant forwarding info
273 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
274 pub(super) enum PendingHTLCStatus {
275 Forward(PendingHTLCInfo),
276 Fail(HTLCFailureMsg),
279 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
280 pub(super) struct PendingAddHTLCInfo {
281 pub(super) forward_info: PendingHTLCInfo,
283 // These fields are produced in `forward_htlcs()` and consumed in
284 // `process_pending_htlc_forwards()` for constructing the
285 // `HTLCSource::PreviousHopData` for failed and forwarded
288 // Note that this may be an outbound SCID alias for the associated channel.
289 prev_short_channel_id: u64,
291 prev_funding_outpoint: OutPoint,
292 prev_user_channel_id: u128,
295 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
296 pub(super) enum HTLCForwardInfo {
297 AddHTLC(PendingAddHTLCInfo),
300 err_packet: msgs::OnionErrorPacket,
305 sha256_of_onion: [u8; 32],
309 /// Whether this blinded HTLC is being failed backwards by the introduction node or a blinded node,
310 /// which determines the failure message that should be used.
311 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
312 pub enum BlindedFailure {
313 /// This HTLC is being failed backwards by the introduction node, and thus should be failed with
314 /// [`msgs::UpdateFailHTLC`] and error code `0x8000|0x4000|24`.
315 FromIntroductionNode,
316 /// This HTLC is being failed backwards by a blinded node within the path, and thus should be
317 /// failed with [`msgs::UpdateFailMalformedHTLC`] and error code `0x8000|0x4000|24`.
321 /// Tracks the inbound corresponding to an outbound HTLC
322 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
323 pub(crate) struct HTLCPreviousHopData {
324 // Note that this may be an outbound SCID alias for the associated channel.
325 short_channel_id: u64,
326 user_channel_id: Option<u128>,
328 incoming_packet_shared_secret: [u8; 32],
329 phantom_shared_secret: Option<[u8; 32]>,
330 blinded_failure: Option<BlindedFailure>,
332 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
333 // channel with a preimage provided by the forward channel.
338 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
340 /// This is only here for backwards-compatibility in serialization, in the future it can be
341 /// removed, breaking clients running 0.0.106 and earlier.
342 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
344 /// Contains the payer-provided preimage.
345 Spontaneous(PaymentPreimage),
348 /// HTLCs that are to us and can be failed/claimed by the user
349 struct ClaimableHTLC {
350 prev_hop: HTLCPreviousHopData,
352 /// The amount (in msats) of this MPP part
354 /// The amount (in msats) that the sender intended to be sent in this MPP
355 /// part (used for validating total MPP amount)
356 sender_intended_value: u64,
357 onion_payload: OnionPayload,
359 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
360 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
361 total_value_received: Option<u64>,
362 /// The sender intended sum total of all MPP parts specified in the onion
364 /// The extra fee our counterparty skimmed off the top of this HTLC.
365 counterparty_skimmed_fee_msat: Option<u64>,
368 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
369 fn from(val: &ClaimableHTLC) -> Self {
370 events::ClaimedHTLC {
371 channel_id: val.prev_hop.outpoint.to_channel_id(),
372 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
373 cltv_expiry: val.cltv_expiry,
374 value_msat: val.value,
375 counterparty_skimmed_fee_msat: val.counterparty_skimmed_fee_msat.unwrap_or(0),
380 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
381 /// a payment and ensure idempotency in LDK.
383 /// This is not exported to bindings users as we just use [u8; 32] directly
384 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
385 pub struct PaymentId(pub [u8; Self::LENGTH]);
388 /// Number of bytes in the id.
389 pub const LENGTH: usize = 32;
392 impl Writeable for PaymentId {
393 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
398 impl Readable for PaymentId {
399 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
400 let buf: [u8; 32] = Readable::read(r)?;
405 impl core::fmt::Display for PaymentId {
406 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
407 crate::util::logger::DebugBytes(&self.0).fmt(f)
411 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
413 /// This is not exported to bindings users as we just use [u8; 32] directly
414 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
415 pub struct InterceptId(pub [u8; 32]);
417 impl Writeable for InterceptId {
418 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
423 impl Readable for InterceptId {
424 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
425 let buf: [u8; 32] = Readable::read(r)?;
430 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
431 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
432 pub(crate) enum SentHTLCId {
433 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
434 OutboundRoute { session_priv: [u8; SECRET_KEY_SIZE] },
437 pub(crate) fn from_source(source: &HTLCSource) -> Self {
439 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
440 short_channel_id: hop_data.short_channel_id,
441 htlc_id: hop_data.htlc_id,
443 HTLCSource::OutboundRoute { session_priv, .. } =>
444 Self::OutboundRoute { session_priv: session_priv.secret_bytes() },
448 impl_writeable_tlv_based_enum!(SentHTLCId,
449 (0, PreviousHopData) => {
450 (0, short_channel_id, required),
451 (2, htlc_id, required),
453 (2, OutboundRoute) => {
454 (0, session_priv, required),
459 /// Tracks the inbound corresponding to an outbound HTLC
460 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
461 #[derive(Clone, Debug, PartialEq, Eq)]
462 pub(crate) enum HTLCSource {
463 PreviousHopData(HTLCPreviousHopData),
466 session_priv: SecretKey,
467 /// Technically we can recalculate this from the route, but we cache it here to avoid
468 /// doing a double-pass on route when we get a failure back
469 first_hop_htlc_msat: u64,
470 payment_id: PaymentId,
473 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
474 impl core::hash::Hash for HTLCSource {
475 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
477 HTLCSource::PreviousHopData(prev_hop_data) => {
479 prev_hop_data.hash(hasher);
481 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
484 session_priv[..].hash(hasher);
485 payment_id.hash(hasher);
486 first_hop_htlc_msat.hash(hasher);
492 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
494 pub fn dummy() -> Self {
495 HTLCSource::OutboundRoute {
496 path: Path { hops: Vec::new(), blinded_tail: None },
497 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
498 first_hop_htlc_msat: 0,
499 payment_id: PaymentId([2; 32]),
503 #[cfg(debug_assertions)]
504 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
505 /// transaction. Useful to ensure different datastructures match up.
506 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
507 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
508 *first_hop_htlc_msat == htlc.amount_msat
510 // There's nothing we can check for forwarded HTLCs
516 /// This enum is used to specify which error data to send to peers when failing back an HTLC
517 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
519 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
520 #[derive(Clone, Copy)]
521 pub enum FailureCode {
522 /// We had a temporary error processing the payment. Useful if no other error codes fit
523 /// and you want to indicate that the payer may want to retry.
524 TemporaryNodeFailure,
525 /// We have a required feature which was not in this onion. For example, you may require
526 /// some additional metadata that was not provided with this payment.
527 RequiredNodeFeatureMissing,
528 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
529 /// the HTLC is too close to the current block height for safe handling.
530 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
531 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
532 IncorrectOrUnknownPaymentDetails,
533 /// We failed to process the payload after the onion was decrypted. You may wish to
534 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
536 /// If available, the tuple data may include the type number and byte offset in the
537 /// decrypted byte stream where the failure occurred.
538 InvalidOnionPayload(Option<(u64, u16)>),
541 impl Into<u16> for FailureCode {
542 fn into(self) -> u16 {
544 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
545 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
546 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
547 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
552 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
553 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
554 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
555 /// peer_state lock. We then return the set of things that need to be done outside the lock in
556 /// this struct and call handle_error!() on it.
558 struct MsgHandleErrInternal {
559 err: msgs::LightningError,
560 closes_channel: bool,
561 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
563 impl MsgHandleErrInternal {
565 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
567 err: LightningError {
569 action: msgs::ErrorAction::SendErrorMessage {
570 msg: msgs::ErrorMessage {
576 closes_channel: false,
577 shutdown_finish: None,
581 fn from_no_close(err: msgs::LightningError) -> Self {
582 Self { err, closes_channel: false, shutdown_finish: None }
585 fn from_finish_shutdown(err: String, channel_id: ChannelId, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
586 let err_msg = msgs::ErrorMessage { channel_id, data: err.clone() };
587 let action = if shutdown_res.monitor_update.is_some() {
588 // We have a closing `ChannelMonitorUpdate`, which means the channel was funded and we
589 // should disconnect our peer such that we force them to broadcast their latest
590 // commitment upon reconnecting.
591 msgs::ErrorAction::DisconnectPeer { msg: Some(err_msg) }
593 msgs::ErrorAction::SendErrorMessage { msg: err_msg }
596 err: LightningError { err, action },
597 closes_channel: true,
598 shutdown_finish: Some((shutdown_res, channel_update)),
602 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
605 ChannelError::Warn(msg) => LightningError {
607 action: msgs::ErrorAction::SendWarningMessage {
608 msg: msgs::WarningMessage {
612 log_level: Level::Warn,
615 ChannelError::Ignore(msg) => LightningError {
617 action: msgs::ErrorAction::IgnoreError,
619 ChannelError::Close(msg) => LightningError {
621 action: msgs::ErrorAction::SendErrorMessage {
622 msg: msgs::ErrorMessage {
629 closes_channel: false,
630 shutdown_finish: None,
634 fn closes_channel(&self) -> bool {
639 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
640 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
641 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
642 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
643 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
645 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
646 /// be sent in the order they appear in the return value, however sometimes the order needs to be
647 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
648 /// they were originally sent). In those cases, this enum is also returned.
649 #[derive(Clone, PartialEq)]
650 pub(super) enum RAACommitmentOrder {
651 /// Send the CommitmentUpdate messages first
653 /// Send the RevokeAndACK message first
657 /// Information about a payment which is currently being claimed.
658 struct ClaimingPayment {
660 payment_purpose: events::PaymentPurpose,
661 receiver_node_id: PublicKey,
662 htlcs: Vec<events::ClaimedHTLC>,
663 sender_intended_value: Option<u64>,
665 impl_writeable_tlv_based!(ClaimingPayment, {
666 (0, amount_msat, required),
667 (2, payment_purpose, required),
668 (4, receiver_node_id, required),
669 (5, htlcs, optional_vec),
670 (7, sender_intended_value, option),
673 struct ClaimablePayment {
674 purpose: events::PaymentPurpose,
675 onion_fields: Option<RecipientOnionFields>,
676 htlcs: Vec<ClaimableHTLC>,
679 /// Information about claimable or being-claimed payments
680 struct ClaimablePayments {
681 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
682 /// failed/claimed by the user.
684 /// Note that, no consistency guarantees are made about the channels given here actually
685 /// existing anymore by the time you go to read them!
687 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
688 /// we don't get a duplicate payment.
689 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
691 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
692 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
693 /// as an [`events::Event::PaymentClaimed`].
694 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
697 /// Events which we process internally but cannot be processed immediately at the generation site
698 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
699 /// running normally, and specifically must be processed before any other non-background
700 /// [`ChannelMonitorUpdate`]s are applied.
702 enum BackgroundEvent {
703 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
704 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
705 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
706 /// channel has been force-closed we do not need the counterparty node_id.
708 /// Note that any such events are lost on shutdown, so in general they must be updates which
709 /// are regenerated on startup.
710 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
711 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
712 /// channel to continue normal operation.
714 /// In general this should be used rather than
715 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
716 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
717 /// error the other variant is acceptable.
719 /// Note that any such events are lost on shutdown, so in general they must be updates which
720 /// are regenerated on startup.
721 MonitorUpdateRegeneratedOnStartup {
722 counterparty_node_id: PublicKey,
723 funding_txo: OutPoint,
724 update: ChannelMonitorUpdate
726 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
727 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
729 MonitorUpdatesComplete {
730 counterparty_node_id: PublicKey,
731 channel_id: ChannelId,
736 pub(crate) enum MonitorUpdateCompletionAction {
737 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
738 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
739 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
740 /// event can be generated.
741 PaymentClaimed { payment_hash: PaymentHash },
742 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
743 /// operation of another channel.
745 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
746 /// from completing a monitor update which removes the payment preimage until the inbound edge
747 /// completes a monitor update containing the payment preimage. In that case, after the inbound
748 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
750 EmitEventAndFreeOtherChannel {
751 event: events::Event,
752 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
754 /// Indicates we should immediately resume the operation of another channel, unless there is
755 /// some other reason why the channel is blocked. In practice this simply means immediately
756 /// removing the [`RAAMonitorUpdateBlockingAction`] provided from the blocking set.
758 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
759 /// from completing a monitor update which removes the payment preimage until the inbound edge
760 /// completes a monitor update containing the payment preimage. However, we use this variant
761 /// instead of [`Self::EmitEventAndFreeOtherChannel`] when we discover that the claim was in
762 /// fact duplicative and we simply want to resume the outbound edge channel immediately.
764 /// This variant should thus never be written to disk, as it is processed inline rather than
765 /// stored for later processing.
766 FreeOtherChannelImmediately {
767 downstream_counterparty_node_id: PublicKey,
768 downstream_funding_outpoint: OutPoint,
769 blocking_action: RAAMonitorUpdateBlockingAction,
773 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
774 (0, PaymentClaimed) => { (0, payment_hash, required) },
775 // Note that FreeOtherChannelImmediately should never be written - we were supposed to free
776 // *immediately*. However, for simplicity we implement read/write here.
777 (1, FreeOtherChannelImmediately) => {
778 (0, downstream_counterparty_node_id, required),
779 (2, downstream_funding_outpoint, required),
780 (4, blocking_action, required),
782 (2, EmitEventAndFreeOtherChannel) => {
783 (0, event, upgradable_required),
784 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
785 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
786 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
787 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
788 // downgrades to prior versions.
789 (1, downstream_counterparty_and_funding_outpoint, option),
793 #[derive(Clone, Debug, PartialEq, Eq)]
794 pub(crate) enum EventCompletionAction {
795 ReleaseRAAChannelMonitorUpdate {
796 counterparty_node_id: PublicKey,
797 channel_funding_outpoint: OutPoint,
800 impl_writeable_tlv_based_enum!(EventCompletionAction,
801 (0, ReleaseRAAChannelMonitorUpdate) => {
802 (0, channel_funding_outpoint, required),
803 (2, counterparty_node_id, required),
807 #[derive(Clone, PartialEq, Eq, Debug)]
808 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
809 /// the blocked action here. See enum variants for more info.
810 pub(crate) enum RAAMonitorUpdateBlockingAction {
811 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
812 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
814 ForwardedPaymentInboundClaim {
815 /// The upstream channel ID (i.e. the inbound edge).
816 channel_id: ChannelId,
817 /// The HTLC ID on the inbound edge.
822 impl RAAMonitorUpdateBlockingAction {
823 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
824 Self::ForwardedPaymentInboundClaim {
825 channel_id: prev_hop.outpoint.to_channel_id(),
826 htlc_id: prev_hop.htlc_id,
831 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
832 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
836 /// State we hold per-peer.
837 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
838 /// `channel_id` -> `ChannelPhase`
840 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
841 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
842 /// `temporary_channel_id` -> `InboundChannelRequest`.
844 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
845 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
846 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
847 /// the channel is rejected, then the entry is simply removed.
848 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
849 /// The latest `InitFeatures` we heard from the peer.
850 latest_features: InitFeatures,
851 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
852 /// for broadcast messages, where ordering isn't as strict).
853 pub(super) pending_msg_events: Vec<MessageSendEvent>,
854 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
855 /// user but which have not yet completed.
857 /// Note that the channel may no longer exist. For example if the 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.
860 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
861 /// Map from a specific channel to some action(s) that should be taken when all pending
862 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
864 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
865 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
866 /// channels with a peer this will just be one allocation and will amount to a linear list of
867 /// channels to walk, avoiding the whole hashing rigmarole.
869 /// Note that the channel may no longer exist. For example, if a channel was closed but we
870 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
871 /// for a missing channel. While a malicious peer could construct a second channel with the
872 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
873 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
874 /// duplicates do not occur, so such channels should fail without a monitor update completing.
875 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
876 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
877 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
878 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
879 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
880 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
881 /// The peer is currently connected (i.e. we've seen a
882 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
883 /// [`ChannelMessageHandler::peer_disconnected`].
887 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
888 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
889 /// If true is passed for `require_disconnected`, the function will return false if we haven't
890 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
891 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
892 if require_disconnected && self.is_connected {
895 self.channel_by_id.iter().filter(|(_, phase)| matches!(phase, ChannelPhase::Funded(_))).count() == 0
896 && self.monitor_update_blocked_actions.is_empty()
897 && self.in_flight_monitor_updates.is_empty()
900 // Returns a count of all channels we have with this peer, including unfunded channels.
901 fn total_channel_count(&self) -> usize {
902 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
905 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
906 fn has_channel(&self, channel_id: &ChannelId) -> bool {
907 self.channel_by_id.contains_key(channel_id) ||
908 self.inbound_channel_request_by_id.contains_key(channel_id)
912 /// A not-yet-accepted inbound (from counterparty) channel. Once
913 /// accepted, the parameters will be used to construct a channel.
914 pub(super) struct InboundChannelRequest {
915 /// The original OpenChannel message.
916 pub open_channel_msg: msgs::OpenChannel,
917 /// The number of ticks remaining before the request expires.
918 pub ticks_remaining: i32,
921 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
922 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
923 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
925 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
926 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
928 /// For users who don't want to bother doing their own payment preimage storage, we also store that
931 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
932 /// and instead encoding it in the payment secret.
933 struct PendingInboundPayment {
934 /// The payment secret that the sender must use for us to accept this payment
935 payment_secret: PaymentSecret,
936 /// Time at which this HTLC expires - blocks with a header time above this value will result in
937 /// this payment being removed.
939 /// Arbitrary identifier the user specifies (or not)
940 user_payment_id: u64,
941 // Other required attributes of the payment, optionally enforced:
942 payment_preimage: Option<PaymentPreimage>,
943 min_value_msat: Option<u64>,
946 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
947 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
948 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
949 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
950 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
951 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
952 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
953 /// of [`KeysManager`] and [`DefaultRouter`].
955 /// This is not exported to bindings users as type aliases aren't supported in most languages.
956 #[cfg(not(c_bindings))]
957 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
965 Arc<NetworkGraph<Arc<L>>>,
967 Arc<RwLock<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
968 ProbabilisticScoringFeeParameters,
969 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
974 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
975 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
976 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
977 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
978 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
979 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
980 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
981 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
982 /// of [`KeysManager`] and [`DefaultRouter`].
984 /// This is not exported to bindings users as type aliases aren't supported in most languages.
985 #[cfg(not(c_bindings))]
986 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
995 &'f NetworkGraph<&'g L>,
997 &'h RwLock<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
998 ProbabilisticScoringFeeParameters,
999 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
1004 /// A trivial trait which describes any [`ChannelManager`].
1006 /// This is not exported to bindings users as general cover traits aren't useful in other
1008 pub trait AChannelManager {
1009 /// A type implementing [`chain::Watch`].
1010 type Watch: chain::Watch<Self::Signer> + ?Sized;
1011 /// A type that may be dereferenced to [`Self::Watch`].
1012 type M: Deref<Target = Self::Watch>;
1013 /// A type implementing [`BroadcasterInterface`].
1014 type Broadcaster: BroadcasterInterface + ?Sized;
1015 /// A type that may be dereferenced to [`Self::Broadcaster`].
1016 type T: Deref<Target = Self::Broadcaster>;
1017 /// A type implementing [`EntropySource`].
1018 type EntropySource: EntropySource + ?Sized;
1019 /// A type that may be dereferenced to [`Self::EntropySource`].
1020 type ES: Deref<Target = Self::EntropySource>;
1021 /// A type implementing [`NodeSigner`].
1022 type NodeSigner: NodeSigner + ?Sized;
1023 /// A type that may be dereferenced to [`Self::NodeSigner`].
1024 type NS: Deref<Target = Self::NodeSigner>;
1025 /// A type implementing [`WriteableEcdsaChannelSigner`].
1026 type Signer: WriteableEcdsaChannelSigner + Sized;
1027 /// A type implementing [`SignerProvider`] for [`Self::Signer`].
1028 type SignerProvider: SignerProvider<EcdsaSigner= Self::Signer> + ?Sized;
1029 /// A type that may be dereferenced to [`Self::SignerProvider`].
1030 type SP: Deref<Target = Self::SignerProvider>;
1031 /// A type implementing [`FeeEstimator`].
1032 type FeeEstimator: FeeEstimator + ?Sized;
1033 /// A type that may be dereferenced to [`Self::FeeEstimator`].
1034 type F: Deref<Target = Self::FeeEstimator>;
1035 /// A type implementing [`Router`].
1036 type Router: Router + ?Sized;
1037 /// A type that may be dereferenced to [`Self::Router`].
1038 type R: Deref<Target = Self::Router>;
1039 /// A type implementing [`Logger`].
1040 type Logger: Logger + ?Sized;
1041 /// A type that may be dereferenced to [`Self::Logger`].
1042 type L: Deref<Target = Self::Logger>;
1043 /// Returns a reference to the actual [`ChannelManager`] object.
1044 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
1047 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
1048 for ChannelManager<M, T, ES, NS, SP, F, R, L>
1050 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
1051 T::Target: BroadcasterInterface,
1052 ES::Target: EntropySource,
1053 NS::Target: NodeSigner,
1054 SP::Target: SignerProvider,
1055 F::Target: FeeEstimator,
1059 type Watch = M::Target;
1061 type Broadcaster = T::Target;
1063 type EntropySource = ES::Target;
1065 type NodeSigner = NS::Target;
1067 type Signer = <SP::Target as SignerProvider>::EcdsaSigner;
1068 type SignerProvider = SP::Target;
1070 type FeeEstimator = F::Target;
1072 type Router = R::Target;
1074 type Logger = L::Target;
1076 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
1079 /// Manager which keeps track of a number of channels and sends messages to the appropriate
1080 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
1082 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
1083 /// to individual Channels.
1085 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
1086 /// all peers during write/read (though does not modify this instance, only the instance being
1087 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
1088 /// called [`funding_transaction_generated`] for outbound channels) being closed.
1090 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
1091 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST durably write each
1092 /// [`ChannelMonitorUpdate`] before returning from
1093 /// [`chain::Watch::watch_channel`]/[`update_channel`] or before completing async writes. With
1094 /// `ChannelManager`s, writing updates happens out-of-band (and will prevent any other
1095 /// `ChannelManager` operations from occurring during the serialization process). If the
1096 /// deserialized version is out-of-date compared to the [`ChannelMonitor`] passed by reference to
1097 /// [`read`], those channels will be force-closed based on the `ChannelMonitor` state and no funds
1098 /// will be lost (modulo on-chain transaction fees).
1100 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
1101 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
1102 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
1104 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
1105 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
1106 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
1107 /// offline for a full minute. In order to track this, you must call
1108 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
1110 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
1111 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
1112 /// not have a channel with being unable to connect to us or open new channels with us if we have
1113 /// many peers with unfunded channels.
1115 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
1116 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
1117 /// never limited. Please ensure you limit the count of such channels yourself.
1119 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
1120 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
1121 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
1122 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
1123 /// you're using lightning-net-tokio.
1125 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
1126 /// [`funding_created`]: msgs::FundingCreated
1127 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
1128 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
1129 /// [`update_channel`]: chain::Watch::update_channel
1130 /// [`ChannelUpdate`]: msgs::ChannelUpdate
1131 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
1132 /// [`read`]: ReadableArgs::read
1135 // The tree structure below illustrates the lock order requirements for the different locks of the
1136 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
1137 // and should then be taken in the order of the lowest to the highest level in the tree.
1138 // Note that locks on different branches shall not be taken at the same time, as doing so will
1139 // create a new lock order for those specific locks in the order they were taken.
1143 // `pending_offers_messages`
1145 // `total_consistency_lock`
1147 // |__`forward_htlcs`
1149 // | |__`pending_intercepted_htlcs`
1151 // |__`per_peer_state`
1153 // |__`pending_inbound_payments`
1155 // |__`claimable_payments`
1157 // |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
1161 // |__`outpoint_to_peer`
1163 // |__`short_to_chan_info`
1165 // |__`outbound_scid_aliases`
1169 // |__`pending_events`
1171 // |__`pending_background_events`
1173 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
1175 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
1176 T::Target: BroadcasterInterface,
1177 ES::Target: EntropySource,
1178 NS::Target: NodeSigner,
1179 SP::Target: SignerProvider,
1180 F::Target: FeeEstimator,
1184 default_configuration: UserConfig,
1185 chain_hash: ChainHash,
1186 fee_estimator: LowerBoundedFeeEstimator<F>,
1192 /// See `ChannelManager` struct-level documentation for lock order requirements.
1194 pub(super) best_block: RwLock<BestBlock>,
1196 best_block: RwLock<BestBlock>,
1197 secp_ctx: Secp256k1<secp256k1::All>,
1199 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1200 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1201 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1202 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1204 /// See `ChannelManager` struct-level documentation for lock order requirements.
1205 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1207 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1208 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1209 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1210 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1211 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1212 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1213 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1214 /// after reloading from disk while replaying blocks against ChannelMonitors.
1216 /// See `PendingOutboundPayment` documentation for more info.
1218 /// See `ChannelManager` struct-level documentation for lock order requirements.
1219 pending_outbound_payments: OutboundPayments,
1221 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1223 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1224 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1225 /// and via the classic SCID.
1227 /// Note that no consistency guarantees are made about the existence of a channel with the
1228 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1230 /// See `ChannelManager` struct-level documentation for lock order requirements.
1232 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1234 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1235 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1236 /// until the user tells us what we should do with them.
1238 /// See `ChannelManager` struct-level documentation for lock order requirements.
1239 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1241 /// The sets of payments which are claimable or currently being claimed. See
1242 /// [`ClaimablePayments`]' individual field docs for more info.
1244 /// See `ChannelManager` struct-level documentation for lock order requirements.
1245 claimable_payments: Mutex<ClaimablePayments>,
1247 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1248 /// and some closed channels which reached a usable state prior to being closed. This is used
1249 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1250 /// active channel list on load.
1252 /// See `ChannelManager` struct-level documentation for lock order requirements.
1253 outbound_scid_aliases: Mutex<HashSet<u64>>,
1255 /// Channel funding outpoint -> `counterparty_node_id`.
1257 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1258 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1259 /// the handling of the events.
1261 /// Note that no consistency guarantees are made about the existence of a peer with the
1262 /// `counterparty_node_id` in our other maps.
1265 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1266 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1267 /// would break backwards compatability.
1268 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1269 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1270 /// required to access the channel with the `counterparty_node_id`.
1272 /// See `ChannelManager` struct-level documentation for lock order requirements.
1274 outpoint_to_peer: Mutex<HashMap<OutPoint, PublicKey>>,
1276 pub(crate) outpoint_to_peer: Mutex<HashMap<OutPoint, PublicKey>>,
1278 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1280 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1281 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1282 /// confirmation depth.
1284 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1285 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1286 /// channel with the `channel_id` in our other maps.
1288 /// See `ChannelManager` struct-level documentation for lock order requirements.
1290 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1292 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1294 our_network_pubkey: PublicKey,
1296 inbound_payment_key: inbound_payment::ExpandedKey,
1298 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1299 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1300 /// we encrypt the namespace identifier using these bytes.
1302 /// [fake scids]: crate::util::scid_utils::fake_scid
1303 fake_scid_rand_bytes: [u8; 32],
1305 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1306 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1307 /// keeping additional state.
1308 probing_cookie_secret: [u8; 32],
1310 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1311 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1312 /// very far in the past, and can only ever be up to two hours in the future.
1313 highest_seen_timestamp: AtomicUsize,
1315 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1316 /// basis, as well as the peer's latest features.
1318 /// If we are connected to a peer we always at least have an entry here, even if no channels
1319 /// are currently open with that peer.
1321 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1322 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1325 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1327 /// See `ChannelManager` struct-level documentation for lock order requirements.
1328 #[cfg(not(any(test, feature = "_test_utils")))]
1329 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1330 #[cfg(any(test, feature = "_test_utils"))]
1331 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1333 /// The set of events which we need to give to the user to handle. In some cases an event may
1334 /// require some further action after the user handles it (currently only blocking a monitor
1335 /// update from being handed to the user to ensure the included changes to the channel state
1336 /// are handled by the user before they're persisted durably to disk). In that case, the second
1337 /// element in the tuple is set to `Some` with further details of the action.
1339 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1340 /// could be in the middle of being processed without the direct mutex held.
1342 /// See `ChannelManager` struct-level documentation for lock order requirements.
1343 #[cfg(not(any(test, feature = "_test_utils")))]
1344 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1345 #[cfg(any(test, feature = "_test_utils"))]
1346 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1348 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1349 pending_events_processor: AtomicBool,
1351 /// If we are running during init (either directly during the deserialization method or in
1352 /// block connection methods which run after deserialization but before normal operation) we
1353 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1354 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1355 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1357 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1359 /// See `ChannelManager` struct-level documentation for lock order requirements.
1361 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1362 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1363 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1364 /// Essentially just when we're serializing ourselves out.
1365 /// Taken first everywhere where we are making changes before any other locks.
1366 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1367 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1368 /// Notifier the lock contains sends out a notification when the lock is released.
1369 total_consistency_lock: RwLock<()>,
1370 /// Tracks the progress of channels going through batch funding by whether funding_signed was
1371 /// received and the monitor has been persisted.
1373 /// This information does not need to be persisted as funding nodes can forget
1374 /// unfunded channels upon disconnection.
1375 funding_batch_states: Mutex<BTreeMap<Txid, Vec<(ChannelId, PublicKey, bool)>>>,
1377 background_events_processed_since_startup: AtomicBool,
1379 event_persist_notifier: Notifier,
1380 needs_persist_flag: AtomicBool,
1382 pending_offers_messages: Mutex<Vec<PendingOnionMessage<OffersMessage>>>,
1386 signer_provider: SP,
1391 /// Chain-related parameters used to construct a new `ChannelManager`.
1393 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1394 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1395 /// are not needed when deserializing a previously constructed `ChannelManager`.
1396 #[derive(Clone, Copy, PartialEq)]
1397 pub struct ChainParameters {
1398 /// The network for determining the `chain_hash` in Lightning messages.
1399 pub network: Network,
1401 /// The hash and height of the latest block successfully connected.
1403 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1404 pub best_block: BestBlock,
1407 #[derive(Copy, Clone, PartialEq)]
1411 SkipPersistHandleEvents,
1412 SkipPersistNoEvents,
1415 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1416 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1417 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1418 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1419 /// sending the aforementioned notification (since the lock being released indicates that the
1420 /// updates are ready for persistence).
1422 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1423 /// notify or not based on whether relevant changes have been made, providing a closure to
1424 /// `optionally_notify` which returns a `NotifyOption`.
1425 struct PersistenceNotifierGuard<'a, F: FnMut() -> NotifyOption> {
1426 event_persist_notifier: &'a Notifier,
1427 needs_persist_flag: &'a AtomicBool,
1429 // We hold onto this result so the lock doesn't get released immediately.
1430 _read_guard: RwLockReadGuard<'a, ()>,
1433 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1434 /// Notifies any waiters and indicates that we need to persist, in addition to possibly having
1435 /// events to handle.
1437 /// This must always be called if the changes included a `ChannelMonitorUpdate`, as well as in
1438 /// other cases where losing the changes on restart may result in a force-close or otherwise
1440 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1441 Self::optionally_notify(cm, || -> NotifyOption { NotifyOption::DoPersist })
1444 fn optionally_notify<F: FnMut() -> NotifyOption, C: AChannelManager>(cm: &'a C, mut persist_check: F)
1445 -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1446 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1447 let force_notify = cm.get_cm().process_background_events();
1449 PersistenceNotifierGuard {
1450 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1451 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1452 should_persist: move || {
1453 // Pick the "most" action between `persist_check` and the background events
1454 // processing and return that.
1455 let notify = persist_check();
1456 match (notify, force_notify) {
1457 (NotifyOption::DoPersist, _) => NotifyOption::DoPersist,
1458 (_, NotifyOption::DoPersist) => NotifyOption::DoPersist,
1459 (NotifyOption::SkipPersistHandleEvents, _) => NotifyOption::SkipPersistHandleEvents,
1460 (_, NotifyOption::SkipPersistHandleEvents) => NotifyOption::SkipPersistHandleEvents,
1461 _ => NotifyOption::SkipPersistNoEvents,
1464 _read_guard: read_guard,
1468 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1469 /// [`ChannelManager::process_background_events`] MUST be called first (or
1470 /// [`Self::optionally_notify`] used).
1471 fn optionally_notify_skipping_background_events<F: Fn() -> NotifyOption, C: AChannelManager>
1472 (cm: &'a C, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1473 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1475 PersistenceNotifierGuard {
1476 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1477 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1478 should_persist: persist_check,
1479 _read_guard: read_guard,
1484 impl<'a, F: FnMut() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1485 fn drop(&mut self) {
1486 match (self.should_persist)() {
1487 NotifyOption::DoPersist => {
1488 self.needs_persist_flag.store(true, Ordering::Release);
1489 self.event_persist_notifier.notify()
1491 NotifyOption::SkipPersistHandleEvents =>
1492 self.event_persist_notifier.notify(),
1493 NotifyOption::SkipPersistNoEvents => {},
1498 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1499 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1501 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1503 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1504 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1505 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1506 /// the maximum required amount in lnd as of March 2021.
1507 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1509 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1510 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1512 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1514 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1515 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1516 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1517 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1518 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1519 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1520 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1521 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1522 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1523 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1524 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1525 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1526 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1528 /// Minimum CLTV difference between the current block height and received inbound payments.
1529 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1531 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1532 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1533 // a payment was being routed, so we add an extra block to be safe.
1534 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1536 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1537 // ie that if the next-hop peer fails the HTLC within
1538 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1539 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1540 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1541 // LATENCY_GRACE_PERIOD_BLOCKS.
1543 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;
1545 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1546 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1548 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1550 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1551 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1553 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1554 /// until we mark the channel disabled and gossip the update.
1555 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1557 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1558 /// we mark the channel enabled and gossip the update.
1559 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1561 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1562 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1563 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1564 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1566 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1567 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1568 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1570 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1571 /// many peers we reject new (inbound) connections.
1572 const MAX_NO_CHANNEL_PEERS: usize = 250;
1574 /// Information needed for constructing an invoice route hint for this channel.
1575 #[derive(Clone, Debug, PartialEq)]
1576 pub struct CounterpartyForwardingInfo {
1577 /// Base routing fee in millisatoshis.
1578 pub fee_base_msat: u32,
1579 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1580 pub fee_proportional_millionths: u32,
1581 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1582 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1583 /// `cltv_expiry_delta` for more details.
1584 pub cltv_expiry_delta: u16,
1587 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1588 /// to better separate parameters.
1589 #[derive(Clone, Debug, PartialEq)]
1590 pub struct ChannelCounterparty {
1591 /// The node_id of our counterparty
1592 pub node_id: PublicKey,
1593 /// The Features the channel counterparty provided upon last connection.
1594 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1595 /// many routing-relevant features are present in the init context.
1596 pub features: InitFeatures,
1597 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1598 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1599 /// claiming at least this value on chain.
1601 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1603 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1604 pub unspendable_punishment_reserve: u64,
1605 /// Information on the fees and requirements that the counterparty requires when forwarding
1606 /// payments to us through this channel.
1607 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1608 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1609 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1610 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1611 pub outbound_htlc_minimum_msat: Option<u64>,
1612 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1613 pub outbound_htlc_maximum_msat: Option<u64>,
1616 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1617 #[derive(Clone, Debug, PartialEq)]
1618 pub struct ChannelDetails {
1619 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1620 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1621 /// Note that this means this value is *not* persistent - it can change once during the
1622 /// lifetime of the channel.
1623 pub channel_id: ChannelId,
1624 /// Parameters which apply to our counterparty. See individual fields for more information.
1625 pub counterparty: ChannelCounterparty,
1626 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1627 /// our counterparty already.
1629 /// Note that, if this has been set, `channel_id` will be equivalent to
1630 /// `funding_txo.unwrap().to_channel_id()`.
1631 pub funding_txo: Option<OutPoint>,
1632 /// The features which this channel operates with. See individual features for more info.
1634 /// `None` until negotiation completes and the channel type is finalized.
1635 pub channel_type: Option<ChannelTypeFeatures>,
1636 /// The position of the funding transaction in the chain. None if the funding transaction has
1637 /// not yet been confirmed and the channel fully opened.
1639 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1640 /// payments instead of this. See [`get_inbound_payment_scid`].
1642 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1643 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1645 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1646 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1647 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1648 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1649 /// [`confirmations_required`]: Self::confirmations_required
1650 pub short_channel_id: Option<u64>,
1651 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1652 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1653 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1656 /// This will be `None` as long as the channel is not available for routing outbound payments.
1658 /// [`short_channel_id`]: Self::short_channel_id
1659 /// [`confirmations_required`]: Self::confirmations_required
1660 pub outbound_scid_alias: Option<u64>,
1661 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1662 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1663 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1664 /// when they see a payment to be routed to us.
1666 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1667 /// previous values for inbound payment forwarding.
1669 /// [`short_channel_id`]: Self::short_channel_id
1670 pub inbound_scid_alias: Option<u64>,
1671 /// The value, in satoshis, of this channel as appears in the funding output
1672 pub channel_value_satoshis: u64,
1673 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1674 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1675 /// this value on chain.
1677 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1679 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1681 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1682 pub unspendable_punishment_reserve: Option<u64>,
1683 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1684 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1685 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1686 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1687 /// serialized with LDK versions prior to 0.0.113.
1689 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1690 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1691 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1692 pub user_channel_id: u128,
1693 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1694 /// which is applied to commitment and HTLC transactions.
1696 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1697 pub feerate_sat_per_1000_weight: Option<u32>,
1698 /// Our total balance. This is the amount we would get if we close the channel.
1699 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1700 /// amount is not likely to be recoverable on close.
1702 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1703 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1704 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1705 /// This does not consider any on-chain fees.
1707 /// See also [`ChannelDetails::outbound_capacity_msat`]
1708 pub balance_msat: u64,
1709 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1710 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1711 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1712 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1714 /// See also [`ChannelDetails::balance_msat`]
1716 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1717 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1718 /// should be able to spend nearly this amount.
1719 pub outbound_capacity_msat: u64,
1720 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1721 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1722 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1723 /// to use a limit as close as possible to the HTLC limit we can currently send.
1725 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1726 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1727 pub next_outbound_htlc_limit_msat: u64,
1728 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1729 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1730 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1731 /// route which is valid.
1732 pub next_outbound_htlc_minimum_msat: u64,
1733 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1734 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1735 /// available for inclusion in new inbound HTLCs).
1736 /// Note that there are some corner cases not fully handled here, so the actual available
1737 /// inbound capacity may be slightly higher than this.
1739 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1740 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1741 /// However, our counterparty should be able to spend nearly this amount.
1742 pub inbound_capacity_msat: u64,
1743 /// The number of required confirmations on the funding transaction before the funding will be
1744 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1745 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1746 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1747 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1749 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1751 /// [`is_outbound`]: ChannelDetails::is_outbound
1752 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1753 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1754 pub confirmations_required: Option<u32>,
1755 /// The current number of confirmations on the funding transaction.
1757 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1758 pub confirmations: Option<u32>,
1759 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1760 /// until we can claim our funds after we force-close the channel. During this time our
1761 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1762 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1763 /// time to claim our non-HTLC-encumbered funds.
1765 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1766 pub force_close_spend_delay: Option<u16>,
1767 /// True if the channel was initiated (and thus funded) by us.
1768 pub is_outbound: bool,
1769 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1770 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1771 /// required confirmation count has been reached (and we were connected to the peer at some
1772 /// point after the funding transaction received enough confirmations). The required
1773 /// confirmation count is provided in [`confirmations_required`].
1775 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1776 pub is_channel_ready: bool,
1777 /// The stage of the channel's shutdown.
1778 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1779 pub channel_shutdown_state: Option<ChannelShutdownState>,
1780 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1781 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1783 /// This is a strict superset of `is_channel_ready`.
1784 pub is_usable: bool,
1785 /// True if this channel is (or will be) publicly-announced.
1786 pub is_public: bool,
1787 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1788 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1789 pub inbound_htlc_minimum_msat: Option<u64>,
1790 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1791 pub inbound_htlc_maximum_msat: Option<u64>,
1792 /// Set of configurable parameters that affect channel operation.
1794 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1795 pub config: Option<ChannelConfig>,
1798 impl ChannelDetails {
1799 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1800 /// This should be used for providing invoice hints or in any other context where our
1801 /// counterparty will forward a payment to us.
1803 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1804 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1805 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1806 self.inbound_scid_alias.or(self.short_channel_id)
1809 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1810 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1811 /// we're sending or forwarding a payment outbound over this channel.
1813 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1814 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1815 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1816 self.short_channel_id.or(self.outbound_scid_alias)
1819 fn from_channel_context<SP: Deref, F: Deref>(
1820 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1821 fee_estimator: &LowerBoundedFeeEstimator<F>
1824 SP::Target: SignerProvider,
1825 F::Target: FeeEstimator
1827 let balance = context.get_available_balances(fee_estimator);
1828 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1829 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1831 channel_id: context.channel_id(),
1832 counterparty: ChannelCounterparty {
1833 node_id: context.get_counterparty_node_id(),
1834 features: latest_features,
1835 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1836 forwarding_info: context.counterparty_forwarding_info(),
1837 // Ensures that we have actually received the `htlc_minimum_msat` value
1838 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1839 // message (as they are always the first message from the counterparty).
1840 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1841 // default `0` value set by `Channel::new_outbound`.
1842 outbound_htlc_minimum_msat: if context.have_received_message() {
1843 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1844 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1846 funding_txo: context.get_funding_txo(),
1847 // Note that accept_channel (or open_channel) is always the first message, so
1848 // `have_received_message` indicates that type negotiation has completed.
1849 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1850 short_channel_id: context.get_short_channel_id(),
1851 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1852 inbound_scid_alias: context.latest_inbound_scid_alias(),
1853 channel_value_satoshis: context.get_value_satoshis(),
1854 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1855 unspendable_punishment_reserve: to_self_reserve_satoshis,
1856 balance_msat: balance.balance_msat,
1857 inbound_capacity_msat: balance.inbound_capacity_msat,
1858 outbound_capacity_msat: balance.outbound_capacity_msat,
1859 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1860 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1861 user_channel_id: context.get_user_id(),
1862 confirmations_required: context.minimum_depth(),
1863 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1864 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1865 is_outbound: context.is_outbound(),
1866 is_channel_ready: context.is_usable(),
1867 is_usable: context.is_live(),
1868 is_public: context.should_announce(),
1869 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1870 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1871 config: Some(context.config()),
1872 channel_shutdown_state: Some(context.shutdown_state()),
1877 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1878 /// Further information on the details of the channel shutdown.
1879 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1880 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1881 /// the channel will be removed shortly.
1882 /// Also note, that in normal operation, peers could disconnect at any of these states
1883 /// and require peer re-connection before making progress onto other states
1884 pub enum ChannelShutdownState {
1885 /// Channel has not sent or received a shutdown message.
1887 /// Local node has sent a shutdown message for this channel.
1889 /// Shutdown message exchanges have concluded and the channels are in the midst of
1890 /// resolving all existing open HTLCs before closing can continue.
1892 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1893 NegotiatingClosingFee,
1894 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1895 /// to drop the channel.
1899 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1900 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1901 #[derive(Debug, PartialEq)]
1902 pub enum RecentPaymentDetails {
1903 /// When an invoice was requested and thus a payment has not yet been sent.
1905 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1906 /// a payment and ensure idempotency in LDK.
1907 payment_id: PaymentId,
1909 /// When a payment is still being sent and awaiting successful delivery.
1911 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1912 /// a payment and ensure idempotency in LDK.
1913 payment_id: PaymentId,
1914 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1916 payment_hash: PaymentHash,
1917 /// Total amount (in msat, excluding fees) across all paths for this payment,
1918 /// not just the amount currently inflight.
1921 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1922 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1923 /// payment is removed from tracking.
1925 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1926 /// a payment and ensure idempotency in LDK.
1927 payment_id: PaymentId,
1928 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1929 /// made before LDK version 0.0.104.
1930 payment_hash: Option<PaymentHash>,
1932 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1933 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1934 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1936 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1937 /// a payment and ensure idempotency in LDK.
1938 payment_id: PaymentId,
1939 /// Hash of the payment that we have given up trying to send.
1940 payment_hash: PaymentHash,
1944 /// Route hints used in constructing invoices for [phantom node payents].
1946 /// [phantom node payments]: crate::sign::PhantomKeysManager
1948 pub struct PhantomRouteHints {
1949 /// The list of channels to be included in the invoice route hints.
1950 pub channels: Vec<ChannelDetails>,
1951 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1953 pub phantom_scid: u64,
1954 /// The pubkey of the real backing node that would ultimately receive the payment.
1955 pub real_node_pubkey: PublicKey,
1958 macro_rules! handle_error {
1959 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1960 // In testing, ensure there are no deadlocks where the lock is already held upon
1961 // entering the macro.
1962 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1963 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1967 Err(MsgHandleErrInternal { err, shutdown_finish, .. }) => {
1968 let mut msg_events = Vec::with_capacity(2);
1970 if let Some((shutdown_res, update_option)) = shutdown_finish {
1971 let counterparty_node_id = shutdown_res.counterparty_node_id;
1972 let channel_id = shutdown_res.channel_id;
1973 let logger = WithContext::from(
1974 &$self.logger, Some(counterparty_node_id), Some(channel_id),
1976 log_error!(logger, "Force-closing channel: {}", err.err);
1978 $self.finish_close_channel(shutdown_res);
1979 if let Some(update) = update_option {
1980 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1985 log_error!($self.logger, "Got non-closing error: {}", err.err);
1988 if let msgs::ErrorAction::IgnoreError = err.action {
1990 msg_events.push(events::MessageSendEvent::HandleError {
1991 node_id: $counterparty_node_id,
1992 action: err.action.clone()
1996 if !msg_events.is_empty() {
1997 let per_peer_state = $self.per_peer_state.read().unwrap();
1998 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1999 let mut peer_state = peer_state_mutex.lock().unwrap();
2000 peer_state.pending_msg_events.append(&mut msg_events);
2004 // Return error in case higher-API need one
2011 macro_rules! update_maps_on_chan_removal {
2012 ($self: expr, $channel_context: expr) => {{
2013 if let Some(outpoint) = $channel_context.get_funding_txo() {
2014 $self.outpoint_to_peer.lock().unwrap().remove(&outpoint);
2016 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2017 if let Some(short_id) = $channel_context.get_short_channel_id() {
2018 short_to_chan_info.remove(&short_id);
2020 // If the channel was never confirmed on-chain prior to its closure, remove the
2021 // outbound SCID alias we used for it from the collision-prevention set. While we
2022 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
2023 // also don't want a counterparty to be able to trivially cause a memory leak by simply
2024 // opening a million channels with us which are closed before we ever reach the funding
2026 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
2027 debug_assert!(alias_removed);
2029 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
2033 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
2034 macro_rules! convert_chan_phase_err {
2035 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
2037 ChannelError::Warn(msg) => {
2038 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
2040 ChannelError::Ignore(msg) => {
2041 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
2043 ChannelError::Close(msg) => {
2044 let logger = WithChannelContext::from(&$self.logger, &$channel.context);
2045 log_error!(logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
2046 update_maps_on_chan_removal!($self, $channel.context);
2047 let reason = ClosureReason::ProcessingError { err: msg.clone() };
2048 let shutdown_res = $channel.context.force_shutdown(true, reason);
2050 MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $channel_update);
2055 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
2056 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
2058 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
2059 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
2061 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
2062 match $channel_phase {
2063 ChannelPhase::Funded(channel) => {
2064 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
2066 ChannelPhase::UnfundedOutboundV1(channel) => {
2067 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2069 ChannelPhase::UnfundedInboundV1(channel) => {
2070 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2076 macro_rules! break_chan_phase_entry {
2077 ($self: ident, $res: expr, $entry: expr) => {
2081 let key = *$entry.key();
2082 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2084 $entry.remove_entry();
2092 macro_rules! try_chan_phase_entry {
2093 ($self: ident, $res: expr, $entry: expr) => {
2097 let key = *$entry.key();
2098 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2100 $entry.remove_entry();
2108 macro_rules! remove_channel_phase {
2109 ($self: expr, $entry: expr) => {
2111 let channel = $entry.remove_entry().1;
2112 update_maps_on_chan_removal!($self, &channel.context());
2118 macro_rules! send_channel_ready {
2119 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
2120 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
2121 node_id: $channel.context.get_counterparty_node_id(),
2122 msg: $channel_ready_msg,
2124 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
2125 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
2126 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2127 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2128 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2129 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2130 if let Some(real_scid) = $channel.context.get_short_channel_id() {
2131 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2132 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2133 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2138 macro_rules! emit_channel_pending_event {
2139 ($locked_events: expr, $channel: expr) => {
2140 if $channel.context.should_emit_channel_pending_event() {
2141 $locked_events.push_back((events::Event::ChannelPending {
2142 channel_id: $channel.context.channel_id(),
2143 former_temporary_channel_id: $channel.context.temporary_channel_id(),
2144 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2145 user_channel_id: $channel.context.get_user_id(),
2146 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
2148 $channel.context.set_channel_pending_event_emitted();
2153 macro_rules! emit_channel_ready_event {
2154 ($locked_events: expr, $channel: expr) => {
2155 if $channel.context.should_emit_channel_ready_event() {
2156 debug_assert!($channel.context.channel_pending_event_emitted());
2157 $locked_events.push_back((events::Event::ChannelReady {
2158 channel_id: $channel.context.channel_id(),
2159 user_channel_id: $channel.context.get_user_id(),
2160 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2161 channel_type: $channel.context.get_channel_type().clone(),
2163 $channel.context.set_channel_ready_event_emitted();
2168 macro_rules! handle_monitor_update_completion {
2169 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2170 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2171 let mut updates = $chan.monitor_updating_restored(&&logger,
2172 &$self.node_signer, $self.chain_hash, &$self.default_configuration,
2173 $self.best_block.read().unwrap().height());
2174 let counterparty_node_id = $chan.context.get_counterparty_node_id();
2175 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
2176 // We only send a channel_update in the case where we are just now sending a
2177 // channel_ready and the channel is in a usable state. We may re-send a
2178 // channel_update later through the announcement_signatures process for public
2179 // channels, but there's no reason not to just inform our counterparty of our fees
2181 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
2182 Some(events::MessageSendEvent::SendChannelUpdate {
2183 node_id: counterparty_node_id,
2189 let update_actions = $peer_state.monitor_update_blocked_actions
2190 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
2192 let htlc_forwards = $self.handle_channel_resumption(
2193 &mut $peer_state.pending_msg_events, $chan, updates.raa,
2194 updates.commitment_update, updates.order, updates.accepted_htlcs,
2195 updates.funding_broadcastable, updates.channel_ready,
2196 updates.announcement_sigs);
2197 if let Some(upd) = channel_update {
2198 $peer_state.pending_msg_events.push(upd);
2201 let channel_id = $chan.context.channel_id();
2202 let unbroadcasted_batch_funding_txid = $chan.context.unbroadcasted_batch_funding_txid();
2203 core::mem::drop($peer_state_lock);
2204 core::mem::drop($per_peer_state_lock);
2206 // If the channel belongs to a batch funding transaction, the progress of the batch
2207 // should be updated as we have received funding_signed and persisted the monitor.
2208 if let Some(txid) = unbroadcasted_batch_funding_txid {
2209 let mut funding_batch_states = $self.funding_batch_states.lock().unwrap();
2210 let mut batch_completed = false;
2211 if let Some(batch_state) = funding_batch_states.get_mut(&txid) {
2212 let channel_state = batch_state.iter_mut().find(|(chan_id, pubkey, _)| (
2213 *chan_id == channel_id &&
2214 *pubkey == counterparty_node_id
2216 if let Some(channel_state) = channel_state {
2217 channel_state.2 = true;
2219 debug_assert!(false, "Missing channel batch state for channel which completed initial monitor update");
2221 batch_completed = batch_state.iter().all(|(_, _, completed)| *completed);
2223 debug_assert!(false, "Missing batch state for channel which completed initial monitor update");
2226 // When all channels in a batched funding transaction have become ready, it is not necessary
2227 // to track the progress of the batch anymore and the state of the channels can be updated.
2228 if batch_completed {
2229 let removed_batch_state = funding_batch_states.remove(&txid).into_iter().flatten();
2230 let per_peer_state = $self.per_peer_state.read().unwrap();
2231 let mut batch_funding_tx = None;
2232 for (channel_id, counterparty_node_id, _) in removed_batch_state {
2233 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2234 let mut peer_state = peer_state_mutex.lock().unwrap();
2235 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
2236 batch_funding_tx = batch_funding_tx.or_else(|| chan.context.unbroadcasted_funding());
2237 chan.set_batch_ready();
2238 let mut pending_events = $self.pending_events.lock().unwrap();
2239 emit_channel_pending_event!(pending_events, chan);
2243 if let Some(tx) = batch_funding_tx {
2244 log_info!($self.logger, "Broadcasting batch funding transaction with txid {}", tx.txid());
2245 $self.tx_broadcaster.broadcast_transactions(&[&tx]);
2250 $self.handle_monitor_update_completion_actions(update_actions);
2252 if let Some(forwards) = htlc_forwards {
2253 $self.forward_htlcs(&mut [forwards][..]);
2255 $self.finalize_claims(updates.finalized_claimed_htlcs);
2256 for failure in updates.failed_htlcs.drain(..) {
2257 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2258 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2263 macro_rules! handle_new_monitor_update {
2264 ($self: ident, $update_res: expr, $chan: expr, _internal, $completed: expr) => { {
2265 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2266 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2268 ChannelMonitorUpdateStatus::UnrecoverableError => {
2269 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
2270 log_error!(logger, "{}", err_str);
2271 panic!("{}", err_str);
2273 ChannelMonitorUpdateStatus::InProgress => {
2274 log_debug!(logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2275 &$chan.context.channel_id());
2278 ChannelMonitorUpdateStatus::Completed => {
2284 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, INITIAL_MONITOR) => {
2285 handle_new_monitor_update!($self, $update_res, $chan, _internal,
2286 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2288 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2289 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2290 .or_insert_with(Vec::new);
2291 // During startup, we push monitor updates as background events through to here in
2292 // order to replay updates that were in-flight when we shut down. Thus, we have to
2293 // filter for uniqueness here.
2294 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2295 .unwrap_or_else(|| {
2296 in_flight_updates.push($update);
2297 in_flight_updates.len() - 1
2299 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2300 handle_new_monitor_update!($self, update_res, $chan, _internal,
2302 let _ = in_flight_updates.remove(idx);
2303 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2304 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2310 macro_rules! process_events_body {
2311 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2312 let mut processed_all_events = false;
2313 while !processed_all_events {
2314 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2321 // We'll acquire our total consistency lock so that we can be sure no other
2322 // persists happen while processing monitor events.
2323 let _read_guard = $self.total_consistency_lock.read().unwrap();
2325 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2326 // ensure any startup-generated background events are handled first.
2327 result = $self.process_background_events();
2329 // TODO: This behavior should be documented. It's unintuitive that we query
2330 // ChannelMonitors when clearing other events.
2331 if $self.process_pending_monitor_events() {
2332 result = NotifyOption::DoPersist;
2336 let pending_events = $self.pending_events.lock().unwrap().clone();
2337 let num_events = pending_events.len();
2338 if !pending_events.is_empty() {
2339 result = NotifyOption::DoPersist;
2342 let mut post_event_actions = Vec::new();
2344 for (event, action_opt) in pending_events {
2345 $event_to_handle = event;
2347 if let Some(action) = action_opt {
2348 post_event_actions.push(action);
2353 let mut pending_events = $self.pending_events.lock().unwrap();
2354 pending_events.drain(..num_events);
2355 processed_all_events = pending_events.is_empty();
2356 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2357 // updated here with the `pending_events` lock acquired.
2358 $self.pending_events_processor.store(false, Ordering::Release);
2361 if !post_event_actions.is_empty() {
2362 $self.handle_post_event_actions(post_event_actions);
2363 // If we had some actions, go around again as we may have more events now
2364 processed_all_events = false;
2368 NotifyOption::DoPersist => {
2369 $self.needs_persist_flag.store(true, Ordering::Release);
2370 $self.event_persist_notifier.notify();
2372 NotifyOption::SkipPersistHandleEvents =>
2373 $self.event_persist_notifier.notify(),
2374 NotifyOption::SkipPersistNoEvents => {},
2380 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>
2382 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
2383 T::Target: BroadcasterInterface,
2384 ES::Target: EntropySource,
2385 NS::Target: NodeSigner,
2386 SP::Target: SignerProvider,
2387 F::Target: FeeEstimator,
2391 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2393 /// The current time or latest block header time can be provided as the `current_timestamp`.
2395 /// This is the main "logic hub" for all channel-related actions, and implements
2396 /// [`ChannelMessageHandler`].
2398 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2400 /// Users need to notify the new `ChannelManager` when a new block is connected or
2401 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2402 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2405 /// [`block_connected`]: chain::Listen::block_connected
2406 /// [`block_disconnected`]: chain::Listen::block_disconnected
2407 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2409 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2410 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2411 current_timestamp: u32,
2413 let mut secp_ctx = Secp256k1::new();
2414 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2415 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2416 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2418 default_configuration: config.clone(),
2419 chain_hash: ChainHash::using_genesis_block(params.network),
2420 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2425 best_block: RwLock::new(params.best_block),
2427 outbound_scid_aliases: Mutex::new(HashSet::new()),
2428 pending_inbound_payments: Mutex::new(HashMap::new()),
2429 pending_outbound_payments: OutboundPayments::new(),
2430 forward_htlcs: Mutex::new(HashMap::new()),
2431 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2432 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2433 outpoint_to_peer: Mutex::new(HashMap::new()),
2434 short_to_chan_info: FairRwLock::new(HashMap::new()),
2436 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2439 inbound_payment_key: expanded_inbound_key,
2440 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2442 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2444 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2446 per_peer_state: FairRwLock::new(HashMap::new()),
2448 pending_events: Mutex::new(VecDeque::new()),
2449 pending_events_processor: AtomicBool::new(false),
2450 pending_background_events: Mutex::new(Vec::new()),
2451 total_consistency_lock: RwLock::new(()),
2452 background_events_processed_since_startup: AtomicBool::new(false),
2453 event_persist_notifier: Notifier::new(),
2454 needs_persist_flag: AtomicBool::new(false),
2455 funding_batch_states: Mutex::new(BTreeMap::new()),
2457 pending_offers_messages: Mutex::new(Vec::new()),
2467 /// Gets the current configuration applied to all new channels.
2468 pub fn get_current_default_configuration(&self) -> &UserConfig {
2469 &self.default_configuration
2472 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2473 let height = self.best_block.read().unwrap().height();
2474 let mut outbound_scid_alias = 0;
2477 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2478 outbound_scid_alias += 1;
2480 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2482 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2486 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"); }
2491 /// Creates a new outbound channel to the given remote node and with the given value.
2493 /// `user_channel_id` will be provided back as in
2494 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2495 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2496 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2497 /// is simply copied to events and otherwise ignored.
2499 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2500 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2502 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2503 /// generate a shutdown scriptpubkey or destination script set by
2504 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2506 /// Note that we do not check if you are currently connected to the given peer. If no
2507 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2508 /// the channel eventually being silently forgotten (dropped on reload).
2510 /// If `temporary_channel_id` is specified, it will be used as the temporary channel ID of the
2511 /// channel. Otherwise, a random one will be generated for you.
2513 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2514 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2515 /// [`ChannelDetails::channel_id`] until after
2516 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2517 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2518 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2520 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2521 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2522 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2523 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> {
2524 if channel_value_satoshis < 1000 {
2525 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2528 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2529 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2530 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2532 let per_peer_state = self.per_peer_state.read().unwrap();
2534 let peer_state_mutex = per_peer_state.get(&their_network_key)
2535 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2537 let mut peer_state = peer_state_mutex.lock().unwrap();
2539 if let Some(temporary_channel_id) = temporary_channel_id {
2540 if peer_state.channel_by_id.contains_key(&temporary_channel_id) {
2541 return Err(APIError::APIMisuseError{ err: format!("Channel with temporary channel ID {} already exists!", temporary_channel_id)});
2546 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2547 let their_features = &peer_state.latest_features;
2548 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2549 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2550 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2551 self.best_block.read().unwrap().height(), outbound_scid_alias, temporary_channel_id)
2555 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2560 let res = channel.get_open_channel(self.chain_hash);
2562 let temporary_channel_id = channel.context.channel_id();
2563 match peer_state.channel_by_id.entry(temporary_channel_id) {
2564 hash_map::Entry::Occupied(_) => {
2566 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2568 panic!("RNG is bad???");
2571 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2574 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2575 node_id: their_network_key,
2578 Ok(temporary_channel_id)
2581 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2582 // Allocate our best estimate of the number of channels we have in the `res`
2583 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2584 // a scid or a scid alias, and the `outpoint_to_peer` shouldn't be used outside
2585 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2586 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2587 // the same channel.
2588 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2590 let best_block_height = self.best_block.read().unwrap().height();
2591 let per_peer_state = self.per_peer_state.read().unwrap();
2592 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2593 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2594 let peer_state = &mut *peer_state_lock;
2595 res.extend(peer_state.channel_by_id.iter()
2596 .filter_map(|(chan_id, phase)| match phase {
2597 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2598 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2602 .map(|(_channel_id, channel)| {
2603 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2604 peer_state.latest_features.clone(), &self.fee_estimator)
2612 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2613 /// more information.
2614 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2615 // Allocate our best estimate of the number of channels we have in the `res`
2616 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2617 // a scid or a scid alias, and the `outpoint_to_peer` shouldn't be used outside
2618 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2619 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2620 // the same channel.
2621 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2623 let best_block_height = self.best_block.read().unwrap().height();
2624 let per_peer_state = self.per_peer_state.read().unwrap();
2625 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2626 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2627 let peer_state = &mut *peer_state_lock;
2628 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2629 let details = ChannelDetails::from_channel_context(context, best_block_height,
2630 peer_state.latest_features.clone(), &self.fee_estimator);
2638 /// Gets the list of usable channels, in random order. Useful as an argument to
2639 /// [`Router::find_route`] to ensure non-announced channels are used.
2641 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2642 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2644 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2645 // Note we use is_live here instead of usable which leads to somewhat confused
2646 // internal/external nomenclature, but that's ok cause that's probably what the user
2647 // really wanted anyway.
2648 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2651 /// Gets the list of channels we have with a given counterparty, in random order.
2652 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2653 let best_block_height = self.best_block.read().unwrap().height();
2654 let per_peer_state = self.per_peer_state.read().unwrap();
2656 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2657 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2658 let peer_state = &mut *peer_state_lock;
2659 let features = &peer_state.latest_features;
2660 let context_to_details = |context| {
2661 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2663 return peer_state.channel_by_id
2665 .map(|(_, phase)| phase.context())
2666 .map(context_to_details)
2672 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2673 /// successful path, or have unresolved HTLCs.
2675 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2676 /// result of a crash. If such a payment exists, is not listed here, and an
2677 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2679 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2680 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2681 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2682 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2683 PendingOutboundPayment::AwaitingInvoice { .. } => {
2684 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2686 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2687 PendingOutboundPayment::InvoiceReceived { .. } => {
2688 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2690 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2691 Some(RecentPaymentDetails::Pending {
2692 payment_id: *payment_id,
2693 payment_hash: *payment_hash,
2694 total_msat: *total_msat,
2697 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2698 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2700 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2701 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2703 PendingOutboundPayment::Legacy { .. } => None
2708 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> {
2709 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2711 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
2712 let mut shutdown_result = None;
2715 let per_peer_state = self.per_peer_state.read().unwrap();
2717 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2718 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2720 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2721 let peer_state = &mut *peer_state_lock;
2723 match peer_state.channel_by_id.entry(channel_id.clone()) {
2724 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2725 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2726 let funding_txo_opt = chan.context.get_funding_txo();
2727 let their_features = &peer_state.latest_features;
2728 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2729 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2730 failed_htlcs = htlcs;
2732 // We can send the `shutdown` message before updating the `ChannelMonitor`
2733 // here as we don't need the monitor update to complete until we send a
2734 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2735 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2736 node_id: *counterparty_node_id,
2740 debug_assert!(monitor_update_opt.is_none() || !chan.is_shutdown(),
2741 "We can't both complete shutdown and generate a monitor update");
2743 // Update the monitor with the shutdown script if necessary.
2744 if let Some(monitor_update) = monitor_update_opt.take() {
2745 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2746 peer_state_lock, peer_state, per_peer_state, chan);
2749 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2750 shutdown_result = Some(chan_phase.context_mut().force_shutdown(false, ClosureReason::HolderForceClosed));
2753 hash_map::Entry::Vacant(_) => {
2754 return Err(APIError::ChannelUnavailable {
2756 "Channel with id {} not found for the passed counterparty node_id {}",
2757 channel_id, counterparty_node_id,
2764 for htlc_source in failed_htlcs.drain(..) {
2765 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2766 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2767 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2770 if let Some(shutdown_result) = shutdown_result {
2771 self.finish_close_channel(shutdown_result);
2777 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2778 /// will be accepted on the given channel, and after additional timeout/the closing of all
2779 /// pending HTLCs, the channel will be closed on chain.
2781 /// * If we are the channel initiator, we will pay between our [`ChannelCloseMinimum`] and
2782 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2784 /// * If our counterparty is the channel initiator, we will require a channel closing
2785 /// transaction feerate of at least our [`ChannelCloseMinimum`] feerate or the feerate which
2786 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2787 /// counterparty to pay as much fee as they'd like, however.
2789 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2791 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2792 /// generate a shutdown scriptpubkey or destination script set by
2793 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2796 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2797 /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
2798 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2799 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2800 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2801 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2804 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2805 /// will be accepted on the given channel, and after additional timeout/the closing of all
2806 /// pending HTLCs, the channel will be closed on chain.
2808 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2809 /// the channel being closed or not:
2810 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2811 /// transaction. The upper-bound is set by
2812 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2813 /// fee estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2814 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2815 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2816 /// will appear on a force-closure transaction, whichever is lower).
2818 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2819 /// Will fail if a shutdown script has already been set for this channel by
2820 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2821 /// also be compatible with our and the counterparty's features.
2823 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2825 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2826 /// generate a shutdown scriptpubkey or destination script set by
2827 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2830 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2831 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2832 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2833 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> {
2834 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2837 fn finish_close_channel(&self, mut shutdown_res: ShutdownResult) {
2838 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
2839 #[cfg(debug_assertions)]
2840 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
2841 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
2844 let logger = WithContext::from(
2845 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
2848 log_debug!(logger, "Finishing closure of channel due to {} with {} HTLCs to fail",
2849 shutdown_res.closure_reason, shutdown_res.dropped_outbound_htlcs.len());
2850 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
2851 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2852 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2853 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2854 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2856 if let Some((_, funding_txo, monitor_update)) = shutdown_res.monitor_update {
2857 // There isn't anything we can do if we get an update failure - we're already
2858 // force-closing. The monitor update on the required in-memory copy should broadcast
2859 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2860 // ignore the result here.
2861 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2863 let mut shutdown_results = Vec::new();
2864 if let Some(txid) = shutdown_res.unbroadcasted_batch_funding_txid {
2865 let mut funding_batch_states = self.funding_batch_states.lock().unwrap();
2866 let affected_channels = funding_batch_states.remove(&txid).into_iter().flatten();
2867 let per_peer_state = self.per_peer_state.read().unwrap();
2868 let mut has_uncompleted_channel = None;
2869 for (channel_id, counterparty_node_id, state) in affected_channels {
2870 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2871 let mut peer_state = peer_state_mutex.lock().unwrap();
2872 if let Some(mut chan) = peer_state.channel_by_id.remove(&channel_id) {
2873 update_maps_on_chan_removal!(self, &chan.context());
2874 shutdown_results.push(chan.context_mut().force_shutdown(false, ClosureReason::FundingBatchClosure));
2877 has_uncompleted_channel = Some(has_uncompleted_channel.map_or(!state, |v| v || !state));
2880 has_uncompleted_channel.unwrap_or(true),
2881 "Closing a batch where all channels have completed initial monitor update",
2886 let mut pending_events = self.pending_events.lock().unwrap();
2887 pending_events.push_back((events::Event::ChannelClosed {
2888 channel_id: shutdown_res.channel_id,
2889 user_channel_id: shutdown_res.user_channel_id,
2890 reason: shutdown_res.closure_reason,
2891 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
2892 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
2895 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
2896 pending_events.push_back((events::Event::DiscardFunding {
2897 channel_id: shutdown_res.channel_id, transaction
2901 for shutdown_result in shutdown_results.drain(..) {
2902 self.finish_close_channel(shutdown_result);
2906 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2907 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2908 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2909 -> Result<PublicKey, APIError> {
2910 let per_peer_state = self.per_peer_state.read().unwrap();
2911 let peer_state_mutex = per_peer_state.get(peer_node_id)
2912 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2913 let (update_opt, counterparty_node_id) = {
2914 let mut peer_state = peer_state_mutex.lock().unwrap();
2915 let closure_reason = if let Some(peer_msg) = peer_msg {
2916 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2918 ClosureReason::HolderForceClosed
2920 let logger = WithContext::from(&self.logger, Some(*peer_node_id), Some(*channel_id));
2921 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2922 log_error!(logger, "Force-closing channel {}", channel_id);
2923 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2924 mem::drop(peer_state);
2925 mem::drop(per_peer_state);
2927 ChannelPhase::Funded(mut chan) => {
2928 self.finish_close_channel(chan.context.force_shutdown(broadcast, closure_reason));
2929 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2931 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2932 self.finish_close_channel(chan_phase.context_mut().force_shutdown(false, closure_reason));
2933 // Unfunded channel has no update
2934 (None, chan_phase.context().get_counterparty_node_id())
2937 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2938 log_error!(logger, "Force-closing channel {}", &channel_id);
2939 // N.B. that we don't send any channel close event here: we
2940 // don't have a user_channel_id, and we never sent any opening
2942 (None, *peer_node_id)
2944 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2947 if let Some(update) = update_opt {
2948 // Try to send the `BroadcastChannelUpdate` to the peer we just force-closed on, but if
2949 // not try to broadcast it via whatever peer we have.
2950 let per_peer_state = self.per_peer_state.read().unwrap();
2951 let a_peer_state_opt = per_peer_state.get(peer_node_id)
2952 .ok_or(per_peer_state.values().next());
2953 if let Ok(a_peer_state_mutex) = a_peer_state_opt {
2954 let mut a_peer_state = a_peer_state_mutex.lock().unwrap();
2955 a_peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2961 Ok(counterparty_node_id)
2964 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2965 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2966 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2967 Ok(counterparty_node_id) => {
2968 let per_peer_state = self.per_peer_state.read().unwrap();
2969 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2970 let mut peer_state = peer_state_mutex.lock().unwrap();
2971 peer_state.pending_msg_events.push(
2972 events::MessageSendEvent::HandleError {
2973 node_id: counterparty_node_id,
2974 action: msgs::ErrorAction::DisconnectPeer {
2975 msg: Some(msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() })
2986 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2987 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2988 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2990 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2991 -> Result<(), APIError> {
2992 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2995 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2996 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2997 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2999 /// You can always get the latest local transaction(s) to broadcast from
3000 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
3001 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
3002 -> Result<(), APIError> {
3003 self.force_close_sending_error(channel_id, counterparty_node_id, false)
3006 /// Force close all channels, immediately broadcasting the latest local commitment transaction
3007 /// for each to the chain and rejecting new HTLCs on each.
3008 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
3009 for chan in self.list_channels() {
3010 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
3014 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
3015 /// local transaction(s).
3016 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
3017 for chan in self.list_channels() {
3018 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
3022 fn decode_update_add_htlc_onion(
3023 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
3025 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
3027 let (next_hop, shared_secret, next_packet_details_opt) = decode_incoming_update_add_htlc_onion(
3028 msg, &self.node_signer, &self.logger, &self.secp_ctx
3031 let is_intro_node_forward = match next_hop {
3032 onion_utils::Hop::Forward {
3033 next_hop_data: msgs::InboundOnionPayload::BlindedForward {
3034 intro_node_blinding_point: Some(_), ..
3040 macro_rules! return_err {
3041 ($msg: expr, $err_code: expr, $data: expr) => {
3044 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
3045 "Failed to accept/forward incoming HTLC: {}", $msg
3047 // If `msg.blinding_point` is set, we must always fail with malformed.
3048 if msg.blinding_point.is_some() {
3049 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
3050 channel_id: msg.channel_id,
3051 htlc_id: msg.htlc_id,
3052 sha256_of_onion: [0; 32],
3053 failure_code: INVALID_ONION_BLINDING,
3057 let (err_code, err_data) = if is_intro_node_forward {
3058 (INVALID_ONION_BLINDING, &[0; 32][..])
3059 } else { ($err_code, $data) };
3060 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3061 channel_id: msg.channel_id,
3062 htlc_id: msg.htlc_id,
3063 reason: HTLCFailReason::reason(err_code, err_data.to_vec())
3064 .get_encrypted_failure_packet(&shared_secret, &None),
3070 let NextPacketDetails {
3071 next_packet_pubkey, outgoing_amt_msat, outgoing_scid, outgoing_cltv_value
3072 } = match next_packet_details_opt {
3073 Some(next_packet_details) => next_packet_details,
3074 // it is a receive, so no need for outbound checks
3075 None => return Ok((next_hop, shared_secret, None)),
3078 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
3079 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
3080 if let Some((err, mut code, chan_update)) = loop {
3081 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
3082 let forwarding_chan_info_opt = match id_option {
3083 None => { // unknown_next_peer
3084 // Note that this is likely a timing oracle for detecting whether an scid is a
3085 // phantom or an intercept.
3086 if (self.default_configuration.accept_intercept_htlcs &&
3087 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)) ||
3088 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)
3092 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3095 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
3097 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
3098 let per_peer_state = self.per_peer_state.read().unwrap();
3099 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3100 if peer_state_mutex_opt.is_none() {
3101 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3103 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3104 let peer_state = &mut *peer_state_lock;
3105 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
3106 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
3109 // Channel was removed. The short_to_chan_info and channel_by_id maps
3110 // have no consistency guarantees.
3111 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3115 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3116 // Note that the behavior here should be identical to the above block - we
3117 // should NOT reveal the existence or non-existence of a private channel if
3118 // we don't allow forwards outbound over them.
3119 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3121 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3122 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3123 // "refuse to forward unless the SCID alias was used", so we pretend
3124 // we don't have the channel here.
3125 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3127 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3129 // Note that we could technically not return an error yet here and just hope
3130 // that the connection is reestablished or monitor updated by the time we get
3131 // around to doing the actual forward, but better to fail early if we can and
3132 // hopefully an attacker trying to path-trace payments cannot make this occur
3133 // on a small/per-node/per-channel scale.
3134 if !chan.context.is_live() { // channel_disabled
3135 // If the channel_update we're going to return is disabled (i.e. the
3136 // peer has been disabled for some time), return `channel_disabled`,
3137 // otherwise return `temporary_channel_failure`.
3138 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3139 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3141 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3144 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3145 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3147 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3148 break Some((err, code, chan_update_opt));
3155 let cur_height = self.best_block.read().unwrap().height() + 1;
3157 if let Err((err_msg, code)) = check_incoming_htlc_cltv(
3158 cur_height, outgoing_cltv_value, msg.cltv_expiry
3160 if code & 0x1000 != 0 && chan_update_opt.is_none() {
3161 // We really should set `incorrect_cltv_expiry` here but as we're not
3162 // forwarding over a real channel we can't generate a channel_update
3163 // for it. Instead we just return a generic temporary_node_failure.
3164 break Some((err_msg, 0x2000 | 2, None))
3166 let chan_update_opt = if code & 0x1000 != 0 { chan_update_opt } else { None };
3167 break Some((err_msg, code, chan_update_opt));
3173 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3174 if let Some(chan_update) = chan_update {
3175 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3176 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3178 else if code == 0x1000 | 13 {
3179 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3181 else if code == 0x1000 | 20 {
3182 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3183 0u16.write(&mut res).expect("Writes cannot fail");
3185 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3186 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3187 chan_update.write(&mut res).expect("Writes cannot fail");
3188 } else if code & 0x1000 == 0x1000 {
3189 // If we're trying to return an error that requires a `channel_update` but
3190 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3191 // generate an update), just use the generic "temporary_node_failure"
3195 return_err!(err, code, &res.0[..]);
3197 Ok((next_hop, shared_secret, Some(next_packet_pubkey)))
3200 fn construct_pending_htlc_status<'a>(
3201 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
3202 decoded_hop: onion_utils::Hop, allow_underpay: bool,
3203 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
3204 ) -> PendingHTLCStatus {
3205 macro_rules! return_err {
3206 ($msg: expr, $err_code: expr, $data: expr) => {
3208 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
3209 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3210 if msg.blinding_point.is_some() {
3211 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(
3212 msgs::UpdateFailMalformedHTLC {
3213 channel_id: msg.channel_id,
3214 htlc_id: msg.htlc_id,
3215 sha256_of_onion: [0; 32],
3216 failure_code: INVALID_ONION_BLINDING,
3220 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3221 channel_id: msg.channel_id,
3222 htlc_id: msg.htlc_id,
3223 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3224 .get_encrypted_failure_packet(&shared_secret, &None),
3230 onion_utils::Hop::Receive(next_hop_data) => {
3232 let current_height: u32 = self.best_block.read().unwrap().height();
3233 match create_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3234 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat,
3235 current_height, self.default_configuration.accept_mpp_keysend)
3238 // Note that we could obviously respond immediately with an update_fulfill_htlc
3239 // message, however that would leak that we are the recipient of this payment, so
3240 // instead we stay symmetric with the forwarding case, only responding (after a
3241 // delay) once they've send us a commitment_signed!
3242 PendingHTLCStatus::Forward(info)
3244 Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3247 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3248 match create_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3249 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3250 Ok(info) => PendingHTLCStatus::Forward(info),
3251 Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3257 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3258 /// public, and thus should be called whenever the result is going to be passed out in a
3259 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3261 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3262 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3263 /// storage and the `peer_state` lock has been dropped.
3265 /// [`channel_update`]: msgs::ChannelUpdate
3266 /// [`internal_closing_signed`]: Self::internal_closing_signed
3267 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3268 if !chan.context.should_announce() {
3269 return Err(LightningError {
3270 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3271 action: msgs::ErrorAction::IgnoreError
3274 if chan.context.get_short_channel_id().is_none() {
3275 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3277 let logger = WithChannelContext::from(&self.logger, &chan.context);
3278 log_trace!(logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3279 self.get_channel_update_for_unicast(chan)
3282 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3283 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3284 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3285 /// provided evidence that they know about the existence of the channel.
3287 /// Note that through [`internal_closing_signed`], this function is called without the
3288 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3289 /// removed from the storage and the `peer_state` lock has been dropped.
3291 /// [`channel_update`]: msgs::ChannelUpdate
3292 /// [`internal_closing_signed`]: Self::internal_closing_signed
3293 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3294 let logger = WithChannelContext::from(&self.logger, &chan.context);
3295 log_trace!(logger, "Attempting to generate channel update for channel {}", chan.context.channel_id());
3296 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3297 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3301 self.get_channel_update_for_onion(short_channel_id, chan)
3304 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3305 let logger = WithChannelContext::from(&self.logger, &chan.context);
3306 log_trace!(logger, "Generating channel update for channel {}", chan.context.channel_id());
3307 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3309 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3310 ChannelUpdateStatus::Enabled => true,
3311 ChannelUpdateStatus::DisabledStaged(_) => true,
3312 ChannelUpdateStatus::Disabled => false,
3313 ChannelUpdateStatus::EnabledStaged(_) => false,
3316 let unsigned = msgs::UnsignedChannelUpdate {
3317 chain_hash: self.chain_hash,
3319 timestamp: chan.context.get_update_time_counter(),
3320 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3321 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3322 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3323 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3324 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3325 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3326 excess_data: Vec::new(),
3328 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3329 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3330 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3332 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3334 Ok(msgs::ChannelUpdate {
3341 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> {
3342 let _lck = self.total_consistency_lock.read().unwrap();
3343 self.send_payment_along_path(SendAlongPathArgs {
3344 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3349 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3350 let SendAlongPathArgs {
3351 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3354 // The top-level caller should hold the total_consistency_lock read lock.
3355 debug_assert!(self.total_consistency_lock.try_write().is_err());
3356 let prng_seed = self.entropy_source.get_secure_random_bytes();
3357 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3359 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
3360 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
3361 payment_hash, keysend_preimage, prng_seed
3363 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3364 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
3368 let err: Result<(), _> = loop {
3369 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3371 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3372 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
3373 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
3375 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3378 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
3380 "Attempting to send payment with payment hash {} along path with next hop {}",
3381 payment_hash, path.hops.first().unwrap().short_channel_id);
3383 let per_peer_state = self.per_peer_state.read().unwrap();
3384 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3385 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3386 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3387 let peer_state = &mut *peer_state_lock;
3388 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3389 match chan_phase_entry.get_mut() {
3390 ChannelPhase::Funded(chan) => {
3391 if !chan.context.is_live() {
3392 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3394 let funding_txo = chan.context.get_funding_txo().unwrap();
3395 let logger = WithChannelContext::from(&self.logger, &chan.context);
3396 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3397 htlc_cltv, HTLCSource::OutboundRoute {
3399 session_priv: session_priv.clone(),
3400 first_hop_htlc_msat: htlc_msat,
3402 }, onion_packet, None, &self.fee_estimator, &&logger);
3403 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3404 Some(monitor_update) => {
3405 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3407 // Note that MonitorUpdateInProgress here indicates (per function
3408 // docs) that we will resend the commitment update once monitor
3409 // updating completes. Therefore, we must return an error
3410 // indicating that it is unsafe to retry the payment wholesale,
3411 // which we do in the send_payment check for
3412 // MonitorUpdateInProgress, below.
3413 return Err(APIError::MonitorUpdateInProgress);
3421 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3424 // The channel was likely removed after we fetched the id from the
3425 // `short_to_chan_info` map, but before we successfully locked the
3426 // `channel_by_id` map.
3427 // This can occur as no consistency guarantees exists between the two maps.
3428 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3432 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3433 Ok(_) => unreachable!(),
3435 Err(APIError::ChannelUnavailable { err: e.err })
3440 /// Sends a payment along a given route.
3442 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3443 /// fields for more info.
3445 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3446 /// [`PeerManager::process_events`]).
3448 /// # Avoiding Duplicate Payments
3450 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3451 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3452 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3453 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3454 /// second payment with the same [`PaymentId`].
3456 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3457 /// tracking of payments, including state to indicate once a payment has completed. Because you
3458 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3459 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3460 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3462 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3463 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3464 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3465 /// [`ChannelManager::list_recent_payments`] for more information.
3467 /// # Possible Error States on [`PaymentSendFailure`]
3469 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3470 /// each entry matching the corresponding-index entry in the route paths, see
3471 /// [`PaymentSendFailure`] for more info.
3473 /// In general, a path may raise:
3474 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3475 /// node public key) is specified.
3476 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3477 /// closed, doesn't exist, or the peer is currently disconnected.
3478 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3479 /// relevant updates.
3481 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3482 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3483 /// different route unless you intend to pay twice!
3485 /// [`RouteHop`]: crate::routing::router::RouteHop
3486 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3487 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3488 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3489 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3490 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3491 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3492 let best_block_height = self.best_block.read().unwrap().height();
3493 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3494 self.pending_outbound_payments
3495 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3496 &self.entropy_source, &self.node_signer, best_block_height,
3497 |args| self.send_payment_along_path(args))
3500 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3501 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3502 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3503 let best_block_height = self.best_block.read().unwrap().height();
3504 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3505 self.pending_outbound_payments
3506 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3507 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3508 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3509 &self.pending_events, |args| self.send_payment_along_path(args))
3513 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> {
3514 let best_block_height = self.best_block.read().unwrap().height();
3515 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3516 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3517 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3518 best_block_height, |args| self.send_payment_along_path(args))
3522 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> {
3523 let best_block_height = self.best_block.read().unwrap().height();
3524 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3528 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3529 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3532 pub(super) fn send_payment_for_bolt12_invoice(&self, invoice: &Bolt12Invoice, payment_id: PaymentId) -> Result<(), Bolt12PaymentError> {
3533 let best_block_height = self.best_block.read().unwrap().height();
3534 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3535 self.pending_outbound_payments
3536 .send_payment_for_bolt12_invoice(
3537 invoice, payment_id, &self.router, self.list_usable_channels(),
3538 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer,
3539 best_block_height, &self.logger, &self.pending_events,
3540 |args| self.send_payment_along_path(args)
3544 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3545 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3546 /// retries are exhausted.
3548 /// # Event Generation
3550 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3551 /// as there are no remaining pending HTLCs for this payment.
3553 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3554 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3555 /// determine the ultimate status of a payment.
3557 /// # Requested Invoices
3559 /// In the case of paying a [`Bolt12Invoice`] via [`ChannelManager::pay_for_offer`], abandoning
3560 /// the payment prior to receiving the invoice will result in an [`Event::InvoiceRequestFailed`]
3561 /// and prevent any attempts at paying it once received. The other events may only be generated
3562 /// once the invoice has been received.
3564 /// # Restart Behavior
3566 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3567 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3568 /// [`Event::InvoiceRequestFailed`].
3570 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3571 pub fn abandon_payment(&self, payment_id: PaymentId) {
3572 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3573 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3576 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3577 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3578 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3579 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3580 /// never reach the recipient.
3582 /// See [`send_payment`] documentation for more details on the return value of this function
3583 /// and idempotency guarantees provided by the [`PaymentId`] key.
3585 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3586 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3588 /// [`send_payment`]: Self::send_payment
3589 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3590 let best_block_height = self.best_block.read().unwrap().height();
3591 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3592 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3593 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3594 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3597 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3598 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3600 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3603 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3604 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> {
3605 let best_block_height = self.best_block.read().unwrap().height();
3606 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3607 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3608 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3609 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3610 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3613 /// Send a payment that is probing the given route for liquidity. We calculate the
3614 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3615 /// us to easily discern them from real payments.
3616 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3617 let best_block_height = self.best_block.read().unwrap().height();
3618 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3619 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3620 &self.entropy_source, &self.node_signer, best_block_height,
3621 |args| self.send_payment_along_path(args))
3624 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3627 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3628 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3631 /// Sends payment probes over all paths of a route that would be used to pay the given
3632 /// amount to the given `node_id`.
3634 /// See [`ChannelManager::send_preflight_probes`] for more information.
3635 pub fn send_spontaneous_preflight_probes(
3636 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3637 liquidity_limit_multiplier: Option<u64>,
3638 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3639 let payment_params =
3640 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3642 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
3644 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3647 /// Sends payment probes over all paths of a route that would be used to pay a route found
3648 /// according to the given [`RouteParameters`].
3650 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3651 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3652 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3653 /// confirmation in a wallet UI.
3655 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3656 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3657 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3658 /// payment. To mitigate this issue, channels with available liquidity less than the required
3659 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3660 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3661 pub fn send_preflight_probes(
3662 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3663 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3664 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3666 let payer = self.get_our_node_id();
3667 let usable_channels = self.list_usable_channels();
3668 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3669 let inflight_htlcs = self.compute_inflight_htlcs();
3673 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3675 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3676 ProbeSendFailure::RouteNotFound
3679 let mut used_liquidity_map = HashMap::with_capacity(first_hops.len());
3681 let mut res = Vec::new();
3683 for mut path in route.paths {
3684 // If the last hop is probably an unannounced channel we refrain from probing all the
3685 // way through to the end and instead probe up to the second-to-last channel.
3686 while let Some(last_path_hop) = path.hops.last() {
3687 if last_path_hop.maybe_announced_channel {
3688 // We found a potentially announced last hop.
3691 // Drop the last hop, as it's likely unannounced.
3694 "Avoided sending payment probe all the way to last hop {} as it is likely unannounced.",
3695 last_path_hop.short_channel_id
3697 let final_value_msat = path.final_value_msat();
3699 if let Some(new_last) = path.hops.last_mut() {
3700 new_last.fee_msat += final_value_msat;
3705 if path.hops.len() < 2 {
3708 "Skipped sending payment probe over path with less than two hops."
3713 if let Some(first_path_hop) = path.hops.first() {
3714 if let Some(first_hop) = first_hops.iter().find(|h| {
3715 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3717 let path_value = path.final_value_msat() + path.fee_msat();
3718 let used_liquidity =
3719 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3721 if first_hop.next_outbound_htlc_limit_msat
3722 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3724 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3727 *used_liquidity += path_value;
3732 res.push(self.send_probe(path).map_err(|e| {
3733 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3734 ProbeSendFailure::SendingFailed(e)
3741 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3742 /// which checks the correctness of the funding transaction given the associated channel.
3743 fn funding_transaction_generated_intern<FundingOutput: FnMut(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3744 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, is_batch_funding: bool,
3745 mut find_funding_output: FundingOutput,
3746 ) -> Result<(), APIError> {
3747 let per_peer_state = self.per_peer_state.read().unwrap();
3748 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3749 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3751 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3752 let peer_state = &mut *peer_state_lock;
3754 let (mut chan, msg_opt) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3755 Some(ChannelPhase::UnfundedOutboundV1(mut chan)) => {
3756 funding_txo = find_funding_output(&chan, &funding_transaction)?;
3758 let logger = WithChannelContext::from(&self.logger, &chan.context);
3759 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, is_batch_funding, &&logger)
3760 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3761 let channel_id = chan.context.channel_id();
3762 let reason = ClosureReason::ProcessingError { err: msg.clone() };
3763 let shutdown_res = chan.context.force_shutdown(false, reason);
3764 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, None))
3765 } else { unreachable!(); });
3767 Ok(funding_msg) => (chan, funding_msg),
3768 Err((chan, err)) => {
3769 mem::drop(peer_state_lock);
3770 mem::drop(per_peer_state);
3771 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3772 return Err(APIError::ChannelUnavailable {
3773 err: "Signer refused to sign the initial commitment transaction".to_owned()
3779 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3780 return Err(APIError::APIMisuseError {
3782 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3783 temporary_channel_id, counterparty_node_id),
3786 None => return Err(APIError::ChannelUnavailable {err: format!(
3787 "Channel with id {} not found for the passed counterparty node_id {}",
3788 temporary_channel_id, counterparty_node_id),
3792 if let Some(msg) = msg_opt {
3793 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3794 node_id: chan.context.get_counterparty_node_id(),
3798 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3799 hash_map::Entry::Occupied(_) => {
3800 panic!("Generated duplicate funding txid?");
3802 hash_map::Entry::Vacant(e) => {
3803 let mut outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
3804 match outpoint_to_peer.entry(funding_txo) {
3805 hash_map::Entry::Vacant(e) => { e.insert(chan.context.get_counterparty_node_id()); },
3806 hash_map::Entry::Occupied(o) => {
3808 "An existing channel using outpoint {} is open with peer {}",
3809 funding_txo, o.get()
3811 mem::drop(outpoint_to_peer);
3812 mem::drop(peer_state_lock);
3813 mem::drop(per_peer_state);
3814 let reason = ClosureReason::ProcessingError { err: err.clone() };
3815 self.finish_close_channel(chan.context.force_shutdown(true, reason));
3816 return Err(APIError::ChannelUnavailable { err });
3819 e.insert(ChannelPhase::UnfundedOutboundV1(chan));
3826 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3827 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, false, |_, tx| {
3828 Ok(OutPoint { txid: tx.txid(), index: output_index })
3832 /// Call this upon creation of a funding transaction for the given channel.
3834 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3835 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3837 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3838 /// across the p2p network.
3840 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3841 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3843 /// May panic if the output found in the funding transaction is duplicative with some other
3844 /// channel (note that this should be trivially prevented by using unique funding transaction
3845 /// keys per-channel).
3847 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3848 /// counterparty's signature the funding transaction will automatically be broadcast via the
3849 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3851 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3852 /// not currently support replacing a funding transaction on an existing channel. Instead,
3853 /// create a new channel with a conflicting funding transaction.
3855 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3856 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3857 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3858 /// for more details.
3860 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3861 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3862 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3863 self.batch_funding_transaction_generated(&[(temporary_channel_id, counterparty_node_id)], funding_transaction)
3866 /// Call this upon creation of a batch funding transaction for the given channels.
3868 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
3869 /// each individual channel and transaction output.
3871 /// Do NOT broadcast the funding transaction yourself. This batch funding transaction
3872 /// will only be broadcast when we have safely received and persisted the counterparty's
3873 /// signature for each channel.
3875 /// If there is an error, all channels in the batch are to be considered closed.
3876 pub fn batch_funding_transaction_generated(&self, temporary_channels: &[(&ChannelId, &PublicKey)], funding_transaction: Transaction) -> Result<(), APIError> {
3877 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3878 let mut result = Ok(());
3880 if !funding_transaction.is_coin_base() {
3881 for inp in funding_transaction.input.iter() {
3882 if inp.witness.is_empty() {
3883 result = result.and(Err(APIError::APIMisuseError {
3884 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3889 if funding_transaction.output.len() > u16::max_value() as usize {
3890 result = result.and(Err(APIError::APIMisuseError {
3891 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3895 let height = self.best_block.read().unwrap().height();
3896 // Transactions are evaluated as final by network mempools if their locktime is strictly
3897 // lower than the next block height. However, the modules constituting our Lightning
3898 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3899 // module is ahead of LDK, only allow one more block of headroom.
3900 if !funding_transaction.input.iter().all(|input| input.sequence == Sequence::MAX) &&
3901 funding_transaction.lock_time.is_block_height() &&
3902 funding_transaction.lock_time.to_consensus_u32() > height + 1
3904 result = result.and(Err(APIError::APIMisuseError {
3905 err: "Funding transaction absolute timelock is non-final".to_owned()
3910 let txid = funding_transaction.txid();
3911 let is_batch_funding = temporary_channels.len() > 1;
3912 let mut funding_batch_states = if is_batch_funding {
3913 Some(self.funding_batch_states.lock().unwrap())
3917 let mut funding_batch_state = funding_batch_states.as_mut().and_then(|states| {
3918 match states.entry(txid) {
3919 btree_map::Entry::Occupied(_) => {
3920 result = result.clone().and(Err(APIError::APIMisuseError {
3921 err: "Batch funding transaction with the same txid already exists".to_owned()
3925 btree_map::Entry::Vacant(vacant) => Some(vacant.insert(Vec::new())),
3928 for &(temporary_channel_id, counterparty_node_id) in temporary_channels {
3929 result = result.and_then(|_| self.funding_transaction_generated_intern(
3930 temporary_channel_id,
3931 counterparty_node_id,
3932 funding_transaction.clone(),
3935 let mut output_index = None;
3936 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3937 for (idx, outp) in tx.output.iter().enumerate() {
3938 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3939 if output_index.is_some() {
3940 return Err(APIError::APIMisuseError {
3941 err: "Multiple outputs matched the expected script and value".to_owned()
3944 output_index = Some(idx as u16);
3947 if output_index.is_none() {
3948 return Err(APIError::APIMisuseError {
3949 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3952 let outpoint = OutPoint { txid: tx.txid(), index: output_index.unwrap() };
3953 if let Some(funding_batch_state) = funding_batch_state.as_mut() {
3954 funding_batch_state.push((outpoint.to_channel_id(), *counterparty_node_id, false));
3960 if let Err(ref e) = result {
3961 // Remaining channels need to be removed on any error.
3962 let e = format!("Error in transaction funding: {:?}", e);
3963 let mut channels_to_remove = Vec::new();
3964 channels_to_remove.extend(funding_batch_states.as_mut()
3965 .and_then(|states| states.remove(&txid))
3966 .into_iter().flatten()
3967 .map(|(chan_id, node_id, _state)| (chan_id, node_id))
3969 channels_to_remove.extend(temporary_channels.iter()
3970 .map(|(&chan_id, &node_id)| (chan_id, node_id))
3972 let mut shutdown_results = Vec::new();
3974 let per_peer_state = self.per_peer_state.read().unwrap();
3975 for (channel_id, counterparty_node_id) in channels_to_remove {
3976 per_peer_state.get(&counterparty_node_id)
3977 .map(|peer_state_mutex| peer_state_mutex.lock().unwrap())
3978 .and_then(|mut peer_state| peer_state.channel_by_id.remove(&channel_id))
3980 update_maps_on_chan_removal!(self, &chan.context());
3981 let closure_reason = ClosureReason::ProcessingError { err: e.clone() };
3982 shutdown_results.push(chan.context_mut().force_shutdown(false, closure_reason));
3986 for shutdown_result in shutdown_results.drain(..) {
3987 self.finish_close_channel(shutdown_result);
3993 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3995 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3996 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3997 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3998 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4000 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4001 /// `counterparty_node_id` is provided.
4003 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4004 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4006 /// If an error is returned, none of the updates should be considered applied.
4008 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4009 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4010 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4011 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4012 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4013 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4014 /// [`APIMisuseError`]: APIError::APIMisuseError
4015 pub fn update_partial_channel_config(
4016 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
4017 ) -> Result<(), APIError> {
4018 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
4019 return Err(APIError::APIMisuseError {
4020 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
4024 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4025 let per_peer_state = self.per_peer_state.read().unwrap();
4026 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4027 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4028 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4029 let peer_state = &mut *peer_state_lock;
4030 for channel_id in channel_ids {
4031 if !peer_state.has_channel(channel_id) {
4032 return Err(APIError::ChannelUnavailable {
4033 err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, counterparty_node_id),
4037 for channel_id in channel_ids {
4038 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
4039 let mut config = channel_phase.context().config();
4040 config.apply(config_update);
4041 if !channel_phase.context_mut().update_config(&config) {
4044 if let ChannelPhase::Funded(channel) = channel_phase {
4045 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
4046 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
4047 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
4048 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4049 node_id: channel.context.get_counterparty_node_id(),
4056 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
4057 debug_assert!(false);
4058 return Err(APIError::ChannelUnavailable {
4060 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
4061 channel_id, counterparty_node_id),
4068 /// Atomically updates the [`ChannelConfig`] for the given channels.
4070 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4071 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4072 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4073 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4075 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4076 /// `counterparty_node_id` is provided.
4078 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4079 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4081 /// If an error is returned, none of the updates should be considered applied.
4083 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4084 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4085 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4086 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4087 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4088 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4089 /// [`APIMisuseError`]: APIError::APIMisuseError
4090 pub fn update_channel_config(
4091 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
4092 ) -> Result<(), APIError> {
4093 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
4096 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
4097 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
4099 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
4100 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
4102 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
4103 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
4104 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
4105 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
4106 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
4108 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
4109 /// you from forwarding more than you received. See
4110 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
4113 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4116 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
4117 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4118 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
4119 // TODO: when we move to deciding the best outbound channel at forward time, only take
4120 // `next_node_id` and not `next_hop_channel_id`
4121 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> {
4122 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4124 let next_hop_scid = {
4125 let peer_state_lock = self.per_peer_state.read().unwrap();
4126 let peer_state_mutex = peer_state_lock.get(&next_node_id)
4127 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
4128 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4129 let peer_state = &mut *peer_state_lock;
4130 match peer_state.channel_by_id.get(next_hop_channel_id) {
4131 Some(ChannelPhase::Funded(chan)) => {
4132 if !chan.context.is_usable() {
4133 return Err(APIError::ChannelUnavailable {
4134 err: format!("Channel with id {} not fully established", next_hop_channel_id)
4137 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
4139 Some(_) => return Err(APIError::ChannelUnavailable {
4140 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
4141 next_hop_channel_id, next_node_id)
4144 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
4145 next_hop_channel_id, next_node_id);
4146 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
4147 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
4148 return Err(APIError::ChannelUnavailable {
4155 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4156 .ok_or_else(|| APIError::APIMisuseError {
4157 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4160 let routing = match payment.forward_info.routing {
4161 PendingHTLCRouting::Forward { onion_packet, blinded, .. } => {
4162 PendingHTLCRouting::Forward {
4163 onion_packet, blinded, short_channel_id: next_hop_scid
4166 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
4168 let skimmed_fee_msat =
4169 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
4170 let pending_htlc_info = PendingHTLCInfo {
4171 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
4172 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
4175 let mut per_source_pending_forward = [(
4176 payment.prev_short_channel_id,
4177 payment.prev_funding_outpoint,
4178 payment.prev_user_channel_id,
4179 vec![(pending_htlc_info, payment.prev_htlc_id)]
4181 self.forward_htlcs(&mut per_source_pending_forward);
4185 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
4186 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
4188 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4191 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4192 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
4193 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4195 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4196 .ok_or_else(|| APIError::APIMisuseError {
4197 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4200 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
4201 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4202 short_channel_id: payment.prev_short_channel_id,
4203 user_channel_id: Some(payment.prev_user_channel_id),
4204 outpoint: payment.prev_funding_outpoint,
4205 htlc_id: payment.prev_htlc_id,
4206 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
4207 phantom_shared_secret: None,
4208 blinded_failure: payment.forward_info.routing.blinded_failure(),
4211 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
4212 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
4213 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
4214 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
4219 /// Processes HTLCs which are pending waiting on random forward delay.
4221 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
4222 /// Will likely generate further events.
4223 pub fn process_pending_htlc_forwards(&self) {
4224 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4226 let mut new_events = VecDeque::new();
4227 let mut failed_forwards = Vec::new();
4228 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
4230 let mut forward_htlcs = HashMap::new();
4231 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
4233 for (short_chan_id, mut pending_forwards) in forward_htlcs {
4234 if short_chan_id != 0 {
4235 let mut forwarding_counterparty = None;
4236 macro_rules! forwarding_channel_not_found {
4238 for forward_info in pending_forwards.drain(..) {
4239 match forward_info {
4240 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4241 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4242 forward_info: PendingHTLCInfo {
4243 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
4244 outgoing_cltv_value, ..
4247 macro_rules! failure_handler {
4248 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
4249 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_funding_outpoint.to_channel_id()));
4250 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
4252 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4253 short_channel_id: prev_short_channel_id,
4254 user_channel_id: Some(prev_user_channel_id),
4255 outpoint: prev_funding_outpoint,
4256 htlc_id: prev_htlc_id,
4257 incoming_packet_shared_secret: incoming_shared_secret,
4258 phantom_shared_secret: $phantom_ss,
4259 blinded_failure: routing.blinded_failure(),
4262 let reason = if $next_hop_unknown {
4263 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
4265 HTLCDestination::FailedPayment{ payment_hash }
4268 failed_forwards.push((htlc_source, payment_hash,
4269 HTLCFailReason::reason($err_code, $err_data),
4275 macro_rules! fail_forward {
4276 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4278 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4282 macro_rules! failed_payment {
4283 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4285 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4289 if let PendingHTLCRouting::Forward { ref onion_packet, .. } = routing {
4290 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4291 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.chain_hash) {
4292 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4293 let next_hop = match onion_utils::decode_next_payment_hop(
4294 phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac,
4295 payment_hash, None, &self.node_signer
4298 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4299 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).to_byte_array();
4300 // In this scenario, the phantom would have sent us an
4301 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4302 // if it came from us (the second-to-last hop) but contains the sha256
4304 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4306 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4307 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4311 onion_utils::Hop::Receive(hop_data) => {
4312 let current_height: u32 = self.best_block.read().unwrap().height();
4313 match create_recv_pending_htlc_info(hop_data,
4314 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4315 outgoing_cltv_value, Some(phantom_shared_secret), false, None,
4316 current_height, self.default_configuration.accept_mpp_keysend)
4318 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4319 Err(InboundHTLCErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4325 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4328 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4331 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4332 // Channel went away before we could fail it. This implies
4333 // the channel is now on chain and our counterparty is
4334 // trying to broadcast the HTLC-Timeout, but that's their
4335 // problem, not ours.
4341 let chan_info_opt = self.short_to_chan_info.read().unwrap().get(&short_chan_id).cloned();
4342 let (counterparty_node_id, forward_chan_id) = match chan_info_opt {
4343 Some((cp_id, chan_id)) => (cp_id, chan_id),
4345 forwarding_channel_not_found!();
4349 forwarding_counterparty = Some(counterparty_node_id);
4350 let per_peer_state = self.per_peer_state.read().unwrap();
4351 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4352 if peer_state_mutex_opt.is_none() {
4353 forwarding_channel_not_found!();
4356 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4357 let peer_state = &mut *peer_state_lock;
4358 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4359 let logger = WithChannelContext::from(&self.logger, &chan.context);
4360 for forward_info in pending_forwards.drain(..) {
4361 let queue_fail_htlc_res = match forward_info {
4362 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4363 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4364 forward_info: PendingHTLCInfo {
4365 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4366 routing: PendingHTLCRouting::Forward {
4367 onion_packet, blinded, ..
4368 }, skimmed_fee_msat, ..
4371 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);
4372 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4373 short_channel_id: prev_short_channel_id,
4374 user_channel_id: Some(prev_user_channel_id),
4375 outpoint: prev_funding_outpoint,
4376 htlc_id: prev_htlc_id,
4377 incoming_packet_shared_secret: incoming_shared_secret,
4378 // Phantom payments are only PendingHTLCRouting::Receive.
4379 phantom_shared_secret: None,
4380 blinded_failure: blinded.map(|b| b.failure),
4382 let next_blinding_point = blinded.and_then(|b| {
4383 let encrypted_tlvs_ss = self.node_signer.ecdh(
4384 Recipient::Node, &b.inbound_blinding_point, None
4385 ).unwrap().secret_bytes();
4386 onion_utils::next_hop_pubkey(
4387 &self.secp_ctx, b.inbound_blinding_point, &encrypted_tlvs_ss
4390 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4391 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4392 onion_packet, skimmed_fee_msat, next_blinding_point, &self.fee_estimator,
4395 if let ChannelError::Ignore(msg) = e {
4396 log_trace!(logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4398 panic!("Stated return value requirements in send_htlc() were not met");
4400 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4401 failed_forwards.push((htlc_source, payment_hash,
4402 HTLCFailReason::reason(failure_code, data),
4403 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4409 HTLCForwardInfo::AddHTLC { .. } => {
4410 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4412 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4413 log_trace!(logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4414 Some((chan.queue_fail_htlc(htlc_id, err_packet, &&logger), htlc_id))
4416 HTLCForwardInfo::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
4417 log_trace!(logger, "Failing malformed HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4418 let res = chan.queue_fail_malformed_htlc(
4419 htlc_id, failure_code, sha256_of_onion, &&logger
4421 Some((res, htlc_id))
4424 if let Some((queue_fail_htlc_res, htlc_id)) = queue_fail_htlc_res {
4425 if let Err(e) = queue_fail_htlc_res {
4426 if let ChannelError::Ignore(msg) = e {
4427 log_trace!(logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4429 panic!("Stated return value requirements in queue_fail_{{malformed_}}htlc() were not met");
4431 // fail-backs are best-effort, we probably already have one
4432 // pending, and if not that's OK, if not, the channel is on
4433 // the chain and sending the HTLC-Timeout is their problem.
4439 forwarding_channel_not_found!();
4443 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4444 match forward_info {
4445 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4446 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4447 forward_info: PendingHTLCInfo {
4448 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4449 skimmed_fee_msat, ..
4452 let blinded_failure = routing.blinded_failure();
4453 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4454 PendingHTLCRouting::Receive {
4455 payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret,
4456 custom_tlvs, requires_blinded_error: _
4458 let _legacy_hop_data = Some(payment_data.clone());
4459 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4460 payment_metadata, custom_tlvs };
4461 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4462 Some(payment_data), phantom_shared_secret, onion_fields)
4464 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4465 let onion_fields = RecipientOnionFields {
4466 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4470 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4471 payment_data, None, onion_fields)
4474 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4477 let claimable_htlc = ClaimableHTLC {
4478 prev_hop: HTLCPreviousHopData {
4479 short_channel_id: prev_short_channel_id,
4480 user_channel_id: Some(prev_user_channel_id),
4481 outpoint: prev_funding_outpoint,
4482 htlc_id: prev_htlc_id,
4483 incoming_packet_shared_secret: incoming_shared_secret,
4484 phantom_shared_secret,
4487 // We differentiate the received value from the sender intended value
4488 // if possible so that we don't prematurely mark MPP payments complete
4489 // if routing nodes overpay
4490 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4491 sender_intended_value: outgoing_amt_msat,
4493 total_value_received: None,
4494 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4497 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4500 let mut committed_to_claimable = false;
4502 macro_rules! fail_htlc {
4503 ($htlc: expr, $payment_hash: expr) => {
4504 debug_assert!(!committed_to_claimable);
4505 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4506 htlc_msat_height_data.extend_from_slice(
4507 &self.best_block.read().unwrap().height().to_be_bytes(),
4509 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4510 short_channel_id: $htlc.prev_hop.short_channel_id,
4511 user_channel_id: $htlc.prev_hop.user_channel_id,
4512 outpoint: prev_funding_outpoint,
4513 htlc_id: $htlc.prev_hop.htlc_id,
4514 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4515 phantom_shared_secret,
4518 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4519 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4521 continue 'next_forwardable_htlc;
4524 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4525 let mut receiver_node_id = self.our_network_pubkey;
4526 if phantom_shared_secret.is_some() {
4527 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4528 .expect("Failed to get node_id for phantom node recipient");
4531 macro_rules! check_total_value {
4532 ($purpose: expr) => {{
4533 let mut payment_claimable_generated = false;
4534 let is_keysend = match $purpose {
4535 events::PaymentPurpose::SpontaneousPayment(_) => true,
4536 events::PaymentPurpose::InvoicePayment { .. } => false,
4538 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4539 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4540 fail_htlc!(claimable_htlc, payment_hash);
4542 let ref mut claimable_payment = claimable_payments.claimable_payments
4543 .entry(payment_hash)
4544 // Note that if we insert here we MUST NOT fail_htlc!()
4545 .or_insert_with(|| {
4546 committed_to_claimable = true;
4548 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4551 if $purpose != claimable_payment.purpose {
4552 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4553 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));
4554 fail_htlc!(claimable_htlc, payment_hash);
4556 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4557 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);
4558 fail_htlc!(claimable_htlc, payment_hash);
4560 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4561 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4562 fail_htlc!(claimable_htlc, payment_hash);
4565 claimable_payment.onion_fields = Some(onion_fields);
4567 let ref mut htlcs = &mut claimable_payment.htlcs;
4568 let mut total_value = claimable_htlc.sender_intended_value;
4569 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4570 for htlc in htlcs.iter() {
4571 total_value += htlc.sender_intended_value;
4572 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4573 if htlc.total_msat != claimable_htlc.total_msat {
4574 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4575 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4576 total_value = msgs::MAX_VALUE_MSAT;
4578 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4580 // The condition determining whether an MPP is complete must
4581 // match exactly the condition used in `timer_tick_occurred`
4582 if total_value >= msgs::MAX_VALUE_MSAT {
4583 fail_htlc!(claimable_htlc, payment_hash);
4584 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4585 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4587 fail_htlc!(claimable_htlc, payment_hash);
4588 } else if total_value >= claimable_htlc.total_msat {
4589 #[allow(unused_assignments)] {
4590 committed_to_claimable = true;
4592 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4593 htlcs.push(claimable_htlc);
4594 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4595 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4596 let counterparty_skimmed_fee_msat = htlcs.iter()
4597 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4598 debug_assert!(total_value.saturating_sub(amount_msat) <=
4599 counterparty_skimmed_fee_msat);
4600 new_events.push_back((events::Event::PaymentClaimable {
4601 receiver_node_id: Some(receiver_node_id),
4605 counterparty_skimmed_fee_msat,
4606 via_channel_id: Some(prev_channel_id),
4607 via_user_channel_id: Some(prev_user_channel_id),
4608 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4609 onion_fields: claimable_payment.onion_fields.clone(),
4611 payment_claimable_generated = true;
4613 // Nothing to do - we haven't reached the total
4614 // payment value yet, wait until we receive more
4616 htlcs.push(claimable_htlc);
4617 #[allow(unused_assignments)] {
4618 committed_to_claimable = true;
4621 payment_claimable_generated
4625 // Check that the payment hash and secret are known. Note that we
4626 // MUST take care to handle the "unknown payment hash" and
4627 // "incorrect payment secret" cases here identically or we'd expose
4628 // that we are the ultimate recipient of the given payment hash.
4629 // Further, we must not expose whether we have any other HTLCs
4630 // associated with the same payment_hash pending or not.
4631 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4632 match payment_secrets.entry(payment_hash) {
4633 hash_map::Entry::Vacant(_) => {
4634 match claimable_htlc.onion_payload {
4635 OnionPayload::Invoice { .. } => {
4636 let payment_data = payment_data.unwrap();
4637 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) {
4638 Ok(result) => result,
4640 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4641 fail_htlc!(claimable_htlc, payment_hash);
4644 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4645 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4646 if (cltv_expiry as u64) < expected_min_expiry_height {
4647 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4648 &payment_hash, cltv_expiry, expected_min_expiry_height);
4649 fail_htlc!(claimable_htlc, payment_hash);
4652 let purpose = events::PaymentPurpose::InvoicePayment {
4653 payment_preimage: payment_preimage.clone(),
4654 payment_secret: payment_data.payment_secret,
4656 check_total_value!(purpose);
4658 OnionPayload::Spontaneous(preimage) => {
4659 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4660 check_total_value!(purpose);
4664 hash_map::Entry::Occupied(inbound_payment) => {
4665 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4666 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);
4667 fail_htlc!(claimable_htlc, payment_hash);
4669 let payment_data = payment_data.unwrap();
4670 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4671 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4672 fail_htlc!(claimable_htlc, payment_hash);
4673 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4674 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4675 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4676 fail_htlc!(claimable_htlc, payment_hash);
4678 let purpose = events::PaymentPurpose::InvoicePayment {
4679 payment_preimage: inbound_payment.get().payment_preimage,
4680 payment_secret: payment_data.payment_secret,
4682 let payment_claimable_generated = check_total_value!(purpose);
4683 if payment_claimable_generated {
4684 inbound_payment.remove_entry();
4690 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4691 panic!("Got pending fail of our own HTLC");
4699 let best_block_height = self.best_block.read().unwrap().height();
4700 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4701 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4702 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4704 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4705 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4707 self.forward_htlcs(&mut phantom_receives);
4709 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4710 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4711 // nice to do the work now if we can rather than while we're trying to get messages in the
4713 self.check_free_holding_cells();
4715 if new_events.is_empty() { return }
4716 let mut events = self.pending_events.lock().unwrap();
4717 events.append(&mut new_events);
4720 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4722 /// Expects the caller to have a total_consistency_lock read lock.
4723 fn process_background_events(&self) -> NotifyOption {
4724 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4726 self.background_events_processed_since_startup.store(true, Ordering::Release);
4728 let mut background_events = Vec::new();
4729 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4730 if background_events.is_empty() {
4731 return NotifyOption::SkipPersistNoEvents;
4734 for event in background_events.drain(..) {
4736 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4737 // The channel has already been closed, so no use bothering to care about the
4738 // monitor updating completing.
4739 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4741 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4742 let mut updated_chan = false;
4744 let per_peer_state = self.per_peer_state.read().unwrap();
4745 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4746 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4747 let peer_state = &mut *peer_state_lock;
4748 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4749 hash_map::Entry::Occupied(mut chan_phase) => {
4750 if let ChannelPhase::Funded(chan) = chan_phase.get_mut() {
4751 updated_chan = true;
4752 handle_new_monitor_update!(self, funding_txo, update.clone(),
4753 peer_state_lock, peer_state, per_peer_state, chan);
4755 debug_assert!(false, "We shouldn't have an update for a non-funded channel");
4758 hash_map::Entry::Vacant(_) => {},
4763 // TODO: Track this as in-flight even though the channel is closed.
4764 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4767 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4768 let per_peer_state = self.per_peer_state.read().unwrap();
4769 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4770 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4771 let peer_state = &mut *peer_state_lock;
4772 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4773 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4775 let update_actions = peer_state.monitor_update_blocked_actions
4776 .remove(&channel_id).unwrap_or(Vec::new());
4777 mem::drop(peer_state_lock);
4778 mem::drop(per_peer_state);
4779 self.handle_monitor_update_completion_actions(update_actions);
4785 NotifyOption::DoPersist
4788 #[cfg(any(test, feature = "_test_utils"))]
4789 /// Process background events, for functional testing
4790 pub fn test_process_background_events(&self) {
4791 let _lck = self.total_consistency_lock.read().unwrap();
4792 let _ = self.process_background_events();
4795 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4796 if !chan.context.is_outbound() { return NotifyOption::SkipPersistNoEvents; }
4798 let logger = WithChannelContext::from(&self.logger, &chan.context);
4800 // If the feerate has decreased by less than half, don't bother
4801 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4802 if new_feerate != chan.context.get_feerate_sat_per_1000_weight() {
4803 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4804 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4806 return NotifyOption::SkipPersistNoEvents;
4808 if !chan.context.is_live() {
4809 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {} as it cannot currently be updated (probably the peer is disconnected).",
4810 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4811 return NotifyOption::SkipPersistNoEvents;
4813 log_trace!(logger, "Channel {} qualifies for a feerate change from {} to {}.",
4814 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4816 chan.queue_update_fee(new_feerate, &self.fee_estimator, &&logger);
4817 NotifyOption::DoPersist
4821 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4822 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4823 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4824 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4825 pub fn maybe_update_chan_fees(&self) {
4826 PersistenceNotifierGuard::optionally_notify(self, || {
4827 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4829 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4830 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4832 let per_peer_state = self.per_peer_state.read().unwrap();
4833 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4834 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4835 let peer_state = &mut *peer_state_lock;
4836 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4837 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4839 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4844 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4845 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4853 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4855 /// This currently includes:
4856 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4857 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4858 /// than a minute, informing the network that they should no longer attempt to route over
4860 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4861 /// with the current [`ChannelConfig`].
4862 /// * Removing peers which have disconnected but and no longer have any channels.
4863 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4864 /// * Forgetting about stale outbound payments, either those that have already been fulfilled
4865 /// or those awaiting an invoice that hasn't been delivered in the necessary amount of time.
4866 /// The latter is determined using the system clock in `std` and the highest seen block time
4867 /// minus two hours in `no-std`.
4869 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4870 /// estimate fetches.
4872 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4873 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4874 pub fn timer_tick_occurred(&self) {
4875 PersistenceNotifierGuard::optionally_notify(self, || {
4876 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4878 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4879 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4881 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4882 let mut timed_out_mpp_htlcs = Vec::new();
4883 let mut pending_peers_awaiting_removal = Vec::new();
4884 let mut shutdown_channels = Vec::new();
4886 let mut process_unfunded_channel_tick = |
4887 chan_id: &ChannelId,
4888 context: &mut ChannelContext<SP>,
4889 unfunded_context: &mut UnfundedChannelContext,
4890 pending_msg_events: &mut Vec<MessageSendEvent>,
4891 counterparty_node_id: PublicKey,
4893 context.maybe_expire_prev_config();
4894 if unfunded_context.should_expire_unfunded_channel() {
4895 let logger = WithChannelContext::from(&self.logger, context);
4897 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4898 update_maps_on_chan_removal!(self, &context);
4899 shutdown_channels.push(context.force_shutdown(false, ClosureReason::HolderForceClosed));
4900 pending_msg_events.push(MessageSendEvent::HandleError {
4901 node_id: counterparty_node_id,
4902 action: msgs::ErrorAction::SendErrorMessage {
4903 msg: msgs::ErrorMessage {
4904 channel_id: *chan_id,
4905 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4916 let per_peer_state = self.per_peer_state.read().unwrap();
4917 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4918 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4919 let peer_state = &mut *peer_state_lock;
4920 let pending_msg_events = &mut peer_state.pending_msg_events;
4921 let counterparty_node_id = *counterparty_node_id;
4922 peer_state.channel_by_id.retain(|chan_id, phase| {
4924 ChannelPhase::Funded(chan) => {
4925 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4930 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4931 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4933 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4934 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4935 handle_errors.push((Err(err), counterparty_node_id));
4936 if needs_close { return false; }
4939 match chan.channel_update_status() {
4940 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4941 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4942 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4943 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4944 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4945 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4946 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4948 if n >= DISABLE_GOSSIP_TICKS {
4949 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4950 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4951 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4955 should_persist = NotifyOption::DoPersist;
4957 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4960 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4962 if n >= ENABLE_GOSSIP_TICKS {
4963 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4964 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4965 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4969 should_persist = NotifyOption::DoPersist;
4971 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4977 chan.context.maybe_expire_prev_config();
4979 if chan.should_disconnect_peer_awaiting_response() {
4980 let logger = WithChannelContext::from(&self.logger, &chan.context);
4981 log_debug!(logger, "Disconnecting peer {} due to not making any progress on channel {}",
4982 counterparty_node_id, chan_id);
4983 pending_msg_events.push(MessageSendEvent::HandleError {
4984 node_id: counterparty_node_id,
4985 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4986 msg: msgs::WarningMessage {
4987 channel_id: *chan_id,
4988 data: "Disconnecting due to timeout awaiting response".to_owned(),
4996 ChannelPhase::UnfundedInboundV1(chan) => {
4997 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4998 pending_msg_events, counterparty_node_id)
5000 ChannelPhase::UnfundedOutboundV1(chan) => {
5001 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
5002 pending_msg_events, counterparty_node_id)
5007 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
5008 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
5009 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(*chan_id));
5010 log_error!(logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
5011 peer_state.pending_msg_events.push(
5012 events::MessageSendEvent::HandleError {
5013 node_id: counterparty_node_id,
5014 action: msgs::ErrorAction::SendErrorMessage {
5015 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
5021 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
5023 if peer_state.ok_to_remove(true) {
5024 pending_peers_awaiting_removal.push(counterparty_node_id);
5029 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
5030 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
5031 // of to that peer is later closed while still being disconnected (i.e. force closed),
5032 // we therefore need to remove the peer from `peer_state` separately.
5033 // To avoid having to take the `per_peer_state` `write` lock once the channels are
5034 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
5035 // negative effects on parallelism as much as possible.
5036 if pending_peers_awaiting_removal.len() > 0 {
5037 let mut per_peer_state = self.per_peer_state.write().unwrap();
5038 for counterparty_node_id in pending_peers_awaiting_removal {
5039 match per_peer_state.entry(counterparty_node_id) {
5040 hash_map::Entry::Occupied(entry) => {
5041 // Remove the entry if the peer is still disconnected and we still
5042 // have no channels to the peer.
5043 let remove_entry = {
5044 let peer_state = entry.get().lock().unwrap();
5045 peer_state.ok_to_remove(true)
5048 entry.remove_entry();
5051 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
5056 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
5057 if payment.htlcs.is_empty() {
5058 // This should be unreachable
5059 debug_assert!(false);
5062 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
5063 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
5064 // In this case we're not going to handle any timeouts of the parts here.
5065 // This condition determining whether the MPP is complete here must match
5066 // exactly the condition used in `process_pending_htlc_forwards`.
5067 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
5068 .fold(0, |total, htlc| total + htlc.sender_intended_value)
5071 } else if payment.htlcs.iter_mut().any(|htlc| {
5072 htlc.timer_ticks += 1;
5073 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
5075 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
5076 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
5083 for htlc_source in timed_out_mpp_htlcs.drain(..) {
5084 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
5085 let reason = HTLCFailReason::from_failure_code(23);
5086 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
5087 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
5090 for (err, counterparty_node_id) in handle_errors.drain(..) {
5091 let _ = handle_error!(self, err, counterparty_node_id);
5094 for shutdown_res in shutdown_channels {
5095 self.finish_close_channel(shutdown_res);
5098 #[cfg(feature = "std")]
5099 let duration_since_epoch = std::time::SystemTime::now()
5100 .duration_since(std::time::SystemTime::UNIX_EPOCH)
5101 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
5102 #[cfg(not(feature = "std"))]
5103 let duration_since_epoch = Duration::from_secs(
5104 self.highest_seen_timestamp.load(Ordering::Acquire).saturating_sub(7200) as u64
5107 self.pending_outbound_payments.remove_stale_payments(
5108 duration_since_epoch, &self.pending_events
5111 // Technically we don't need to do this here, but if we have holding cell entries in a
5112 // channel that need freeing, it's better to do that here and block a background task
5113 // than block the message queueing pipeline.
5114 if self.check_free_holding_cells() {
5115 should_persist = NotifyOption::DoPersist;
5122 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
5123 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
5124 /// along the path (including in our own channel on which we received it).
5126 /// Note that in some cases around unclean shutdown, it is possible the payment may have
5127 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
5128 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
5129 /// may have already been failed automatically by LDK if it was nearing its expiration time.
5131 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
5132 /// [`ChannelManager::claim_funds`]), you should still monitor for
5133 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
5134 /// startup during which time claims that were in-progress at shutdown may be replayed.
5135 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
5136 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
5139 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
5140 /// reason for the failure.
5142 /// See [`FailureCode`] for valid failure codes.
5143 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
5144 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5146 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
5147 if let Some(payment) = removed_source {
5148 for htlc in payment.htlcs {
5149 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
5150 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5151 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
5152 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5157 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
5158 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
5159 match failure_code {
5160 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
5161 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
5162 FailureCode::IncorrectOrUnknownPaymentDetails => {
5163 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5164 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5165 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
5167 FailureCode::InvalidOnionPayload(data) => {
5168 let fail_data = match data {
5169 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
5172 HTLCFailReason::reason(failure_code.into(), fail_data)
5177 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5178 /// that we want to return and a channel.
5180 /// This is for failures on the channel on which the HTLC was *received*, not failures
5182 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5183 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
5184 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
5185 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
5186 // an inbound SCID alias before the real SCID.
5187 let scid_pref = if chan.context.should_announce() {
5188 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
5190 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
5192 if let Some(scid) = scid_pref {
5193 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
5195 (0x4000|10, Vec::new())
5200 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5201 /// that we want to return and a channel.
5202 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5203 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
5204 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
5205 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
5206 if desired_err_code == 0x1000 | 20 {
5207 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
5208 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
5209 0u16.write(&mut enc).expect("Writes cannot fail");
5211 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
5212 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
5213 upd.write(&mut enc).expect("Writes cannot fail");
5214 (desired_err_code, enc.0)
5216 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
5217 // which means we really shouldn't have gotten a payment to be forwarded over this
5218 // channel yet, or if we did it's from a route hint. Either way, returning an error of
5219 // PERM|no_such_channel should be fine.
5220 (0x4000|10, Vec::new())
5224 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
5225 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
5226 // be surfaced to the user.
5227 fn fail_holding_cell_htlcs(
5228 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
5229 counterparty_node_id: &PublicKey
5231 let (failure_code, onion_failure_data) = {
5232 let per_peer_state = self.per_peer_state.read().unwrap();
5233 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5234 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5235 let peer_state = &mut *peer_state_lock;
5236 match peer_state.channel_by_id.entry(channel_id) {
5237 hash_map::Entry::Occupied(chan_phase_entry) => {
5238 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
5239 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
5241 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
5242 debug_assert!(false);
5243 (0x4000|10, Vec::new())
5246 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
5248 } else { (0x4000|10, Vec::new()) }
5251 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
5252 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
5253 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
5254 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
5258 /// Fails an HTLC backwards to the sender of it to us.
5259 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
5260 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
5261 // Ensure that no peer state channel storage lock is held when calling this function.
5262 // This ensures that future code doesn't introduce a lock-order requirement for
5263 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
5264 // this function with any `per_peer_state` peer lock acquired would.
5265 #[cfg(debug_assertions)]
5266 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
5267 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
5270 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
5271 //identify whether we sent it or not based on the (I presume) very different runtime
5272 //between the branches here. We should make this async and move it into the forward HTLCs
5275 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5276 // from block_connected which may run during initialization prior to the chain_monitor
5277 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
5279 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
5280 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
5281 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
5282 &self.pending_events, &self.logger)
5283 { self.push_pending_forwards_ev(); }
5285 HTLCSource::PreviousHopData(HTLCPreviousHopData {
5286 ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret,
5287 ref phantom_shared_secret, ref outpoint, ref blinded_failure, ..
5290 WithContext::from(&self.logger, None, Some(outpoint.to_channel_id())),
5291 "Failing {}HTLC with payment_hash {} backwards from us: {:?}",
5292 if blinded_failure.is_some() { "blinded " } else { "" }, &payment_hash, onion_error
5294 let failure = match blinded_failure {
5295 Some(BlindedFailure::FromIntroductionNode) => {
5296 let blinded_onion_error = HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32]);
5297 let err_packet = blinded_onion_error.get_encrypted_failure_packet(
5298 incoming_packet_shared_secret, phantom_shared_secret
5300 HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }
5302 Some(BlindedFailure::FromBlindedNode) => {
5303 HTLCForwardInfo::FailMalformedHTLC {
5305 failure_code: INVALID_ONION_BLINDING,
5306 sha256_of_onion: [0; 32]
5310 let err_packet = onion_error.get_encrypted_failure_packet(
5311 incoming_packet_shared_secret, phantom_shared_secret
5313 HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }
5317 let mut push_forward_ev = false;
5318 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5319 if forward_htlcs.is_empty() {
5320 push_forward_ev = true;
5322 match forward_htlcs.entry(*short_channel_id) {
5323 hash_map::Entry::Occupied(mut entry) => {
5324 entry.get_mut().push(failure);
5326 hash_map::Entry::Vacant(entry) => {
5327 entry.insert(vec!(failure));
5330 mem::drop(forward_htlcs);
5331 if push_forward_ev { self.push_pending_forwards_ev(); }
5332 let mut pending_events = self.pending_events.lock().unwrap();
5333 pending_events.push_back((events::Event::HTLCHandlingFailed {
5334 prev_channel_id: outpoint.to_channel_id(),
5335 failed_next_destination: destination,
5341 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
5342 /// [`MessageSendEvent`]s needed to claim the payment.
5344 /// This method is guaranteed to ensure the payment has been claimed but only if the current
5345 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
5346 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
5347 /// successful. It will generally be available in the next [`process_pending_events`] call.
5349 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
5350 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
5351 /// event matches your expectation. If you fail to do so and call this method, you may provide
5352 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5354 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5355 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5356 /// [`claim_funds_with_known_custom_tlvs`].
5358 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5359 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5360 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5361 /// [`process_pending_events`]: EventsProvider::process_pending_events
5362 /// [`create_inbound_payment`]: Self::create_inbound_payment
5363 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5364 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5365 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5366 self.claim_payment_internal(payment_preimage, false);
5369 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5370 /// even type numbers.
5374 /// You MUST check you've understood all even TLVs before using this to
5375 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5377 /// [`claim_funds`]: Self::claim_funds
5378 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5379 self.claim_payment_internal(payment_preimage, true);
5382 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5383 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).to_byte_array());
5385 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5388 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5389 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5390 let mut receiver_node_id = self.our_network_pubkey;
5391 for htlc in payment.htlcs.iter() {
5392 if htlc.prev_hop.phantom_shared_secret.is_some() {
5393 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5394 .expect("Failed to get node_id for phantom node recipient");
5395 receiver_node_id = phantom_pubkey;
5400 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5401 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5402 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5403 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5404 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5406 if dup_purpose.is_some() {
5407 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5408 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5412 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5413 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5414 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5415 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5416 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5417 mem::drop(claimable_payments);
5418 for htlc in payment.htlcs {
5419 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5420 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5421 let receiver = HTLCDestination::FailedPayment { payment_hash };
5422 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5431 debug_assert!(!sources.is_empty());
5433 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5434 // and when we got here we need to check that the amount we're about to claim matches the
5435 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5436 // the MPP parts all have the same `total_msat`.
5437 let mut claimable_amt_msat = 0;
5438 let mut prev_total_msat = None;
5439 let mut expected_amt_msat = None;
5440 let mut valid_mpp = true;
5441 let mut errs = Vec::new();
5442 let per_peer_state = self.per_peer_state.read().unwrap();
5443 for htlc in sources.iter() {
5444 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5445 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5446 debug_assert!(false);
5450 prev_total_msat = Some(htlc.total_msat);
5452 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5453 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5454 debug_assert!(false);
5458 expected_amt_msat = htlc.total_value_received;
5459 claimable_amt_msat += htlc.value;
5461 mem::drop(per_peer_state);
5462 if sources.is_empty() || expected_amt_msat.is_none() {
5463 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5464 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5467 if claimable_amt_msat != expected_amt_msat.unwrap() {
5468 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5469 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5470 expected_amt_msat.unwrap(), claimable_amt_msat);
5474 for htlc in sources.drain(..) {
5475 let prev_hop_chan_id = htlc.prev_hop.outpoint.to_channel_id();
5476 if let Err((pk, err)) = self.claim_funds_from_hop(
5477 htlc.prev_hop, payment_preimage,
5478 |_, definitely_duplicate| {
5479 debug_assert!(!definitely_duplicate, "We shouldn't claim duplicatively from a payment");
5480 Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash })
5483 if let msgs::ErrorAction::IgnoreError = err.err.action {
5484 // We got a temporary failure updating monitor, but will claim the
5485 // HTLC when the monitor updating is restored (or on chain).
5486 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
5487 log_error!(logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5488 } else { errs.push((pk, err)); }
5493 for htlc in sources.drain(..) {
5494 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5495 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5496 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5497 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5498 let receiver = HTLCDestination::FailedPayment { payment_hash };
5499 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5501 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5504 // Now we can handle any errors which were generated.
5505 for (counterparty_node_id, err) in errs.drain(..) {
5506 let res: Result<(), _> = Err(err);
5507 let _ = handle_error!(self, res, counterparty_node_id);
5511 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>, bool) -> Option<MonitorUpdateCompletionAction>>(&self,
5512 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5513 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5514 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5516 // If we haven't yet run background events assume we're still deserializing and shouldn't
5517 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5518 // `BackgroundEvent`s.
5519 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5521 // As we may call handle_monitor_update_completion_actions in rather rare cases, check that
5522 // the required mutexes are not held before we start.
5523 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5524 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5527 let per_peer_state = self.per_peer_state.read().unwrap();
5528 let chan_id = prev_hop.outpoint.to_channel_id();
5529 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5530 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5534 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5535 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5536 .map(|peer_mutex| peer_mutex.lock().unwrap())
5539 if peer_state_opt.is_some() {
5540 let mut peer_state_lock = peer_state_opt.unwrap();
5541 let peer_state = &mut *peer_state_lock;
5542 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5543 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5544 let counterparty_node_id = chan.context.get_counterparty_node_id();
5545 let logger = WithChannelContext::from(&self.logger, &chan.context);
5546 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &&logger);
5549 UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } => {
5550 if let Some(action) = completion_action(Some(htlc_value_msat), false) {
5551 log_trace!(logger, "Tracking monitor update completion action for channel {}: {:?}",
5553 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5556 handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5557 peer_state, per_peer_state, chan);
5559 // If we're running during init we cannot update a monitor directly -
5560 // they probably haven't actually been loaded yet. Instead, push the
5561 // monitor update as a background event.
5562 self.pending_background_events.lock().unwrap().push(
5563 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5564 counterparty_node_id,
5565 funding_txo: prev_hop.outpoint,
5566 update: monitor_update.clone(),
5570 UpdateFulfillCommitFetch::DuplicateClaim {} => {
5571 let action = if let Some(action) = completion_action(None, true) {
5576 mem::drop(peer_state_lock);
5578 log_trace!(logger, "Completing monitor update completion action for channel {} as claim was redundant: {:?}",
5580 let (node_id, funding_outpoint, blocker) =
5581 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5582 downstream_counterparty_node_id: node_id,
5583 downstream_funding_outpoint: funding_outpoint,
5584 blocking_action: blocker,
5586 (node_id, funding_outpoint, blocker)
5588 debug_assert!(false,
5589 "Duplicate claims should always free another channel immediately");
5592 if let Some(peer_state_mtx) = per_peer_state.get(&node_id) {
5593 let mut peer_state = peer_state_mtx.lock().unwrap();
5594 if let Some(blockers) = peer_state
5595 .actions_blocking_raa_monitor_updates
5596 .get_mut(&funding_outpoint.to_channel_id())
5598 let mut found_blocker = false;
5599 blockers.retain(|iter| {
5600 // Note that we could actually be blocked, in
5601 // which case we need to only remove the one
5602 // blocker which was added duplicatively.
5603 let first_blocker = !found_blocker;
5604 if *iter == blocker { found_blocker = true; }
5605 *iter != blocker || !first_blocker
5607 debug_assert!(found_blocker);
5610 debug_assert!(false);
5619 let preimage_update = ChannelMonitorUpdate {
5620 update_id: CLOSED_CHANNEL_UPDATE_ID,
5621 counterparty_node_id: None,
5622 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5628 // We update the ChannelMonitor on the backward link, after
5629 // receiving an `update_fulfill_htlc` from the forward link.
5630 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5631 if update_res != ChannelMonitorUpdateStatus::Completed {
5632 // TODO: This needs to be handled somehow - if we receive a monitor update
5633 // with a preimage we *must* somehow manage to propagate it to the upstream
5634 // channel, or we must have an ability to receive the same event and try
5635 // again on restart.
5636 log_error!(WithContext::from(&self.logger, None, Some(prev_hop.outpoint.to_channel_id())), "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5637 payment_preimage, update_res);
5640 // If we're running during init we cannot update a monitor directly - they probably
5641 // haven't actually been loaded yet. Instead, push the monitor update as a background
5643 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5644 // channel is already closed) we need to ultimately handle the monitor update
5645 // completion action only after we've completed the monitor update. This is the only
5646 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5647 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5648 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5649 // complete the monitor update completion action from `completion_action`.
5650 self.pending_background_events.lock().unwrap().push(
5651 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5652 prev_hop.outpoint, preimage_update,
5655 // Note that we do process the completion action here. This totally could be a
5656 // duplicate claim, but we have no way of knowing without interrogating the
5657 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5658 // generally always allowed to be duplicative (and it's specifically noted in
5659 // `PaymentForwarded`).
5660 self.handle_monitor_update_completion_actions(completion_action(None, false));
5664 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5665 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5668 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5669 forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, startup_replay: bool,
5670 next_channel_counterparty_node_id: Option<PublicKey>, next_channel_outpoint: OutPoint
5673 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5674 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5675 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5676 if let Some(pubkey) = next_channel_counterparty_node_id {
5677 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5679 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5680 channel_funding_outpoint: next_channel_outpoint,
5681 counterparty_node_id: path.hops[0].pubkey,
5683 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5684 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5687 HTLCSource::PreviousHopData(hop_data) => {
5688 let prev_outpoint = hop_data.outpoint;
5689 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5690 #[cfg(debug_assertions)]
5691 let claiming_chan_funding_outpoint = hop_data.outpoint;
5692 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5693 |htlc_claim_value_msat, definitely_duplicate| {
5694 let chan_to_release =
5695 if let Some(node_id) = next_channel_counterparty_node_id {
5696 Some((node_id, next_channel_outpoint, completed_blocker))
5698 // We can only get `None` here if we are processing a
5699 // `ChannelMonitor`-originated event, in which case we
5700 // don't care about ensuring we wake the downstream
5701 // channel's monitor updating - the channel is already
5706 if definitely_duplicate && startup_replay {
5707 // On startup we may get redundant claims which are related to
5708 // monitor updates still in flight. In that case, we shouldn't
5709 // immediately free, but instead let that monitor update complete
5710 // in the background.
5711 #[cfg(debug_assertions)] {
5712 let background_events = self.pending_background_events.lock().unwrap();
5713 // There should be a `BackgroundEvent` pending...
5714 assert!(background_events.iter().any(|ev| {
5716 // to apply a monitor update that blocked the claiming channel,
5717 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5718 funding_txo, update, ..
5720 if *funding_txo == claiming_chan_funding_outpoint {
5721 assert!(update.updates.iter().any(|upd|
5722 if let ChannelMonitorUpdateStep::PaymentPreimage {
5723 payment_preimage: update_preimage
5725 payment_preimage == *update_preimage
5731 // or the channel we'd unblock is already closed,
5732 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup(
5733 (funding_txo, monitor_update)
5735 if *funding_txo == next_channel_outpoint {
5736 assert_eq!(monitor_update.updates.len(), 1);
5738 monitor_update.updates[0],
5739 ChannelMonitorUpdateStep::ChannelForceClosed { .. }
5744 // or the monitor update has completed and will unblock
5745 // immediately once we get going.
5746 BackgroundEvent::MonitorUpdatesComplete {
5749 *channel_id == claiming_chan_funding_outpoint.to_channel_id(),
5751 }), "{:?}", *background_events);
5754 } else if definitely_duplicate {
5755 if let Some(other_chan) = chan_to_release {
5756 Some(MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5757 downstream_counterparty_node_id: other_chan.0,
5758 downstream_funding_outpoint: other_chan.1,
5759 blocking_action: other_chan.2,
5763 let fee_earned_msat = if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5764 if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5765 Some(claimed_htlc_value - forwarded_htlc_value)
5768 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5769 event: events::Event::PaymentForwarded {
5771 claim_from_onchain_tx: from_onchain,
5772 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5773 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5774 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5776 downstream_counterparty_and_funding_outpoint: chan_to_release,
5780 if let Err((pk, err)) = res {
5781 let result: Result<(), _> = Err(err);
5782 let _ = handle_error!(self, result, pk);
5788 /// Gets the node_id held by this ChannelManager
5789 pub fn get_our_node_id(&self) -> PublicKey {
5790 self.our_network_pubkey.clone()
5793 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5794 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5795 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5796 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
5798 for action in actions.into_iter() {
5800 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5801 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5802 if let Some(ClaimingPayment {
5804 payment_purpose: purpose,
5807 sender_intended_value: sender_intended_total_msat,
5809 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5813 receiver_node_id: Some(receiver_node_id),
5815 sender_intended_total_msat,
5819 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5820 event, downstream_counterparty_and_funding_outpoint
5822 self.pending_events.lock().unwrap().push_back((event, None));
5823 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5824 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5827 MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5828 downstream_counterparty_node_id, downstream_funding_outpoint, blocking_action,
5830 self.handle_monitor_update_release(
5831 downstream_counterparty_node_id,
5832 downstream_funding_outpoint,
5833 Some(blocking_action),
5840 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5841 /// update completion.
5842 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5843 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5844 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5845 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5846 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5847 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5848 let logger = WithChannelContext::from(&self.logger, &channel.context);
5849 log_trace!(logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5850 &channel.context.channel_id(),
5851 if raa.is_some() { "an" } else { "no" },
5852 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5853 if funding_broadcastable.is_some() { "" } else { "not " },
5854 if channel_ready.is_some() { "sending" } else { "without" },
5855 if announcement_sigs.is_some() { "sending" } else { "without" });
5857 let mut htlc_forwards = None;
5859 let counterparty_node_id = channel.context.get_counterparty_node_id();
5860 if !pending_forwards.is_empty() {
5861 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5862 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5865 if let Some(msg) = channel_ready {
5866 send_channel_ready!(self, pending_msg_events, channel, msg);
5868 if let Some(msg) = announcement_sigs {
5869 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5870 node_id: counterparty_node_id,
5875 macro_rules! handle_cs { () => {
5876 if let Some(update) = commitment_update {
5877 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5878 node_id: counterparty_node_id,
5883 macro_rules! handle_raa { () => {
5884 if let Some(revoke_and_ack) = raa {
5885 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5886 node_id: counterparty_node_id,
5887 msg: revoke_and_ack,
5892 RAACommitmentOrder::CommitmentFirst => {
5896 RAACommitmentOrder::RevokeAndACKFirst => {
5902 if let Some(tx) = funding_broadcastable {
5903 log_info!(logger, "Broadcasting funding transaction with txid {}", tx.txid());
5904 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5908 let mut pending_events = self.pending_events.lock().unwrap();
5909 emit_channel_pending_event!(pending_events, channel);
5910 emit_channel_ready_event!(pending_events, channel);
5916 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5917 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5919 let counterparty_node_id = match counterparty_node_id {
5920 Some(cp_id) => cp_id.clone(),
5922 // TODO: Once we can rely on the counterparty_node_id from the
5923 // monitor event, this and the outpoint_to_peer map should be removed.
5924 let outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
5925 match outpoint_to_peer.get(&funding_txo) {
5926 Some(cp_id) => cp_id.clone(),
5931 let per_peer_state = self.per_peer_state.read().unwrap();
5932 let mut peer_state_lock;
5933 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5934 if peer_state_mutex_opt.is_none() { return }
5935 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5936 let peer_state = &mut *peer_state_lock;
5938 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5941 let update_actions = peer_state.monitor_update_blocked_actions
5942 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5943 mem::drop(peer_state_lock);
5944 mem::drop(per_peer_state);
5945 self.handle_monitor_update_completion_actions(update_actions);
5948 let remaining_in_flight =
5949 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5950 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5953 let logger = WithChannelContext::from(&self.logger, &channel.context);
5954 log_trace!(logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5955 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5956 remaining_in_flight);
5957 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5960 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5963 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5965 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5966 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5969 /// The `user_channel_id` parameter will be provided back in
5970 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5971 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5973 /// Note that this method will return an error and reject the channel, if it requires support
5974 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5975 /// used to accept such channels.
5977 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5978 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5979 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5980 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5983 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5984 /// it as confirmed immediately.
5986 /// The `user_channel_id` parameter will be provided back in
5987 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5988 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5990 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5991 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5993 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5994 /// transaction and blindly assumes that it will eventually confirm.
5996 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5997 /// does not pay to the correct script the correct amount, *you will lose funds*.
5999 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
6000 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
6001 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
6002 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
6005 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
6007 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(*temporary_channel_id));
6008 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6010 let peers_without_funded_channels =
6011 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
6012 let per_peer_state = self.per_peer_state.read().unwrap();
6013 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6015 let err_str = format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id);
6016 log_error!(logger, "{}", err_str);
6018 APIError::ChannelUnavailable { err: err_str }
6020 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6021 let peer_state = &mut *peer_state_lock;
6022 let is_only_peer_channel = peer_state.total_channel_count() == 1;
6024 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
6025 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
6026 // that we can delay allocating the SCID until after we're sure that the checks below will
6028 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
6029 Some(unaccepted_channel) => {
6030 let best_block_height = self.best_block.read().unwrap().height();
6031 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6032 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
6033 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
6034 &self.logger, accept_0conf).map_err(|e| {
6035 let err_str = e.to_string();
6036 log_error!(logger, "{}", err_str);
6038 APIError::ChannelUnavailable { err: err_str }
6042 let err_str = "No such channel awaiting to be accepted.".to_owned();
6043 log_error!(logger, "{}", err_str);
6045 Err(APIError::APIMisuseError { err: err_str })
6050 // This should have been correctly configured by the call to InboundV1Channel::new.
6051 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
6052 } else if channel.context.get_channel_type().requires_zero_conf() {
6053 let send_msg_err_event = events::MessageSendEvent::HandleError {
6054 node_id: channel.context.get_counterparty_node_id(),
6055 action: msgs::ErrorAction::SendErrorMessage{
6056 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
6059 peer_state.pending_msg_events.push(send_msg_err_event);
6060 let err_str = "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned();
6061 log_error!(logger, "{}", err_str);
6063 return Err(APIError::APIMisuseError { err: err_str });
6065 // If this peer already has some channels, a new channel won't increase our number of peers
6066 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6067 // channels per-peer we can accept channels from a peer with existing ones.
6068 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
6069 let send_msg_err_event = events::MessageSendEvent::HandleError {
6070 node_id: channel.context.get_counterparty_node_id(),
6071 action: msgs::ErrorAction::SendErrorMessage{
6072 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
6075 peer_state.pending_msg_events.push(send_msg_err_event);
6076 let err_str = "Too many peers with unfunded channels, refusing to accept new ones".to_owned();
6077 log_error!(logger, "{}", err_str);
6079 return Err(APIError::APIMisuseError { err: err_str });
6083 // Now that we know we have a channel, assign an outbound SCID alias.
6084 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6085 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6087 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6088 node_id: channel.context.get_counterparty_node_id(),
6089 msg: channel.accept_inbound_channel(),
6092 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
6097 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
6098 /// or 0-conf channels.
6100 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
6101 /// non-0-conf channels we have with the peer.
6102 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
6103 where Filter: Fn(&PeerState<SP>) -> bool {
6104 let mut peers_without_funded_channels = 0;
6105 let best_block_height = self.best_block.read().unwrap().height();
6107 let peer_state_lock = self.per_peer_state.read().unwrap();
6108 for (_, peer_mtx) in peer_state_lock.iter() {
6109 let peer = peer_mtx.lock().unwrap();
6110 if !maybe_count_peer(&*peer) { continue; }
6111 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
6112 if num_unfunded_channels == peer.total_channel_count() {
6113 peers_without_funded_channels += 1;
6117 return peers_without_funded_channels;
6120 fn unfunded_channel_count(
6121 peer: &PeerState<SP>, best_block_height: u32
6123 let mut num_unfunded_channels = 0;
6124 for (_, phase) in peer.channel_by_id.iter() {
6126 ChannelPhase::Funded(chan) => {
6127 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
6128 // which have not yet had any confirmations on-chain.
6129 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
6130 chan.context.get_funding_tx_confirmations(best_block_height) == 0
6132 num_unfunded_channels += 1;
6135 ChannelPhase::UnfundedInboundV1(chan) => {
6136 if chan.context.minimum_depth().unwrap_or(1) != 0 {
6137 num_unfunded_channels += 1;
6140 ChannelPhase::UnfundedOutboundV1(_) => {
6141 // Outbound channels don't contribute to the unfunded count in the DoS context.
6146 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
6149 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
6150 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6151 // likely to be lost on restart!
6152 if msg.chain_hash != self.chain_hash {
6153 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
6156 if !self.default_configuration.accept_inbound_channels {
6157 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6160 // Get the number of peers with channels, but without funded ones. We don't care too much
6161 // about peers that never open a channel, so we filter by peers that have at least one
6162 // channel, and then limit the number of those with unfunded channels.
6163 let channeled_peers_without_funding =
6164 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
6166 let per_peer_state = self.per_peer_state.read().unwrap();
6167 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6169 debug_assert!(false);
6170 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())
6172 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6173 let peer_state = &mut *peer_state_lock;
6175 // If this peer already has some channels, a new channel won't increase our number of peers
6176 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6177 // channels per-peer we can accept channels from a peer with existing ones.
6178 if peer_state.total_channel_count() == 0 &&
6179 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
6180 !self.default_configuration.manually_accept_inbound_channels
6182 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6183 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
6184 msg.temporary_channel_id.clone()));
6187 let best_block_height = self.best_block.read().unwrap().height();
6188 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
6189 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6190 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
6191 msg.temporary_channel_id.clone()));
6194 let channel_id = msg.temporary_channel_id;
6195 let channel_exists = peer_state.has_channel(&channel_id);
6197 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
6200 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
6201 if self.default_configuration.manually_accept_inbound_channels {
6202 let channel_type = channel::channel_type_from_open_channel(
6203 &msg, &peer_state.latest_features, &self.channel_type_features()
6205 MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id)
6207 let mut pending_events = self.pending_events.lock().unwrap();
6208 pending_events.push_back((events::Event::OpenChannelRequest {
6209 temporary_channel_id: msg.temporary_channel_id.clone(),
6210 counterparty_node_id: counterparty_node_id.clone(),
6211 funding_satoshis: msg.funding_satoshis,
6212 push_msat: msg.push_msat,
6215 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
6216 open_channel_msg: msg.clone(),
6217 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
6222 // Otherwise create the channel right now.
6223 let mut random_bytes = [0u8; 16];
6224 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
6225 let user_channel_id = u128::from_be_bytes(random_bytes);
6226 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6227 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
6228 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
6231 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
6236 let channel_type = channel.context.get_channel_type();
6237 if channel_type.requires_zero_conf() {
6238 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6240 if channel_type.requires_anchors_zero_fee_htlc_tx() {
6241 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
6244 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6245 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6247 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6248 node_id: counterparty_node_id.clone(),
6249 msg: channel.accept_inbound_channel(),
6251 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
6255 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
6256 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6257 // likely to be lost on restart!
6258 let (value, output_script, user_id) = {
6259 let per_peer_state = self.per_peer_state.read().unwrap();
6260 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6262 debug_assert!(false);
6263 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)
6265 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6266 let peer_state = &mut *peer_state_lock;
6267 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
6268 hash_map::Entry::Occupied(mut phase) => {
6269 match phase.get_mut() {
6270 ChannelPhase::UnfundedOutboundV1(chan) => {
6271 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
6272 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
6275 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));
6279 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))
6282 let mut pending_events = self.pending_events.lock().unwrap();
6283 pending_events.push_back((events::Event::FundingGenerationReady {
6284 temporary_channel_id: msg.temporary_channel_id,
6285 counterparty_node_id: *counterparty_node_id,
6286 channel_value_satoshis: value,
6288 user_channel_id: user_id,
6293 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
6294 let best_block = *self.best_block.read().unwrap();
6296 let per_peer_state = self.per_peer_state.read().unwrap();
6297 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6299 debug_assert!(false);
6300 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)
6303 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6304 let peer_state = &mut *peer_state_lock;
6305 let (mut chan, funding_msg_opt, monitor) =
6306 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
6307 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
6308 let logger = WithChannelContext::from(&self.logger, &inbound_chan.context);
6309 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &&logger) {
6311 Err((inbound_chan, err)) => {
6312 // We've already removed this inbound channel from the map in `PeerState`
6313 // above so at this point we just need to clean up any lingering entries
6314 // concerning this channel as it is safe to do so.
6315 debug_assert!(matches!(err, ChannelError::Close(_)));
6316 // Really we should be returning the channel_id the peer expects based
6317 // on their funding info here, but they're horribly confused anyway, so
6318 // there's not a lot we can do to save them.
6319 return Err(convert_chan_phase_err!(self, err, &mut ChannelPhase::UnfundedInboundV1(inbound_chan), &msg.temporary_channel_id).1);
6323 Some(mut phase) => {
6324 let err_msg = format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id);
6325 let err = ChannelError::Close(err_msg);
6326 return Err(convert_chan_phase_err!(self, err, &mut phase, &msg.temporary_channel_id).1);
6328 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))
6331 let funded_channel_id = chan.context.channel_id();
6333 macro_rules! fail_chan { ($err: expr) => { {
6334 // Note that at this point we've filled in the funding outpoint on our
6335 // channel, but its actually in conflict with another channel. Thus, if
6336 // we call `convert_chan_phase_err` immediately (thus calling
6337 // `update_maps_on_chan_removal`), we'll remove the existing channel
6338 // from `outpoint_to_peer`. Thus, we must first unset the funding outpoint
6340 let err = ChannelError::Close($err.to_owned());
6341 chan.unset_funding_info(msg.temporary_channel_id);
6342 return Err(convert_chan_phase_err!(self, err, chan, &funded_channel_id, UNFUNDED_CHANNEL).1);
6345 match peer_state.channel_by_id.entry(funded_channel_id) {
6346 hash_map::Entry::Occupied(_) => {
6347 fail_chan!("Already had channel with the new channel_id");
6349 hash_map::Entry::Vacant(e) => {
6350 let mut outpoint_to_peer_lock = self.outpoint_to_peer.lock().unwrap();
6351 match outpoint_to_peer_lock.entry(monitor.get_funding_txo().0) {
6352 hash_map::Entry::Occupied(_) => {
6353 fail_chan!("The funding_created message had the same funding_txid as an existing channel - funding is not possible");
6355 hash_map::Entry::Vacant(i_e) => {
6356 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
6357 if let Ok(persist_state) = monitor_res {
6358 i_e.insert(chan.context.get_counterparty_node_id());
6359 mem::drop(outpoint_to_peer_lock);
6361 // There's no problem signing a counterparty's funding transaction if our monitor
6362 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
6363 // accepted payment from yet. We do, however, need to wait to send our channel_ready
6364 // until we have persisted our monitor.
6365 if let Some(msg) = funding_msg_opt {
6366 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6367 node_id: counterparty_node_id.clone(),
6372 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
6373 handle_new_monitor_update!(self, persist_state, peer_state_lock, peer_state,
6374 per_peer_state, chan, INITIAL_MONITOR);
6376 unreachable!("This must be a funded channel as we just inserted it.");
6380 let logger = WithChannelContext::from(&self.logger, &chan.context);
6381 log_error!(logger, "Persisting initial ChannelMonitor failed, implying the funding outpoint was duplicated");
6382 fail_chan!("Duplicate funding outpoint");
6390 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
6391 let best_block = *self.best_block.read().unwrap();
6392 let per_peer_state = self.per_peer_state.read().unwrap();
6393 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6395 debug_assert!(false);
6396 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6399 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6400 let peer_state = &mut *peer_state_lock;
6401 match peer_state.channel_by_id.entry(msg.channel_id) {
6402 hash_map::Entry::Occupied(chan_phase_entry) => {
6403 if matches!(chan_phase_entry.get(), ChannelPhase::UnfundedOutboundV1(_)) {
6404 let chan = if let ChannelPhase::UnfundedOutboundV1(chan) = chan_phase_entry.remove() { chan } else { unreachable!() };
6405 let logger = WithContext::from(
6407 Some(chan.context.get_counterparty_node_id()),
6408 Some(chan.context.channel_id())
6411 chan.funding_signed(&msg, best_block, &self.signer_provider, &&logger);
6413 Ok((mut chan, monitor)) => {
6414 if let Ok(persist_status) = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor) {
6415 // We really should be able to insert here without doing a second
6416 // lookup, but sadly rust stdlib doesn't currently allow keeping
6417 // the original Entry around with the value removed.
6418 let mut chan = peer_state.channel_by_id.entry(msg.channel_id).or_insert(ChannelPhase::Funded(chan));
6419 if let ChannelPhase::Funded(ref mut chan) = &mut chan {
6420 handle_new_monitor_update!(self, persist_status, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
6421 } else { unreachable!(); }
6424 let e = ChannelError::Close("Channel funding outpoint was a duplicate".to_owned());
6425 // We weren't able to watch the channel to begin with, so no
6426 // updates should be made on it. Previously, full_stack_target
6427 // found an (unreachable) panic when the monitor update contained
6428 // within `shutdown_finish` was applied.
6429 chan.unset_funding_info(msg.channel_id);
6430 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::Funded(chan), &msg.channel_id).1);
6434 debug_assert!(matches!(e, ChannelError::Close(_)),
6435 "We don't have a channel anymore, so the error better have expected close");
6436 // We've already removed this outbound channel from the map in
6437 // `PeerState` above so at this point we just need to clean up any
6438 // lingering entries concerning this channel as it is safe to do so.
6439 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::UnfundedOutboundV1(chan), &msg.channel_id).1);
6443 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
6446 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
6450 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
6451 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6452 // closing a channel), so any changes are likely to be lost on restart!
6453 let per_peer_state = self.per_peer_state.read().unwrap();
6454 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6456 debug_assert!(false);
6457 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6459 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6460 let peer_state = &mut *peer_state_lock;
6461 match peer_state.channel_by_id.entry(msg.channel_id) {
6462 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6463 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6464 let logger = WithChannelContext::from(&self.logger, &chan.context);
6465 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
6466 self.chain_hash, &self.default_configuration, &self.best_block.read().unwrap(), &&logger), chan_phase_entry);
6467 if let Some(announcement_sigs) = announcement_sigs_opt {
6468 log_trace!(logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
6469 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6470 node_id: counterparty_node_id.clone(),
6471 msg: announcement_sigs,
6473 } else if chan.context.is_usable() {
6474 // If we're sending an announcement_signatures, we'll send the (public)
6475 // channel_update after sending a channel_announcement when we receive our
6476 // counterparty's announcement_signatures. Thus, we only bother to send a
6477 // channel_update here if the channel is not public, i.e. we're not sending an
6478 // announcement_signatures.
6479 log_trace!(logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
6480 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6481 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6482 node_id: counterparty_node_id.clone(),
6489 let mut pending_events = self.pending_events.lock().unwrap();
6490 emit_channel_ready_event!(pending_events, chan);
6495 try_chan_phase_entry!(self, Err(ChannelError::Close(
6496 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
6499 hash_map::Entry::Vacant(_) => {
6500 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))
6505 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
6506 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
6507 let mut finish_shutdown = None;
6509 let per_peer_state = self.per_peer_state.read().unwrap();
6510 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6512 debug_assert!(false);
6513 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6515 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6516 let peer_state = &mut *peer_state_lock;
6517 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6518 let phase = chan_phase_entry.get_mut();
6520 ChannelPhase::Funded(chan) => {
6521 if !chan.received_shutdown() {
6522 let logger = WithChannelContext::from(&self.logger, &chan.context);
6523 log_info!(logger, "Received a shutdown message from our counterparty for channel {}{}.",
6525 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
6528 let funding_txo_opt = chan.context.get_funding_txo();
6529 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
6530 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
6531 dropped_htlcs = htlcs;
6533 if let Some(msg) = shutdown {
6534 // We can send the `shutdown` message before updating the `ChannelMonitor`
6535 // here as we don't need the monitor update to complete until we send a
6536 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
6537 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6538 node_id: *counterparty_node_id,
6542 // Update the monitor with the shutdown script if necessary.
6543 if let Some(monitor_update) = monitor_update_opt {
6544 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
6545 peer_state_lock, peer_state, per_peer_state, chan);
6548 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6549 let context = phase.context_mut();
6550 let logger = WithChannelContext::from(&self.logger, context);
6551 log_error!(logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6552 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6553 finish_shutdown = Some(chan.context_mut().force_shutdown(false, ClosureReason::CounterpartyCoopClosedUnfundedChannel));
6557 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))
6560 for htlc_source in dropped_htlcs.drain(..) {
6561 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6562 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6563 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6565 if let Some(shutdown_res) = finish_shutdown {
6566 self.finish_close_channel(shutdown_res);
6572 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6573 let per_peer_state = self.per_peer_state.read().unwrap();
6574 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6576 debug_assert!(false);
6577 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6579 let (tx, chan_option, shutdown_result) = {
6580 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6581 let peer_state = &mut *peer_state_lock;
6582 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6583 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6584 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6585 let (closing_signed, tx, shutdown_result) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6586 debug_assert_eq!(shutdown_result.is_some(), chan.is_shutdown());
6587 if let Some(msg) = closing_signed {
6588 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6589 node_id: counterparty_node_id.clone(),
6594 // We're done with this channel, we've got a signed closing transaction and
6595 // will send the closing_signed back to the remote peer upon return. This
6596 // also implies there are no pending HTLCs left on the channel, so we can
6597 // fully delete it from tracking (the channel monitor is still around to
6598 // watch for old state broadcasts)!
6599 (tx, Some(remove_channel_phase!(self, chan_phase_entry)), shutdown_result)
6600 } else { (tx, None, shutdown_result) }
6602 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6603 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6606 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))
6609 if let Some(broadcast_tx) = tx {
6610 let channel_id = chan_option.as_ref().map(|channel| channel.context().channel_id());
6611 log_info!(WithContext::from(&self.logger, Some(*counterparty_node_id), channel_id), "Broadcasting {}", log_tx!(broadcast_tx));
6612 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6614 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6615 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6616 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6617 let peer_state = &mut *peer_state_lock;
6618 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6623 mem::drop(per_peer_state);
6624 if let Some(shutdown_result) = shutdown_result {
6625 self.finish_close_channel(shutdown_result);
6630 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6631 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6632 //determine the state of the payment based on our response/if we forward anything/the time
6633 //we take to respond. We should take care to avoid allowing such an attack.
6635 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6636 //us repeatedly garbled in different ways, and compare our error messages, which are
6637 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6638 //but we should prevent it anyway.
6640 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6641 // closing a channel), so any changes are likely to be lost on restart!
6643 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
6644 let per_peer_state = self.per_peer_state.read().unwrap();
6645 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6647 debug_assert!(false);
6648 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6650 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6651 let peer_state = &mut *peer_state_lock;
6652 match peer_state.channel_by_id.entry(msg.channel_id) {
6653 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6654 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6655 let pending_forward_info = match decoded_hop_res {
6656 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6657 self.construct_pending_htlc_status(
6658 msg, counterparty_node_id, shared_secret, next_hop,
6659 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
6661 Err(e) => PendingHTLCStatus::Fail(e)
6663 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6664 if msg.blinding_point.is_some() {
6665 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(
6666 msgs::UpdateFailMalformedHTLC {
6667 channel_id: msg.channel_id,
6668 htlc_id: msg.htlc_id,
6669 sha256_of_onion: [0; 32],
6670 failure_code: INVALID_ONION_BLINDING,
6674 // If the update_add is completely bogus, the call will Err and we will close,
6675 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6676 // want to reject the new HTLC and fail it backwards instead of forwarding.
6677 match pending_forward_info {
6678 PendingHTLCStatus::Forward(PendingHTLCInfo {
6679 ref incoming_shared_secret, ref routing, ..
6681 let reason = if routing.blinded_failure().is_some() {
6682 HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32])
6683 } else if (error_code & 0x1000) != 0 {
6684 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6685 HTLCFailReason::reason(real_code, error_data)
6687 HTLCFailReason::from_failure_code(error_code)
6688 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6689 let msg = msgs::UpdateFailHTLC {
6690 channel_id: msg.channel_id,
6691 htlc_id: msg.htlc_id,
6694 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6696 _ => pending_forward_info
6699 let logger = WithChannelContext::from(&self.logger, &chan.context);
6700 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &&logger), chan_phase_entry);
6702 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6703 "Got an update_add_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))
6711 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6713 let (htlc_source, forwarded_htlc_value) = {
6714 let per_peer_state = self.per_peer_state.read().unwrap();
6715 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6717 debug_assert!(false);
6718 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6720 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6721 let peer_state = &mut *peer_state_lock;
6722 match peer_state.channel_by_id.entry(msg.channel_id) {
6723 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6724 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6725 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6726 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6727 let logger = WithChannelContext::from(&self.logger, &chan.context);
6729 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
6731 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6732 .or_insert_with(Vec::new)
6733 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6735 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6736 // entry here, even though we *do* need to block the next RAA monitor update.
6737 // We do this instead in the `claim_funds_internal` by attaching a
6738 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6739 // outbound HTLC is claimed. This is guaranteed to all complete before we
6740 // process the RAA as messages are processed from single peers serially.
6741 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6744 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6745 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6748 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))
6751 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, false, Some(*counterparty_node_id), funding_txo);
6755 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6756 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6757 // closing a channel), so any changes are likely to be lost on restart!
6758 let per_peer_state = self.per_peer_state.read().unwrap();
6759 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6761 debug_assert!(false);
6762 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6764 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6765 let peer_state = &mut *peer_state_lock;
6766 match peer_state.channel_by_id.entry(msg.channel_id) {
6767 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6768 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6769 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6771 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6772 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6775 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))
6780 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6781 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6782 // closing a channel), so any changes are likely to be lost on restart!
6783 let per_peer_state = self.per_peer_state.read().unwrap();
6784 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6786 debug_assert!(false);
6787 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6789 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6790 let peer_state = &mut *peer_state_lock;
6791 match peer_state.channel_by_id.entry(msg.channel_id) {
6792 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6793 if (msg.failure_code & 0x8000) == 0 {
6794 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6795 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6797 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6798 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);
6800 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6801 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6805 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))
6809 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6810 let per_peer_state = self.per_peer_state.read().unwrap();
6811 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6813 debug_assert!(false);
6814 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6816 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6817 let peer_state = &mut *peer_state_lock;
6818 match peer_state.channel_by_id.entry(msg.channel_id) {
6819 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6820 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6821 let logger = WithChannelContext::from(&self.logger, &chan.context);
6822 let funding_txo = chan.context.get_funding_txo();
6823 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &&logger), chan_phase_entry);
6824 if let Some(monitor_update) = monitor_update_opt {
6825 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6826 peer_state, per_peer_state, chan);
6830 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6831 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6834 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))
6839 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6840 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6841 let mut push_forward_event = false;
6842 let mut new_intercept_events = VecDeque::new();
6843 let mut failed_intercept_forwards = Vec::new();
6844 if !pending_forwards.is_empty() {
6845 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6846 let scid = match forward_info.routing {
6847 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6848 PendingHTLCRouting::Receive { .. } => 0,
6849 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6851 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6852 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6854 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6855 let forward_htlcs_empty = forward_htlcs.is_empty();
6856 match forward_htlcs.entry(scid) {
6857 hash_map::Entry::Occupied(mut entry) => {
6858 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6859 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6861 hash_map::Entry::Vacant(entry) => {
6862 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6863 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.chain_hash)
6865 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).to_byte_array());
6866 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6867 match pending_intercepts.entry(intercept_id) {
6868 hash_map::Entry::Vacant(entry) => {
6869 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6870 requested_next_hop_scid: scid,
6871 payment_hash: forward_info.payment_hash,
6872 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6873 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6876 entry.insert(PendingAddHTLCInfo {
6877 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6879 hash_map::Entry::Occupied(_) => {
6880 let logger = WithContext::from(&self.logger, None, Some(prev_funding_outpoint.to_channel_id()));
6881 log_info!(logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6882 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6883 short_channel_id: prev_short_channel_id,
6884 user_channel_id: Some(prev_user_channel_id),
6885 outpoint: prev_funding_outpoint,
6886 htlc_id: prev_htlc_id,
6887 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6888 phantom_shared_secret: None,
6889 blinded_failure: forward_info.routing.blinded_failure(),
6892 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6893 HTLCFailReason::from_failure_code(0x4000 | 10),
6894 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6899 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6900 // payments are being processed.
6901 if forward_htlcs_empty {
6902 push_forward_event = true;
6904 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6905 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6912 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6913 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6916 if !new_intercept_events.is_empty() {
6917 let mut events = self.pending_events.lock().unwrap();
6918 events.append(&mut new_intercept_events);
6920 if push_forward_event { self.push_pending_forwards_ev() }
6924 fn push_pending_forwards_ev(&self) {
6925 let mut pending_events = self.pending_events.lock().unwrap();
6926 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6927 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6928 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6930 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6931 // events is done in batches and they are not removed until we're done processing each
6932 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6933 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6934 // payments will need an additional forwarding event before being claimed to make them look
6935 // real by taking more time.
6936 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6937 pending_events.push_back((Event::PendingHTLCsForwardable {
6938 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6943 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6944 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6945 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6946 /// the [`ChannelMonitorUpdate`] in question.
6947 fn raa_monitor_updates_held(&self,
6948 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6949 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6951 actions_blocking_raa_monitor_updates
6952 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6953 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6954 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6955 channel_funding_outpoint,
6956 counterparty_node_id,
6961 #[cfg(any(test, feature = "_test_utils"))]
6962 pub(crate) fn test_raa_monitor_updates_held(&self,
6963 counterparty_node_id: PublicKey, channel_id: ChannelId
6965 let per_peer_state = self.per_peer_state.read().unwrap();
6966 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6967 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6968 let peer_state = &mut *peer_state_lck;
6970 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
6971 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6972 chan.context().get_funding_txo().unwrap(), counterparty_node_id);
6978 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6979 let htlcs_to_fail = {
6980 let per_peer_state = self.per_peer_state.read().unwrap();
6981 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6983 debug_assert!(false);
6984 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6985 }).map(|mtx| mtx.lock().unwrap())?;
6986 let peer_state = &mut *peer_state_lock;
6987 match peer_state.channel_by_id.entry(msg.channel_id) {
6988 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6989 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6990 let logger = WithChannelContext::from(&self.logger, &chan.context);
6991 let funding_txo_opt = chan.context.get_funding_txo();
6992 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6993 self.raa_monitor_updates_held(
6994 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6995 *counterparty_node_id)
6997 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
6998 chan.revoke_and_ack(&msg, &self.fee_estimator, &&logger, mon_update_blocked), chan_phase_entry);
6999 if let Some(monitor_update) = monitor_update_opt {
7000 let funding_txo = funding_txo_opt
7001 .expect("Funding outpoint must have been set for RAA handling to succeed");
7002 handle_new_monitor_update!(self, funding_txo, monitor_update,
7003 peer_state_lock, peer_state, per_peer_state, chan);
7007 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7008 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
7011 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))
7014 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
7018 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
7019 let per_peer_state = self.per_peer_state.read().unwrap();
7020 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7022 debug_assert!(false);
7023 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7025 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7026 let peer_state = &mut *peer_state_lock;
7027 match peer_state.channel_by_id.entry(msg.channel_id) {
7028 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7029 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7030 let logger = WithChannelContext::from(&self.logger, &chan.context);
7031 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &&logger), chan_phase_entry);
7033 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7034 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
7037 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))
7042 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
7043 let per_peer_state = self.per_peer_state.read().unwrap();
7044 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7046 debug_assert!(false);
7047 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7049 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7050 let peer_state = &mut *peer_state_lock;
7051 match peer_state.channel_by_id.entry(msg.channel_id) {
7052 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7053 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7054 if !chan.context.is_usable() {
7055 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
7058 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7059 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
7060 &self.node_signer, self.chain_hash, self.best_block.read().unwrap().height(),
7061 msg, &self.default_configuration
7062 ), chan_phase_entry),
7063 // Note that announcement_signatures fails if the channel cannot be announced,
7064 // so get_channel_update_for_broadcast will never fail by the time we get here.
7065 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
7068 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7069 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
7072 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))
7077 /// Returns DoPersist if anything changed, otherwise either SkipPersistNoEvents or an Err.
7078 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
7079 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
7080 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
7082 // It's not a local channel
7083 return Ok(NotifyOption::SkipPersistNoEvents)
7086 let per_peer_state = self.per_peer_state.read().unwrap();
7087 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
7088 if peer_state_mutex_opt.is_none() {
7089 return Ok(NotifyOption::SkipPersistNoEvents)
7091 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7092 let peer_state = &mut *peer_state_lock;
7093 match peer_state.channel_by_id.entry(chan_id) {
7094 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7095 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7096 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
7097 if chan.context.should_announce() {
7098 // If the announcement is about a channel of ours which is public, some
7099 // other peer may simply be forwarding all its gossip to us. Don't provide
7100 // a scary-looking error message and return Ok instead.
7101 return Ok(NotifyOption::SkipPersistNoEvents);
7103 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));
7105 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
7106 let msg_from_node_one = msg.contents.flags & 1 == 0;
7107 if were_node_one == msg_from_node_one {
7108 return Ok(NotifyOption::SkipPersistNoEvents);
7110 let logger = WithChannelContext::from(&self.logger, &chan.context);
7111 log_debug!(logger, "Received channel_update {:?} for channel {}.", msg, chan_id);
7112 let did_change = try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
7113 // If nothing changed after applying their update, we don't need to bother
7116 return Ok(NotifyOption::SkipPersistNoEvents);
7120 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7121 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
7124 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersistNoEvents)
7126 Ok(NotifyOption::DoPersist)
7129 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<NotifyOption, MsgHandleErrInternal> {
7131 let need_lnd_workaround = {
7132 let per_peer_state = self.per_peer_state.read().unwrap();
7134 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7136 debug_assert!(false);
7137 MsgHandleErrInternal::send_err_msg_no_close(
7138 format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id),
7142 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
7143 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7144 let peer_state = &mut *peer_state_lock;
7145 match peer_state.channel_by_id.entry(msg.channel_id) {
7146 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7147 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7148 // Currently, we expect all holding cell update_adds to be dropped on peer
7149 // disconnect, so Channel's reestablish will never hand us any holding cell
7150 // freed HTLCs to fail backwards. If in the future we no longer drop pending
7151 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
7152 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
7153 msg, &&logger, &self.node_signer, self.chain_hash,
7154 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
7155 let mut channel_update = None;
7156 if let Some(msg) = responses.shutdown_msg {
7157 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7158 node_id: counterparty_node_id.clone(),
7161 } else if chan.context.is_usable() {
7162 // If the channel is in a usable state (ie the channel is not being shut
7163 // down), send a unicast channel_update to our counterparty to make sure
7164 // they have the latest channel parameters.
7165 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
7166 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
7167 node_id: chan.context.get_counterparty_node_id(),
7172 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
7173 htlc_forwards = self.handle_channel_resumption(
7174 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
7175 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
7176 if let Some(upd) = channel_update {
7177 peer_state.pending_msg_events.push(upd);
7181 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7182 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
7185 hash_map::Entry::Vacant(_) => {
7186 log_debug!(logger, "Sending bogus ChannelReestablish for unknown channel {} to force channel closure",
7188 // Unfortunately, lnd doesn't force close on errors
7189 // (https://github.com/lightningnetwork/lnd/blob/abb1e3463f3a83bbb843d5c399869dbe930ad94f/htlcswitch/link.go#L2119).
7190 // One of the few ways to get an lnd counterparty to force close is by
7191 // replicating what they do when restoring static channel backups (SCBs). They
7192 // send an invalid `ChannelReestablish` with `0` commitment numbers and an
7193 // invalid `your_last_per_commitment_secret`.
7195 // Since we received a `ChannelReestablish` for a channel that doesn't exist, we
7196 // can assume it's likely the channel closed from our point of view, but it
7197 // remains open on the counterparty's side. By sending this bogus
7198 // `ChannelReestablish` message now as a response to theirs, we trigger them to
7199 // force close broadcasting their latest state. If the closing transaction from
7200 // our point of view remains unconfirmed, it'll enter a race with the
7201 // counterparty's to-be-broadcast latest commitment transaction.
7202 peer_state.pending_msg_events.push(MessageSendEvent::SendChannelReestablish {
7203 node_id: *counterparty_node_id,
7204 msg: msgs::ChannelReestablish {
7205 channel_id: msg.channel_id,
7206 next_local_commitment_number: 0,
7207 next_remote_commitment_number: 0,
7208 your_last_per_commitment_secret: [1u8; 32],
7209 my_current_per_commitment_point: PublicKey::from_slice(&[2u8; 33]).unwrap(),
7210 next_funding_txid: None,
7213 return Err(MsgHandleErrInternal::send_err_msg_no_close(
7214 format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
7215 counterparty_node_id), msg.channel_id)
7221 let mut persist = NotifyOption::SkipPersistHandleEvents;
7222 if let Some(forwards) = htlc_forwards {
7223 self.forward_htlcs(&mut [forwards][..]);
7224 persist = NotifyOption::DoPersist;
7227 if let Some(channel_ready_msg) = need_lnd_workaround {
7228 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
7233 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
7234 fn process_pending_monitor_events(&self) -> bool {
7235 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
7237 let mut failed_channels = Vec::new();
7238 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
7239 let has_pending_monitor_events = !pending_monitor_events.is_empty();
7240 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
7241 for monitor_event in monitor_events.drain(..) {
7242 match monitor_event {
7243 MonitorEvent::HTLCEvent(htlc_update) => {
7244 let logger = WithContext::from(&self.logger, counterparty_node_id, Some(funding_outpoint.to_channel_id()));
7245 if let Some(preimage) = htlc_update.payment_preimage {
7246 log_trace!(logger, "Claiming HTLC with preimage {} from our monitor", preimage);
7247 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, false, counterparty_node_id, funding_outpoint);
7249 log_trace!(logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
7250 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
7251 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7252 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
7255 MonitorEvent::HolderForceClosed(funding_outpoint) => {
7256 let counterparty_node_id_opt = match counterparty_node_id {
7257 Some(cp_id) => Some(cp_id),
7259 // TODO: Once we can rely on the counterparty_node_id from the
7260 // monitor event, this and the outpoint_to_peer map should be removed.
7261 let outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
7262 outpoint_to_peer.get(&funding_outpoint).cloned()
7265 if let Some(counterparty_node_id) = counterparty_node_id_opt {
7266 let per_peer_state = self.per_peer_state.read().unwrap();
7267 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7268 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7269 let peer_state = &mut *peer_state_lock;
7270 let pending_msg_events = &mut peer_state.pending_msg_events;
7271 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
7272 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
7273 failed_channels.push(chan.context.force_shutdown(false, ClosureReason::HolderForceClosed));
7274 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7275 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7279 pending_msg_events.push(events::MessageSendEvent::HandleError {
7280 node_id: chan.context.get_counterparty_node_id(),
7281 action: msgs::ErrorAction::DisconnectPeer {
7282 msg: Some(msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() })
7290 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
7291 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
7297 for failure in failed_channels.drain(..) {
7298 self.finish_close_channel(failure);
7301 has_pending_monitor_events
7304 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
7305 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
7306 /// update events as a separate process method here.
7308 pub fn process_monitor_events(&self) {
7309 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7310 self.process_pending_monitor_events();
7313 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
7314 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
7315 /// update was applied.
7316 fn check_free_holding_cells(&self) -> bool {
7317 let mut has_monitor_update = false;
7318 let mut failed_htlcs = Vec::new();
7320 // Walk our list of channels and find any that need to update. Note that when we do find an
7321 // update, if it includes actions that must be taken afterwards, we have to drop the
7322 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
7323 // manage to go through all our peers without finding a single channel to update.
7325 let per_peer_state = self.per_peer_state.read().unwrap();
7326 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7328 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7329 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
7330 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
7331 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
7333 let counterparty_node_id = chan.context.get_counterparty_node_id();
7334 let funding_txo = chan.context.get_funding_txo();
7335 let (monitor_opt, holding_cell_failed_htlcs) =
7336 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &&WithChannelContext::from(&self.logger, &chan.context));
7337 if !holding_cell_failed_htlcs.is_empty() {
7338 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
7340 if let Some(monitor_update) = monitor_opt {
7341 has_monitor_update = true;
7343 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
7344 peer_state_lock, peer_state, per_peer_state, chan);
7345 continue 'peer_loop;
7354 let has_update = has_monitor_update || !failed_htlcs.is_empty();
7355 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
7356 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
7362 /// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
7363 /// is (temporarily) unavailable, and the operation should be retried later.
7365 /// This method allows for that retry - either checking for any signer-pending messages to be
7366 /// attempted in every channel, or in the specifically provided channel.
7368 /// [`ChannelSigner`]: crate::sign::ChannelSigner
7369 #[cfg(async_signing)]
7370 pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
7371 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7373 let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
7374 let node_id = phase.context().get_counterparty_node_id();
7376 ChannelPhase::Funded(chan) => {
7377 let msgs = chan.signer_maybe_unblocked(&self.logger);
7378 if let Some(updates) = msgs.commitment_update {
7379 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
7384 if let Some(msg) = msgs.funding_signed {
7385 pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
7390 if let Some(msg) = msgs.channel_ready {
7391 send_channel_ready!(self, pending_msg_events, chan, msg);
7394 ChannelPhase::UnfundedOutboundV1(chan) => {
7395 if let Some(msg) = chan.signer_maybe_unblocked(&self.logger) {
7396 pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
7402 ChannelPhase::UnfundedInboundV1(_) => {},
7406 let per_peer_state = self.per_peer_state.read().unwrap();
7407 if let Some((counterparty_node_id, channel_id)) = channel_opt {
7408 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7409 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7410 let peer_state = &mut *peer_state_lock;
7411 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
7412 unblock_chan(chan, &mut peer_state.pending_msg_events);
7416 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7417 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7418 let peer_state = &mut *peer_state_lock;
7419 for (_, chan) in peer_state.channel_by_id.iter_mut() {
7420 unblock_chan(chan, &mut peer_state.pending_msg_events);
7426 /// Check whether any channels have finished removing all pending updates after a shutdown
7427 /// exchange and can now send a closing_signed.
7428 /// Returns whether any closing_signed messages were generated.
7429 fn maybe_generate_initial_closing_signed(&self) -> bool {
7430 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
7431 let mut has_update = false;
7432 let mut shutdown_results = Vec::new();
7434 let per_peer_state = self.per_peer_state.read().unwrap();
7436 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7437 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7438 let peer_state = &mut *peer_state_lock;
7439 let pending_msg_events = &mut peer_state.pending_msg_events;
7440 peer_state.channel_by_id.retain(|channel_id, phase| {
7442 ChannelPhase::Funded(chan) => {
7443 let logger = WithChannelContext::from(&self.logger, &chan.context);
7444 match chan.maybe_propose_closing_signed(&self.fee_estimator, &&logger) {
7445 Ok((msg_opt, tx_opt, shutdown_result_opt)) => {
7446 if let Some(msg) = msg_opt {
7448 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
7449 node_id: chan.context.get_counterparty_node_id(), msg,
7452 debug_assert_eq!(shutdown_result_opt.is_some(), chan.is_shutdown());
7453 if let Some(shutdown_result) = shutdown_result_opt {
7454 shutdown_results.push(shutdown_result);
7456 if let Some(tx) = tx_opt {
7457 // We're done with this channel. We got a closing_signed and sent back
7458 // a closing_signed with a closing transaction to broadcast.
7459 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7460 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7465 log_info!(logger, "Broadcasting {}", log_tx!(tx));
7466 self.tx_broadcaster.broadcast_transactions(&[&tx]);
7467 update_maps_on_chan_removal!(self, &chan.context);
7473 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
7474 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
7479 _ => true, // Retain unfunded channels if present.
7485 for (counterparty_node_id, err) in handle_errors.drain(..) {
7486 let _ = handle_error!(self, err, counterparty_node_id);
7489 for shutdown_result in shutdown_results.drain(..) {
7490 self.finish_close_channel(shutdown_result);
7496 /// Handle a list of channel failures during a block_connected or block_disconnected call,
7497 /// pushing the channel monitor update (if any) to the background events queue and removing the
7499 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
7500 for mut failure in failed_channels.drain(..) {
7501 // Either a commitment transactions has been confirmed on-chain or
7502 // Channel::block_disconnected detected that the funding transaction has been
7503 // reorganized out of the main chain.
7504 // We cannot broadcast our latest local state via monitor update (as
7505 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
7506 // so we track the update internally and handle it when the user next calls
7507 // timer_tick_occurred, guaranteeing we're running normally.
7508 if let Some((counterparty_node_id, funding_txo, update)) = failure.monitor_update.take() {
7509 assert_eq!(update.updates.len(), 1);
7510 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
7511 assert!(should_broadcast);
7512 } else { unreachable!(); }
7513 self.pending_background_events.lock().unwrap().push(
7514 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
7515 counterparty_node_id, funding_txo, update
7518 self.finish_close_channel(failure);
7522 /// Creates an [`OfferBuilder`] such that the [`Offer`] it builds is recognized by the
7523 /// [`ChannelManager`] when handling [`InvoiceRequest`] messages for the offer. The offer will
7524 /// not have an expiration unless otherwise set on the builder.
7528 /// Uses [`MessageRouter::create_blinded_paths`] to construct a [`BlindedPath`] for the offer.
7529 /// However, if one is not found, uses a one-hop [`BlindedPath`] with
7530 /// [`ChannelManager::get_our_node_id`] as the introduction node instead. In the latter case,
7531 /// the node must be announced, otherwise, there is no way to find a path to the introduction in
7532 /// order to send the [`InvoiceRequest`].
7534 /// Also, uses a derived signing pubkey in the offer for recipient privacy.
7538 /// Requires a direct connection to the introduction node in the responding [`InvoiceRequest`]'s
7543 /// Errors if the parameterized [`Router`] is unable to create a blinded path for the offer.
7545 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7547 /// [`Offer`]: crate::offers::offer::Offer
7548 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7549 pub fn create_offer_builder(
7550 &self, description: String
7551 ) -> Result<OfferBuilder<DerivedMetadata, secp256k1::All>, Bolt12SemanticError> {
7552 let node_id = self.get_our_node_id();
7553 let expanded_key = &self.inbound_payment_key;
7554 let entropy = &*self.entropy_source;
7555 let secp_ctx = &self.secp_ctx;
7557 let path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7558 let builder = OfferBuilder::deriving_signing_pubkey(
7559 description, node_id, expanded_key, entropy, secp_ctx
7561 .chain_hash(self.chain_hash)
7567 /// Creates a [`RefundBuilder`] such that the [`Refund`] it builds is recognized by the
7568 /// [`ChannelManager`] when handling [`Bolt12Invoice`] messages for the refund.
7572 /// The provided `payment_id` is used to ensure that only one invoice is paid for the refund.
7573 /// See [Avoiding Duplicate Payments] for other requirements once the payment has been sent.
7575 /// The builder will have the provided expiration set. Any changes to the expiration on the
7576 /// returned builder will not be honored by [`ChannelManager`]. For `no-std`, the highest seen
7577 /// block time minus two hours is used for the current time when determining if the refund has
7580 /// To revoke the refund, use [`ChannelManager::abandon_payment`] prior to receiving the
7581 /// invoice. If abandoned, or an invoice isn't received before expiration, the payment will fail
7582 /// with an [`Event::InvoiceRequestFailed`].
7584 /// If `max_total_routing_fee_msat` is not specified, The default from
7585 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7589 /// Uses [`MessageRouter::create_blinded_paths`] to construct a [`BlindedPath`] for the refund.
7590 /// However, if one is not found, uses a one-hop [`BlindedPath`] with
7591 /// [`ChannelManager::get_our_node_id`] as the introduction node instead. In the latter case,
7592 /// the node must be announced, otherwise, there is no way to find a path to the introduction in
7593 /// order to send the [`Bolt12Invoice`].
7595 /// Also, uses a derived payer id in the refund for payer privacy.
7599 /// Requires a direct connection to an introduction node in the responding
7600 /// [`Bolt12Invoice::payment_paths`].
7605 /// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
7606 /// - `amount_msats` is invalid, or
7607 /// - the parameterized [`Router`] is unable to create a blinded path for the refund.
7609 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7611 /// [`Refund`]: crate::offers::refund::Refund
7612 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7613 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7614 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7615 pub fn create_refund_builder(
7616 &self, description: String, amount_msats: u64, absolute_expiry: Duration,
7617 payment_id: PaymentId, retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
7618 ) -> Result<RefundBuilder<secp256k1::All>, Bolt12SemanticError> {
7619 let node_id = self.get_our_node_id();
7620 let expanded_key = &self.inbound_payment_key;
7621 let entropy = &*self.entropy_source;
7622 let secp_ctx = &self.secp_ctx;
7624 let path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7625 let builder = RefundBuilder::deriving_payer_id(
7626 description, node_id, expanded_key, entropy, secp_ctx, amount_msats, payment_id
7628 .chain_hash(self.chain_hash)
7629 .absolute_expiry(absolute_expiry)
7632 let expiration = StaleExpiration::AbsoluteTimeout(absolute_expiry);
7633 self.pending_outbound_payments
7634 .add_new_awaiting_invoice(
7635 payment_id, expiration, retry_strategy, max_total_routing_fee_msat,
7637 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7642 /// Pays for an [`Offer`] using the given parameters by creating an [`InvoiceRequest`] and
7643 /// enqueuing it to be sent via an onion message. [`ChannelManager`] will pay the actual
7644 /// [`Bolt12Invoice`] once it is received.
7646 /// Uses [`InvoiceRequestBuilder`] such that the [`InvoiceRequest`] it builds is recognized by
7647 /// the [`ChannelManager`] when handling a [`Bolt12Invoice`] message in response to the request.
7648 /// The optional parameters are used in the builder, if `Some`:
7649 /// - `quantity` for [`InvoiceRequest::quantity`] which must be set if
7650 /// [`Offer::expects_quantity`] is `true`.
7651 /// - `amount_msats` if overpaying what is required for the given `quantity` is desired, and
7652 /// - `payer_note` for [`InvoiceRequest::payer_note`].
7654 /// If `max_total_routing_fee_msat` is not specified, The default from
7655 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7659 /// The provided `payment_id` is used to ensure that only one invoice is paid for the request
7660 /// when received. See [Avoiding Duplicate Payments] for other requirements once the payment has
7663 /// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
7664 /// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
7665 /// payment will fail with an [`Event::InvoiceRequestFailed`].
7669 /// Uses a one-hop [`BlindedPath`] for the reply path with [`ChannelManager::get_our_node_id`]
7670 /// as the introduction node and a derived payer id for payer privacy. As such, currently, the
7671 /// node must be announced. Otherwise, there is no way to find a path to the introduction node
7672 /// in order to send the [`Bolt12Invoice`].
7676 /// Requires a direct connection to an introduction node in [`Offer::paths`] or to
7677 /// [`Offer::signing_pubkey`], if empty. A similar restriction applies to the responding
7678 /// [`Bolt12Invoice::payment_paths`].
7683 /// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
7684 /// - the provided parameters are invalid for the offer,
7685 /// - the parameterized [`Router`] is unable to create a blinded reply path for the invoice
7688 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7689 /// [`InvoiceRequest::quantity`]: crate::offers::invoice_request::InvoiceRequest::quantity
7690 /// [`InvoiceRequest::payer_note`]: crate::offers::invoice_request::InvoiceRequest::payer_note
7691 /// [`InvoiceRequestBuilder`]: crate::offers::invoice_request::InvoiceRequestBuilder
7692 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7693 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7694 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7695 pub fn pay_for_offer(
7696 &self, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>,
7697 payer_note: Option<String>, payment_id: PaymentId, retry_strategy: Retry,
7698 max_total_routing_fee_msat: Option<u64>
7699 ) -> Result<(), Bolt12SemanticError> {
7700 let expanded_key = &self.inbound_payment_key;
7701 let entropy = &*self.entropy_source;
7702 let secp_ctx = &self.secp_ctx;
7705 .request_invoice_deriving_payer_id(expanded_key, entropy, secp_ctx, payment_id)?
7706 .chain_hash(self.chain_hash)?;
7707 let builder = match quantity {
7709 Some(quantity) => builder.quantity(quantity)?,
7711 let builder = match amount_msats {
7713 Some(amount_msats) => builder.amount_msats(amount_msats)?,
7715 let builder = match payer_note {
7717 Some(payer_note) => builder.payer_note(payer_note),
7719 let invoice_request = builder.build_and_sign()?;
7720 let reply_path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7722 let expiration = StaleExpiration::TimerTicks(1);
7723 self.pending_outbound_payments
7724 .add_new_awaiting_invoice(
7725 payment_id, expiration, retry_strategy, max_total_routing_fee_msat
7727 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7729 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7730 if offer.paths().is_empty() {
7731 let message = new_pending_onion_message(
7732 OffersMessage::InvoiceRequest(invoice_request),
7733 Destination::Node(offer.signing_pubkey()),
7736 pending_offers_messages.push(message);
7738 // Send as many invoice requests as there are paths in the offer (with an upper bound).
7739 // Using only one path could result in a failure if the path no longer exists. But only
7740 // one invoice for a given payment id will be paid, even if more than one is received.
7741 const REQUEST_LIMIT: usize = 10;
7742 for path in offer.paths().into_iter().take(REQUEST_LIMIT) {
7743 let message = new_pending_onion_message(
7744 OffersMessage::InvoiceRequest(invoice_request.clone()),
7745 Destination::BlindedPath(path.clone()),
7746 Some(reply_path.clone()),
7748 pending_offers_messages.push(message);
7755 /// Creates a [`Bolt12Invoice`] for a [`Refund`] and enqueues it to be sent via an onion
7758 /// The resulting invoice uses a [`PaymentHash`] recognized by the [`ChannelManager`] and a
7759 /// [`BlindedPath`] containing the [`PaymentSecret`] needed to reconstruct the corresponding
7760 /// [`PaymentPreimage`].
7764 /// Requires a direct connection to an introduction node in [`Refund::paths`] or to
7765 /// [`Refund::payer_id`], if empty. This request is best effort; an invoice will be sent to each
7766 /// node meeting the aforementioned criteria, but there's no guarantee that they will be
7767 /// received and no retries will be made.
7771 /// Errors if the parameterized [`Router`] is unable to create a blinded payment path or reply
7772 /// path for the invoice.
7774 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7775 pub fn request_refund_payment(&self, refund: &Refund) -> Result<(), Bolt12SemanticError> {
7776 let expanded_key = &self.inbound_payment_key;
7777 let entropy = &*self.entropy_source;
7778 let secp_ctx = &self.secp_ctx;
7780 let amount_msats = refund.amount_msats();
7781 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
7783 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
7784 Ok((payment_hash, payment_secret)) => {
7785 let payment_paths = self.create_blinded_payment_paths(amount_msats, payment_secret)
7786 .map_err(|_| Bolt12SemanticError::MissingPaths)?;
7788 #[cfg(not(feature = "no-std"))]
7789 let builder = refund.respond_using_derived_keys(
7790 payment_paths, payment_hash, expanded_key, entropy
7792 #[cfg(feature = "no-std")]
7793 let created_at = Duration::from_secs(
7794 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
7796 #[cfg(feature = "no-std")]
7797 let builder = refund.respond_using_derived_keys_no_std(
7798 payment_paths, payment_hash, created_at, expanded_key, entropy
7800 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
7801 let reply_path = self.create_blinded_path()
7802 .map_err(|_| Bolt12SemanticError::MissingPaths)?;
7804 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7805 if refund.paths().is_empty() {
7806 let message = new_pending_onion_message(
7807 OffersMessage::Invoice(invoice),
7808 Destination::Node(refund.payer_id()),
7811 pending_offers_messages.push(message);
7813 for path in refund.paths() {
7814 let message = new_pending_onion_message(
7815 OffersMessage::Invoice(invoice.clone()),
7816 Destination::BlindedPath(path.clone()),
7817 Some(reply_path.clone()),
7819 pending_offers_messages.push(message);
7825 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
7829 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
7832 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
7833 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
7835 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
7836 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
7837 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
7838 /// passed directly to [`claim_funds`].
7840 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
7842 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7843 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7847 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7848 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7850 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7852 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7853 /// on versions of LDK prior to 0.0.114.
7855 /// [`claim_funds`]: Self::claim_funds
7856 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7857 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
7858 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
7859 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
7860 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
7861 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
7862 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
7863 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
7864 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7865 min_final_cltv_expiry_delta)
7868 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
7869 /// stored external to LDK.
7871 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
7872 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
7873 /// the `min_value_msat` provided here, if one is provided.
7875 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
7876 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
7879 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
7880 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
7881 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
7882 /// sender "proof-of-payment" unless they have paid the required amount.
7884 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
7885 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
7886 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
7887 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
7888 /// invoices when no timeout is set.
7890 /// Note that we use block header time to time-out pending inbound payments (with some margin
7891 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
7892 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
7893 /// If you need exact expiry semantics, you should enforce them upon receipt of
7894 /// [`PaymentClaimable`].
7896 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
7897 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
7899 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7900 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7904 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7905 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7907 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7909 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7910 /// on versions of LDK prior to 0.0.114.
7912 /// [`create_inbound_payment`]: Self::create_inbound_payment
7913 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7914 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
7915 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
7916 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
7917 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7918 min_final_cltv_expiry)
7921 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
7922 /// previously returned from [`create_inbound_payment`].
7924 /// [`create_inbound_payment`]: Self::create_inbound_payment
7925 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
7926 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
7929 /// Creates a blinded path by delegating to [`MessageRouter::create_blinded_paths`].
7931 /// Errors if the `MessageRouter` errors or returns an empty `Vec`.
7932 fn create_blinded_path(&self) -> Result<BlindedPath, ()> {
7933 let recipient = self.get_our_node_id();
7934 let entropy_source = self.entropy_source.deref();
7935 let secp_ctx = &self.secp_ctx;
7937 let peers = self.per_peer_state.read().unwrap()
7939 .filter(|(_, peer)| peer.lock().unwrap().latest_features.supports_onion_messages())
7940 .map(|(node_id, _)| *node_id)
7941 .collect::<Vec<_>>();
7944 .create_blinded_paths(recipient, peers, entropy_source, secp_ctx)
7945 .and_then(|paths| paths.into_iter().next().ok_or(()))
7948 /// Creates multi-hop blinded payment paths for the given `amount_msats` by delegating to
7949 /// [`Router::create_blinded_payment_paths`].
7950 fn create_blinded_payment_paths(
7951 &self, amount_msats: u64, payment_secret: PaymentSecret
7952 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
7953 let entropy_source = self.entropy_source.deref();
7954 let secp_ctx = &self.secp_ctx;
7956 let first_hops = self.list_usable_channels();
7957 let payee_node_id = self.get_our_node_id();
7958 let max_cltv_expiry = self.best_block.read().unwrap().height() + CLTV_FAR_FAR_AWAY
7959 + LATENCY_GRACE_PERIOD_BLOCKS;
7960 let payee_tlvs = ReceiveTlvs {
7962 payment_constraints: PaymentConstraints {
7964 htlc_minimum_msat: 1,
7967 self.router.create_blinded_payment_paths(
7968 payee_node_id, first_hops, payee_tlvs, amount_msats, entropy_source, secp_ctx
7972 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
7973 /// are used when constructing the phantom invoice's route hints.
7975 /// [phantom node payments]: crate::sign::PhantomKeysManager
7976 pub fn get_phantom_scid(&self) -> u64 {
7977 let best_block_height = self.best_block.read().unwrap().height();
7978 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7980 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7981 // Ensure the generated scid doesn't conflict with a real channel.
7982 match short_to_chan_info.get(&scid_candidate) {
7983 Some(_) => continue,
7984 None => return scid_candidate
7989 /// Gets route hints for use in receiving [phantom node payments].
7991 /// [phantom node payments]: crate::sign::PhantomKeysManager
7992 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
7994 channels: self.list_usable_channels(),
7995 phantom_scid: self.get_phantom_scid(),
7996 real_node_pubkey: self.get_our_node_id(),
8000 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
8001 /// used when constructing the route hints for HTLCs intended to be intercepted. See
8002 /// [`ChannelManager::forward_intercepted_htlc`].
8004 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
8005 /// times to get a unique scid.
8006 pub fn get_intercept_scid(&self) -> u64 {
8007 let best_block_height = self.best_block.read().unwrap().height();
8008 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
8010 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
8011 // Ensure the generated scid doesn't conflict with a real channel.
8012 if short_to_chan_info.contains_key(&scid_candidate) { continue }
8013 return scid_candidate
8017 /// Gets inflight HTLC information by processing pending outbound payments that are in
8018 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
8019 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
8020 let mut inflight_htlcs = InFlightHtlcs::new();
8022 let per_peer_state = self.per_peer_state.read().unwrap();
8023 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8024 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8025 let peer_state = &mut *peer_state_lock;
8026 for chan in peer_state.channel_by_id.values().filter_map(
8027 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
8029 for (htlc_source, _) in chan.inflight_htlc_sources() {
8030 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
8031 inflight_htlcs.process_path(path, self.get_our_node_id());
8040 #[cfg(any(test, feature = "_test_utils"))]
8041 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
8042 let events = core::cell::RefCell::new(Vec::new());
8043 let event_handler = |event: events::Event| events.borrow_mut().push(event);
8044 self.process_pending_events(&event_handler);
8048 #[cfg(feature = "_test_utils")]
8049 pub fn push_pending_event(&self, event: events::Event) {
8050 let mut events = self.pending_events.lock().unwrap();
8051 events.push_back((event, None));
8055 pub fn pop_pending_event(&self) -> Option<events::Event> {
8056 let mut events = self.pending_events.lock().unwrap();
8057 events.pop_front().map(|(e, _)| e)
8061 pub fn has_pending_payments(&self) -> bool {
8062 self.pending_outbound_payments.has_pending_payments()
8066 pub fn clear_pending_payments(&self) {
8067 self.pending_outbound_payments.clear_pending_payments()
8070 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
8071 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
8072 /// operation. It will double-check that nothing *else* is also blocking the same channel from
8073 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
8074 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
8075 let logger = WithContext::from(
8076 &self.logger, Some(counterparty_node_id), Some(channel_funding_outpoint.to_channel_id())
8079 let per_peer_state = self.per_peer_state.read().unwrap();
8080 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
8081 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
8082 let peer_state = &mut *peer_state_lck;
8083 if let Some(blocker) = completed_blocker.take() {
8084 // Only do this on the first iteration of the loop.
8085 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
8086 .get_mut(&channel_funding_outpoint.to_channel_id())
8088 blockers.retain(|iter| iter != &blocker);
8092 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
8093 channel_funding_outpoint, counterparty_node_id) {
8094 // Check that, while holding the peer lock, we don't have anything else
8095 // blocking monitor updates for this channel. If we do, release the monitor
8096 // update(s) when those blockers complete.
8097 log_trace!(logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
8098 &channel_funding_outpoint.to_channel_id());
8102 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
8103 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
8104 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
8105 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
8106 log_debug!(logger, "Unlocking monitor updating for channel {} and updating monitor",
8107 channel_funding_outpoint.to_channel_id());
8108 handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
8109 peer_state_lck, peer_state, per_peer_state, chan);
8110 if further_update_exists {
8111 // If there are more `ChannelMonitorUpdate`s to process, restart at the
8116 log_trace!(logger, "Unlocked monitor updating for channel {} without monitors to update",
8117 channel_funding_outpoint.to_channel_id());
8123 "Got a release post-RAA monitor update for peer {} but the channel is gone",
8124 log_pubkey!(counterparty_node_id));
8130 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
8131 for action in actions {
8133 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
8134 channel_funding_outpoint, counterparty_node_id
8136 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
8142 /// Processes any events asynchronously in the order they were generated since the last call
8143 /// using the given event handler.
8145 /// See the trait-level documentation of [`EventsProvider`] for requirements.
8146 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
8150 process_events_body!(self, ev, { handler(ev).await });
8154 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>
8156 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8157 T::Target: BroadcasterInterface,
8158 ES::Target: EntropySource,
8159 NS::Target: NodeSigner,
8160 SP::Target: SignerProvider,
8161 F::Target: FeeEstimator,
8165 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
8166 /// The returned array will contain `MessageSendEvent`s for different peers if
8167 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
8168 /// is always placed next to each other.
8170 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
8171 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
8172 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
8173 /// will randomly be placed first or last in the returned array.
8175 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
8176 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
8177 /// the `MessageSendEvent`s to the specific peer they were generated under.
8178 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
8179 let events = RefCell::new(Vec::new());
8180 PersistenceNotifierGuard::optionally_notify(self, || {
8181 let mut result = NotifyOption::SkipPersistNoEvents;
8183 // TODO: This behavior should be documented. It's unintuitive that we query
8184 // ChannelMonitors when clearing other events.
8185 if self.process_pending_monitor_events() {
8186 result = NotifyOption::DoPersist;
8189 if self.check_free_holding_cells() {
8190 result = NotifyOption::DoPersist;
8192 if self.maybe_generate_initial_closing_signed() {
8193 result = NotifyOption::DoPersist;
8196 let mut pending_events = Vec::new();
8197 let per_peer_state = self.per_peer_state.read().unwrap();
8198 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8199 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8200 let peer_state = &mut *peer_state_lock;
8201 if peer_state.pending_msg_events.len() > 0 {
8202 pending_events.append(&mut peer_state.pending_msg_events);
8206 if !pending_events.is_empty() {
8207 events.replace(pending_events);
8216 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>
8218 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8219 T::Target: BroadcasterInterface,
8220 ES::Target: EntropySource,
8221 NS::Target: NodeSigner,
8222 SP::Target: SignerProvider,
8223 F::Target: FeeEstimator,
8227 /// Processes events that must be periodically handled.
8229 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
8230 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
8231 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
8233 process_events_body!(self, ev, handler.handle_event(ev));
8237 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>
8239 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8240 T::Target: BroadcasterInterface,
8241 ES::Target: EntropySource,
8242 NS::Target: NodeSigner,
8243 SP::Target: SignerProvider,
8244 F::Target: FeeEstimator,
8248 fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
8250 let best_block = self.best_block.read().unwrap();
8251 assert_eq!(best_block.block_hash(), header.prev_blockhash,
8252 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
8253 assert_eq!(best_block.height(), height - 1,
8254 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
8257 self.transactions_confirmed(header, txdata, height);
8258 self.best_block_updated(header, height);
8261 fn block_disconnected(&self, header: &Header, height: u32) {
8262 let _persistence_guard =
8263 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8264 self, || -> NotifyOption { NotifyOption::DoPersist });
8265 let new_height = height - 1;
8267 let mut best_block = self.best_block.write().unwrap();
8268 assert_eq!(best_block.block_hash(), header.block_hash(),
8269 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
8270 assert_eq!(best_block.height(), height,
8271 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
8272 *best_block = BestBlock::new(header.prev_blockhash, new_height)
8275 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)));
8279 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>
8281 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8282 T::Target: BroadcasterInterface,
8283 ES::Target: EntropySource,
8284 NS::Target: NodeSigner,
8285 SP::Target: SignerProvider,
8286 F::Target: FeeEstimator,
8290 fn transactions_confirmed(&self, header: &Header, txdata: &TransactionData, height: u32) {
8291 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8292 // during initialization prior to the chain_monitor being fully configured in some cases.
8293 // See the docs for `ChannelManagerReadArgs` for more.
8295 let block_hash = header.block_hash();
8296 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
8298 let _persistence_guard =
8299 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8300 self, || -> NotifyOption { NotifyOption::DoPersist });
8301 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))
8302 .map(|(a, b)| (a, Vec::new(), b)));
8304 let last_best_block_height = self.best_block.read().unwrap().height();
8305 if height < last_best_block_height {
8306 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
8307 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)));
8311 fn best_block_updated(&self, header: &Header, height: u32) {
8312 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8313 // during initialization prior to the chain_monitor being fully configured in some cases.
8314 // See the docs for `ChannelManagerReadArgs` for more.
8316 let block_hash = header.block_hash();
8317 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
8319 let _persistence_guard =
8320 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8321 self, || -> NotifyOption { NotifyOption::DoPersist });
8322 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
8324 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)));
8326 macro_rules! max_time {
8327 ($timestamp: expr) => {
8329 // Update $timestamp to be the max of its current value and the block
8330 // timestamp. This should keep us close to the current time without relying on
8331 // having an explicit local time source.
8332 // Just in case we end up in a race, we loop until we either successfully
8333 // update $timestamp or decide we don't need to.
8334 let old_serial = $timestamp.load(Ordering::Acquire);
8335 if old_serial >= header.time as usize { break; }
8336 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
8342 max_time!(self.highest_seen_timestamp);
8343 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
8344 payment_secrets.retain(|_, inbound_payment| {
8345 inbound_payment.expiry_time > header.time as u64
8349 fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
8350 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
8351 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
8352 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8353 let peer_state = &mut *peer_state_lock;
8354 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
8355 let txid_opt = chan.context.get_funding_txo();
8356 let height_opt = chan.context.get_funding_tx_confirmation_height();
8357 let hash_opt = chan.context.get_funding_tx_confirmed_in();
8358 if let (Some(funding_txo), Some(conf_height), Some(block_hash)) = (txid_opt, height_opt, hash_opt) {
8359 res.push((funding_txo.txid, conf_height, Some(block_hash)));
8366 fn transaction_unconfirmed(&self, txid: &Txid) {
8367 let _persistence_guard =
8368 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8369 self, || -> NotifyOption { NotifyOption::DoPersist });
8370 self.do_chain_event(None, |channel| {
8371 if let Some(funding_txo) = channel.context.get_funding_txo() {
8372 if funding_txo.txid == *txid {
8373 channel.funding_transaction_unconfirmed(&&WithChannelContext::from(&self.logger, &channel.context)).map(|()| (None, Vec::new(), None))
8374 } else { Ok((None, Vec::new(), None)) }
8375 } else { Ok((None, Vec::new(), None)) }
8380 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>
8382 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8383 T::Target: BroadcasterInterface,
8384 ES::Target: EntropySource,
8385 NS::Target: NodeSigner,
8386 SP::Target: SignerProvider,
8387 F::Target: FeeEstimator,
8391 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
8392 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
8394 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
8395 (&self, height_opt: Option<u32>, f: FN) {
8396 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8397 // during initialization prior to the chain_monitor being fully configured in some cases.
8398 // See the docs for `ChannelManagerReadArgs` for more.
8400 let mut failed_channels = Vec::new();
8401 let mut timed_out_htlcs = Vec::new();
8403 let per_peer_state = self.per_peer_state.read().unwrap();
8404 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8405 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8406 let peer_state = &mut *peer_state_lock;
8407 let pending_msg_events = &mut peer_state.pending_msg_events;
8408 peer_state.channel_by_id.retain(|_, phase| {
8410 // Retain unfunded channels.
8411 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
8412 ChannelPhase::Funded(channel) => {
8413 let res = f(channel);
8414 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
8415 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
8416 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
8417 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
8418 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
8420 let logger = WithChannelContext::from(&self.logger, &channel.context);
8421 if let Some(channel_ready) = channel_ready_opt {
8422 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
8423 if channel.context.is_usable() {
8424 log_trace!(logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
8425 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
8426 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
8427 node_id: channel.context.get_counterparty_node_id(),
8432 log_trace!(logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
8437 let mut pending_events = self.pending_events.lock().unwrap();
8438 emit_channel_ready_event!(pending_events, channel);
8441 if let Some(announcement_sigs) = announcement_sigs {
8442 log_trace!(logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
8443 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
8444 node_id: channel.context.get_counterparty_node_id(),
8445 msg: announcement_sigs,
8447 if let Some(height) = height_opt {
8448 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.chain_hash, height, &self.default_configuration) {
8449 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
8451 // Note that announcement_signatures fails if the channel cannot be announced,
8452 // so get_channel_update_for_broadcast will never fail by the time we get here.
8453 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
8458 if channel.is_our_channel_ready() {
8459 if let Some(real_scid) = channel.context.get_short_channel_id() {
8460 // If we sent a 0conf channel_ready, and now have an SCID, we add it
8461 // to the short_to_chan_info map here. Note that we check whether we
8462 // can relay using the real SCID at relay-time (i.e.
8463 // enforce option_scid_alias then), and if the funding tx is ever
8464 // un-confirmed we force-close the channel, ensuring short_to_chan_info
8465 // is always consistent.
8466 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
8467 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8468 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
8469 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
8470 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
8473 } else if let Err(reason) = res {
8474 update_maps_on_chan_removal!(self, &channel.context);
8475 // It looks like our counterparty went on-chain or funding transaction was
8476 // reorged out of the main chain. Close the channel.
8477 let reason_message = format!("{}", reason);
8478 failed_channels.push(channel.context.force_shutdown(true, reason));
8479 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
8480 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
8484 pending_msg_events.push(events::MessageSendEvent::HandleError {
8485 node_id: channel.context.get_counterparty_node_id(),
8486 action: msgs::ErrorAction::DisconnectPeer {
8487 msg: Some(msgs::ErrorMessage {
8488 channel_id: channel.context.channel_id(),
8489 data: reason_message,
8502 if let Some(height) = height_opt {
8503 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
8504 payment.htlcs.retain(|htlc| {
8505 // If height is approaching the number of blocks we think it takes us to get
8506 // our commitment transaction confirmed before the HTLC expires, plus the
8507 // number of blocks we generally consider it to take to do a commitment update,
8508 // just give up on it and fail the HTLC.
8509 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
8510 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
8511 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
8513 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
8514 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
8515 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
8519 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
8522 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
8523 intercepted_htlcs.retain(|_, htlc| {
8524 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
8525 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
8526 short_channel_id: htlc.prev_short_channel_id,
8527 user_channel_id: Some(htlc.prev_user_channel_id),
8528 htlc_id: htlc.prev_htlc_id,
8529 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
8530 phantom_shared_secret: None,
8531 outpoint: htlc.prev_funding_outpoint,
8532 blinded_failure: htlc.forward_info.routing.blinded_failure(),
8535 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
8536 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
8537 _ => unreachable!(),
8539 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
8540 HTLCFailReason::from_failure_code(0x2000 | 2),
8541 HTLCDestination::InvalidForward { requested_forward_scid }));
8542 let logger = WithContext::from(
8543 &self.logger, None, Some(htlc.prev_funding_outpoint.to_channel_id())
8545 log_trace!(logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
8551 self.handle_init_event_channel_failures(failed_channels);
8553 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
8554 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
8558 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
8559 /// may have events that need processing.
8561 /// In order to check if this [`ChannelManager`] needs persisting, call
8562 /// [`Self::get_and_clear_needs_persistence`].
8564 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
8565 /// [`ChannelManager`] and should instead register actions to be taken later.
8566 pub fn get_event_or_persistence_needed_future(&self) -> Future {
8567 self.event_persist_notifier.get_future()
8570 /// Returns true if this [`ChannelManager`] needs to be persisted.
8571 pub fn get_and_clear_needs_persistence(&self) -> bool {
8572 self.needs_persist_flag.swap(false, Ordering::AcqRel)
8575 #[cfg(any(test, feature = "_test_utils"))]
8576 pub fn get_event_or_persist_condvar_value(&self) -> bool {
8577 self.event_persist_notifier.notify_pending()
8580 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
8581 /// [`chain::Confirm`] interfaces.
8582 pub fn current_best_block(&self) -> BestBlock {
8583 self.best_block.read().unwrap().clone()
8586 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
8587 /// [`ChannelManager`].
8588 pub fn node_features(&self) -> NodeFeatures {
8589 provided_node_features(&self.default_configuration)
8592 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
8593 /// [`ChannelManager`].
8595 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8596 /// or not. Thus, this method is not public.
8597 #[cfg(any(feature = "_test_utils", test))]
8598 pub fn bolt11_invoice_features(&self) -> Bolt11InvoiceFeatures {
8599 provided_bolt11_invoice_features(&self.default_configuration)
8602 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
8603 /// [`ChannelManager`].
8604 fn bolt12_invoice_features(&self) -> Bolt12InvoiceFeatures {
8605 provided_bolt12_invoice_features(&self.default_configuration)
8608 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
8609 /// [`ChannelManager`].
8610 pub fn channel_features(&self) -> ChannelFeatures {
8611 provided_channel_features(&self.default_configuration)
8614 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
8615 /// [`ChannelManager`].
8616 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
8617 provided_channel_type_features(&self.default_configuration)
8620 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
8621 /// [`ChannelManager`].
8622 pub fn init_features(&self) -> InitFeatures {
8623 provided_init_features(&self.default_configuration)
8627 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8628 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
8630 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8631 T::Target: BroadcasterInterface,
8632 ES::Target: EntropySource,
8633 NS::Target: NodeSigner,
8634 SP::Target: SignerProvider,
8635 F::Target: FeeEstimator,
8639 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
8640 // Note that we never need to persist the updated ChannelManager for an inbound
8641 // open_channel message - pre-funded channels are never written so there should be no
8642 // change to the contents.
8643 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8644 let res = self.internal_open_channel(counterparty_node_id, msg);
8645 let persist = match &res {
8646 Err(e) if e.closes_channel() => {
8647 debug_assert!(false, "We shouldn't close a new channel");
8648 NotifyOption::DoPersist
8650 _ => NotifyOption::SkipPersistHandleEvents,
8652 let _ = handle_error!(self, res, *counterparty_node_id);
8657 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
8658 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8659 "Dual-funded channels not supported".to_owned(),
8660 msg.temporary_channel_id.clone())), *counterparty_node_id);
8663 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
8664 // Note that we never need to persist the updated ChannelManager for an inbound
8665 // accept_channel message - pre-funded channels are never written so there should be no
8666 // change to the contents.
8667 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8668 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
8669 NotifyOption::SkipPersistHandleEvents
8673 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
8674 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8675 "Dual-funded channels not supported".to_owned(),
8676 msg.temporary_channel_id.clone())), *counterparty_node_id);
8679 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
8680 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8681 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
8684 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
8685 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8686 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
8689 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
8690 // Note that we never need to persist the updated ChannelManager for an inbound
8691 // channel_ready message - while the channel's state will change, any channel_ready message
8692 // will ultimately be re-sent on startup and the `ChannelMonitor` won't be updated so we
8693 // will not force-close the channel on startup.
8694 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8695 let res = self.internal_channel_ready(counterparty_node_id, msg);
8696 let persist = match &res {
8697 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8698 _ => NotifyOption::SkipPersistHandleEvents,
8700 let _ = handle_error!(self, res, *counterparty_node_id);
8705 fn handle_stfu(&self, counterparty_node_id: &PublicKey, msg: &msgs::Stfu) {
8706 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8707 "Quiescence not supported".to_owned(),
8708 msg.channel_id.clone())), *counterparty_node_id);
8711 fn handle_splice(&self, counterparty_node_id: &PublicKey, msg: &msgs::Splice) {
8712 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8713 "Splicing not supported".to_owned(),
8714 msg.channel_id.clone())), *counterparty_node_id);
8717 fn handle_splice_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceAck) {
8718 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8719 "Splicing not supported (splice_ack)".to_owned(),
8720 msg.channel_id.clone())), *counterparty_node_id);
8723 fn handle_splice_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
8724 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8725 "Splicing not supported (splice_locked)".to_owned(),
8726 msg.channel_id.clone())), *counterparty_node_id);
8729 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
8730 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8731 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
8734 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
8735 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8736 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
8739 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
8740 // Note that we never need to persist the updated ChannelManager for an inbound
8741 // update_add_htlc message - the message itself doesn't change our channel state only the
8742 // `commitment_signed` message afterwards will.
8743 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8744 let res = self.internal_update_add_htlc(counterparty_node_id, msg);
8745 let persist = match &res {
8746 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8747 Err(_) => NotifyOption::SkipPersistHandleEvents,
8748 Ok(()) => NotifyOption::SkipPersistNoEvents,
8750 let _ = handle_error!(self, res, *counterparty_node_id);
8755 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
8756 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8757 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
8760 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
8761 // Note that we never need to persist the updated ChannelManager for an inbound
8762 // update_fail_htlc message - the message itself doesn't change our channel state only the
8763 // `commitment_signed` message afterwards will.
8764 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8765 let res = self.internal_update_fail_htlc(counterparty_node_id, msg);
8766 let persist = match &res {
8767 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8768 Err(_) => NotifyOption::SkipPersistHandleEvents,
8769 Ok(()) => NotifyOption::SkipPersistNoEvents,
8771 let _ = handle_error!(self, res, *counterparty_node_id);
8776 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
8777 // Note that we never need to persist the updated ChannelManager for an inbound
8778 // update_fail_malformed_htlc message - the message itself doesn't change our channel state
8779 // only the `commitment_signed` message afterwards will.
8780 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8781 let res = self.internal_update_fail_malformed_htlc(counterparty_node_id, msg);
8782 let persist = match &res {
8783 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8784 Err(_) => NotifyOption::SkipPersistHandleEvents,
8785 Ok(()) => NotifyOption::SkipPersistNoEvents,
8787 let _ = handle_error!(self, res, *counterparty_node_id);
8792 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
8793 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8794 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
8797 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
8798 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8799 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
8802 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
8803 // Note that we never need to persist the updated ChannelManager for an inbound
8804 // update_fee message - the message itself doesn't change our channel state only the
8805 // `commitment_signed` message afterwards will.
8806 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8807 let res = self.internal_update_fee(counterparty_node_id, msg);
8808 let persist = match &res {
8809 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8810 Err(_) => NotifyOption::SkipPersistHandleEvents,
8811 Ok(()) => NotifyOption::SkipPersistNoEvents,
8813 let _ = handle_error!(self, res, *counterparty_node_id);
8818 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
8819 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8820 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
8823 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
8824 PersistenceNotifierGuard::optionally_notify(self, || {
8825 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
8828 NotifyOption::DoPersist
8833 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
8834 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8835 let res = self.internal_channel_reestablish(counterparty_node_id, msg);
8836 let persist = match &res {
8837 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8838 Err(_) => NotifyOption::SkipPersistHandleEvents,
8839 Ok(persist) => *persist,
8841 let _ = handle_error!(self, res, *counterparty_node_id);
8846 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
8847 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(
8848 self, || NotifyOption::SkipPersistHandleEvents);
8849 let mut failed_channels = Vec::new();
8850 let mut per_peer_state = self.per_peer_state.write().unwrap();
8853 WithContext::from(&self.logger, Some(*counterparty_node_id), None),
8854 "Marking channels with {} disconnected and generating channel_updates.",
8855 log_pubkey!(counterparty_node_id)
8857 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8858 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8859 let peer_state = &mut *peer_state_lock;
8860 let pending_msg_events = &mut peer_state.pending_msg_events;
8861 peer_state.channel_by_id.retain(|_, phase| {
8862 let context = match phase {
8863 ChannelPhase::Funded(chan) => {
8864 let logger = WithChannelContext::from(&self.logger, &chan.context);
8865 if chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok() {
8866 // We only retain funded channels that are not shutdown.
8871 // Unfunded channels will always be removed.
8872 ChannelPhase::UnfundedOutboundV1(chan) => {
8875 ChannelPhase::UnfundedInboundV1(chan) => {
8879 // Clean up for removal.
8880 update_maps_on_chan_removal!(self, &context);
8881 failed_channels.push(context.force_shutdown(false, ClosureReason::DisconnectedPeer));
8884 // Note that we don't bother generating any events for pre-accept channels -
8885 // they're not considered "channels" yet from the PoV of our events interface.
8886 peer_state.inbound_channel_request_by_id.clear();
8887 pending_msg_events.retain(|msg| {
8889 // V1 Channel Establishment
8890 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
8891 &events::MessageSendEvent::SendOpenChannel { .. } => false,
8892 &events::MessageSendEvent::SendFundingCreated { .. } => false,
8893 &events::MessageSendEvent::SendFundingSigned { .. } => false,
8894 // V2 Channel Establishment
8895 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
8896 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
8897 // Common Channel Establishment
8898 &events::MessageSendEvent::SendChannelReady { .. } => false,
8899 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
8901 &events::MessageSendEvent::SendStfu { .. } => false,
8903 &events::MessageSendEvent::SendSplice { .. } => false,
8904 &events::MessageSendEvent::SendSpliceAck { .. } => false,
8905 &events::MessageSendEvent::SendSpliceLocked { .. } => false,
8906 // Interactive Transaction Construction
8907 &events::MessageSendEvent::SendTxAddInput { .. } => false,
8908 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
8909 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
8910 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
8911 &events::MessageSendEvent::SendTxComplete { .. } => false,
8912 &events::MessageSendEvent::SendTxSignatures { .. } => false,
8913 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
8914 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
8915 &events::MessageSendEvent::SendTxAbort { .. } => false,
8916 // Channel Operations
8917 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
8918 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
8919 &events::MessageSendEvent::SendClosingSigned { .. } => false,
8920 &events::MessageSendEvent::SendShutdown { .. } => false,
8921 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
8922 &events::MessageSendEvent::HandleError { .. } => false,
8924 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
8925 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
8926 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
8927 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
8928 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
8929 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
8930 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
8931 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
8932 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
8935 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
8936 peer_state.is_connected = false;
8937 peer_state.ok_to_remove(true)
8938 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
8941 per_peer_state.remove(counterparty_node_id);
8943 mem::drop(per_peer_state);
8945 for failure in failed_channels.drain(..) {
8946 self.finish_close_channel(failure);
8950 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
8951 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), None);
8952 if !init_msg.features.supports_static_remote_key() {
8953 log_debug!(logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
8957 let mut res = Ok(());
8959 PersistenceNotifierGuard::optionally_notify(self, || {
8960 // If we have too many peers connected which don't have funded channels, disconnect the
8961 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
8962 // unfunded channels taking up space in memory for disconnected peers, we still let new
8963 // peers connect, but we'll reject new channels from them.
8964 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
8965 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
8968 let mut peer_state_lock = self.per_peer_state.write().unwrap();
8969 match peer_state_lock.entry(counterparty_node_id.clone()) {
8970 hash_map::Entry::Vacant(e) => {
8971 if inbound_peer_limited {
8973 return NotifyOption::SkipPersistNoEvents;
8975 e.insert(Mutex::new(PeerState {
8976 channel_by_id: HashMap::new(),
8977 inbound_channel_request_by_id: HashMap::new(),
8978 latest_features: init_msg.features.clone(),
8979 pending_msg_events: Vec::new(),
8980 in_flight_monitor_updates: BTreeMap::new(),
8981 monitor_update_blocked_actions: BTreeMap::new(),
8982 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8986 hash_map::Entry::Occupied(e) => {
8987 let mut peer_state = e.get().lock().unwrap();
8988 peer_state.latest_features = init_msg.features.clone();
8990 let best_block_height = self.best_block.read().unwrap().height();
8991 if inbound_peer_limited &&
8992 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
8993 peer_state.channel_by_id.len()
8996 return NotifyOption::SkipPersistNoEvents;
8999 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
9000 peer_state.is_connected = true;
9005 log_debug!(logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
9007 let per_peer_state = self.per_peer_state.read().unwrap();
9008 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
9009 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9010 let peer_state = &mut *peer_state_lock;
9011 let pending_msg_events = &mut peer_state.pending_msg_events;
9013 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
9014 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
9016 let logger = WithChannelContext::from(&self.logger, &chan.context);
9017 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
9018 node_id: chan.context.get_counterparty_node_id(),
9019 msg: chan.get_channel_reestablish(&&logger),
9024 return NotifyOption::SkipPersistHandleEvents;
9025 //TODO: Also re-broadcast announcement_signatures
9030 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
9031 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
9033 match &msg.data as &str {
9034 "cannot co-op close channel w/ active htlcs"|
9035 "link failed to shutdown" =>
9037 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
9038 // send one while HTLCs are still present. The issue is tracked at
9039 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
9040 // to fix it but none so far have managed to land upstream. The issue appears to be
9041 // very low priority for the LND team despite being marked "P1".
9042 // We're not going to bother handling this in a sensible way, instead simply
9043 // repeating the Shutdown message on repeat until morale improves.
9044 if !msg.channel_id.is_zero() {
9045 let per_peer_state = self.per_peer_state.read().unwrap();
9046 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9047 if peer_state_mutex_opt.is_none() { return; }
9048 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
9049 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
9050 if let Some(msg) = chan.get_outbound_shutdown() {
9051 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
9052 node_id: *counterparty_node_id,
9056 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
9057 node_id: *counterparty_node_id,
9058 action: msgs::ErrorAction::SendWarningMessage {
9059 msg: msgs::WarningMessage {
9060 channel_id: msg.channel_id,
9061 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
9063 log_level: Level::Trace,
9073 if msg.channel_id.is_zero() {
9074 let channel_ids: Vec<ChannelId> = {
9075 let per_peer_state = self.per_peer_state.read().unwrap();
9076 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9077 if peer_state_mutex_opt.is_none() { return; }
9078 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
9079 let peer_state = &mut *peer_state_lock;
9080 // Note that we don't bother generating any events for pre-accept channels -
9081 // they're not considered "channels" yet from the PoV of our events interface.
9082 peer_state.inbound_channel_request_by_id.clear();
9083 peer_state.channel_by_id.keys().cloned().collect()
9085 for channel_id in channel_ids {
9086 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
9087 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
9091 // First check if we can advance the channel type and try again.
9092 let per_peer_state = self.per_peer_state.read().unwrap();
9093 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9094 if peer_state_mutex_opt.is_none() { return; }
9095 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
9096 let peer_state = &mut *peer_state_lock;
9097 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
9098 if let Ok(msg) = chan.maybe_handle_error_without_close(self.chain_hash, &self.fee_estimator) {
9099 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
9100 node_id: *counterparty_node_id,
9108 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
9109 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
9113 fn provided_node_features(&self) -> NodeFeatures {
9114 provided_node_features(&self.default_configuration)
9117 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
9118 provided_init_features(&self.default_configuration)
9121 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
9122 Some(vec![self.chain_hash])
9125 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
9126 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9127 "Dual-funded channels not supported".to_owned(),
9128 msg.channel_id.clone())), *counterparty_node_id);
9131 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
9132 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9133 "Dual-funded channels not supported".to_owned(),
9134 msg.channel_id.clone())), *counterparty_node_id);
9137 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
9138 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9139 "Dual-funded channels not supported".to_owned(),
9140 msg.channel_id.clone())), *counterparty_node_id);
9143 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
9144 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9145 "Dual-funded channels not supported".to_owned(),
9146 msg.channel_id.clone())), *counterparty_node_id);
9149 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
9150 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9151 "Dual-funded channels not supported".to_owned(),
9152 msg.channel_id.clone())), *counterparty_node_id);
9155 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
9156 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9157 "Dual-funded channels not supported".to_owned(),
9158 msg.channel_id.clone())), *counterparty_node_id);
9161 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
9162 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9163 "Dual-funded channels not supported".to_owned(),
9164 msg.channel_id.clone())), *counterparty_node_id);
9167 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
9168 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9169 "Dual-funded channels not supported".to_owned(),
9170 msg.channel_id.clone())), *counterparty_node_id);
9173 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
9174 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9175 "Dual-funded channels not supported".to_owned(),
9176 msg.channel_id.clone())), *counterparty_node_id);
9180 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9181 OffersMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
9183 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9184 T::Target: BroadcasterInterface,
9185 ES::Target: EntropySource,
9186 NS::Target: NodeSigner,
9187 SP::Target: SignerProvider,
9188 F::Target: FeeEstimator,
9192 fn handle_message(&self, message: OffersMessage) -> Option<OffersMessage> {
9193 let secp_ctx = &self.secp_ctx;
9194 let expanded_key = &self.inbound_payment_key;
9197 OffersMessage::InvoiceRequest(invoice_request) => {
9198 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
9201 Ok(amount_msats) => amount_msats,
9202 Err(error) => return Some(OffersMessage::InvoiceError(error.into())),
9204 let invoice_request = match invoice_request.verify(expanded_key, secp_ctx) {
9205 Ok(invoice_request) => invoice_request,
9207 let error = Bolt12SemanticError::InvalidMetadata;
9208 return Some(OffersMessage::InvoiceError(error.into()));
9212 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
9213 let (payment_hash, payment_secret) = match self.create_inbound_payment(
9214 Some(amount_msats), relative_expiry, None
9216 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
9218 let error = Bolt12SemanticError::InvalidAmount;
9219 return Some(OffersMessage::InvoiceError(error.into()));
9223 let payment_paths = match self.create_blinded_payment_paths(
9224 amount_msats, payment_secret
9226 Ok(payment_paths) => payment_paths,
9228 let error = Bolt12SemanticError::MissingPaths;
9229 return Some(OffersMessage::InvoiceError(error.into()));
9233 #[cfg(feature = "no-std")]
9234 let created_at = Duration::from_secs(
9235 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9238 if invoice_request.keys.is_some() {
9239 #[cfg(not(feature = "no-std"))]
9240 let builder = invoice_request.respond_using_derived_keys(
9241 payment_paths, payment_hash
9243 #[cfg(feature = "no-std")]
9244 let builder = invoice_request.respond_using_derived_keys_no_std(
9245 payment_paths, payment_hash, created_at
9247 match builder.and_then(|b| b.allow_mpp().build_and_sign(secp_ctx)) {
9248 Ok(invoice) => Some(OffersMessage::Invoice(invoice)),
9249 Err(error) => Some(OffersMessage::InvoiceError(error.into())),
9252 #[cfg(not(feature = "no-std"))]
9253 let builder = invoice_request.respond_with(payment_paths, payment_hash);
9254 #[cfg(feature = "no-std")]
9255 let builder = invoice_request.respond_with_no_std(
9256 payment_paths, payment_hash, created_at
9258 let response = builder.and_then(|builder| builder.allow_mpp().build())
9259 .map_err(|e| OffersMessage::InvoiceError(e.into()))
9261 match invoice.sign(|invoice| self.node_signer.sign_bolt12_invoice(invoice)) {
9262 Ok(invoice) => Ok(OffersMessage::Invoice(invoice)),
9263 Err(SignError::Signing(())) => Err(OffersMessage::InvoiceError(
9264 InvoiceError::from_string("Failed signing invoice".to_string())
9266 Err(SignError::Verification(_)) => Err(OffersMessage::InvoiceError(
9267 InvoiceError::from_string("Failed invoice signature verification".to_string())
9271 Ok(invoice) => Some(invoice),
9272 Err(error) => Some(error),
9276 OffersMessage::Invoice(invoice) => {
9277 match invoice.verify(expanded_key, secp_ctx) {
9279 Some(OffersMessage::InvoiceError(InvoiceError::from_string("Unrecognized invoice".to_owned())))
9281 Ok(_) if invoice.invoice_features().requires_unknown_bits_from(&self.bolt12_invoice_features()) => {
9282 Some(OffersMessage::InvoiceError(Bolt12SemanticError::UnknownRequiredFeatures.into()))
9285 if let Err(e) = self.send_payment_for_bolt12_invoice(&invoice, payment_id) {
9286 log_trace!(self.logger, "Failed paying invoice: {:?}", e);
9287 Some(OffersMessage::InvoiceError(InvoiceError::from_string(format!("{:?}", e))))
9294 OffersMessage::InvoiceError(invoice_error) => {
9295 log_trace!(self.logger, "Received invoice_error: {}", invoice_error);
9301 fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> {
9302 core::mem::take(&mut self.pending_offers_messages.lock().unwrap())
9306 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
9307 /// [`ChannelManager`].
9308 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
9309 let mut node_features = provided_init_features(config).to_context();
9310 node_features.set_keysend_optional();
9314 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
9315 /// [`ChannelManager`].
9317 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
9318 /// or not. Thus, this method is not public.
9319 #[cfg(any(feature = "_test_utils", test))]
9320 pub(crate) fn provided_bolt11_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
9321 provided_init_features(config).to_context()
9324 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
9325 /// [`ChannelManager`].
9326 pub(crate) fn provided_bolt12_invoice_features(config: &UserConfig) -> Bolt12InvoiceFeatures {
9327 provided_init_features(config).to_context()
9330 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
9331 /// [`ChannelManager`].
9332 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
9333 provided_init_features(config).to_context()
9336 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
9337 /// [`ChannelManager`].
9338 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
9339 ChannelTypeFeatures::from_init(&provided_init_features(config))
9342 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
9343 /// [`ChannelManager`].
9344 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
9345 // Note that if new features are added here which other peers may (eventually) require, we
9346 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
9347 // [`ErroringMessageHandler`].
9348 let mut features = InitFeatures::empty();
9349 features.set_data_loss_protect_required();
9350 features.set_upfront_shutdown_script_optional();
9351 features.set_variable_length_onion_required();
9352 features.set_static_remote_key_required();
9353 features.set_payment_secret_required();
9354 features.set_basic_mpp_optional();
9355 features.set_wumbo_optional();
9356 features.set_shutdown_any_segwit_optional();
9357 features.set_channel_type_optional();
9358 features.set_scid_privacy_optional();
9359 features.set_zero_conf_optional();
9360 features.set_route_blinding_optional();
9361 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
9362 features.set_anchors_zero_fee_htlc_tx_optional();
9367 const SERIALIZATION_VERSION: u8 = 1;
9368 const MIN_SERIALIZATION_VERSION: u8 = 1;
9370 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
9371 (2, fee_base_msat, required),
9372 (4, fee_proportional_millionths, required),
9373 (6, cltv_expiry_delta, required),
9376 impl_writeable_tlv_based!(ChannelCounterparty, {
9377 (2, node_id, required),
9378 (4, features, required),
9379 (6, unspendable_punishment_reserve, required),
9380 (8, forwarding_info, option),
9381 (9, outbound_htlc_minimum_msat, option),
9382 (11, outbound_htlc_maximum_msat, option),
9385 impl Writeable for ChannelDetails {
9386 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9387 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9388 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9389 let user_channel_id_low = self.user_channel_id as u64;
9390 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
9391 write_tlv_fields!(writer, {
9392 (1, self.inbound_scid_alias, option),
9393 (2, self.channel_id, required),
9394 (3, self.channel_type, option),
9395 (4, self.counterparty, required),
9396 (5, self.outbound_scid_alias, option),
9397 (6, self.funding_txo, option),
9398 (7, self.config, option),
9399 (8, self.short_channel_id, option),
9400 (9, self.confirmations, option),
9401 (10, self.channel_value_satoshis, required),
9402 (12, self.unspendable_punishment_reserve, option),
9403 (14, user_channel_id_low, required),
9404 (16, self.balance_msat, required),
9405 (18, self.outbound_capacity_msat, required),
9406 (19, self.next_outbound_htlc_limit_msat, required),
9407 (20, self.inbound_capacity_msat, required),
9408 (21, self.next_outbound_htlc_minimum_msat, required),
9409 (22, self.confirmations_required, option),
9410 (24, self.force_close_spend_delay, option),
9411 (26, self.is_outbound, required),
9412 (28, self.is_channel_ready, required),
9413 (30, self.is_usable, required),
9414 (32, self.is_public, required),
9415 (33, self.inbound_htlc_minimum_msat, option),
9416 (35, self.inbound_htlc_maximum_msat, option),
9417 (37, user_channel_id_high_opt, option),
9418 (39, self.feerate_sat_per_1000_weight, option),
9419 (41, self.channel_shutdown_state, option),
9425 impl Readable for ChannelDetails {
9426 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9427 _init_and_read_len_prefixed_tlv_fields!(reader, {
9428 (1, inbound_scid_alias, option),
9429 (2, channel_id, required),
9430 (3, channel_type, option),
9431 (4, counterparty, required),
9432 (5, outbound_scid_alias, option),
9433 (6, funding_txo, option),
9434 (7, config, option),
9435 (8, short_channel_id, option),
9436 (9, confirmations, option),
9437 (10, channel_value_satoshis, required),
9438 (12, unspendable_punishment_reserve, option),
9439 (14, user_channel_id_low, required),
9440 (16, balance_msat, required),
9441 (18, outbound_capacity_msat, required),
9442 // Note that by the time we get past the required read above, outbound_capacity_msat will be
9443 // filled in, so we can safely unwrap it here.
9444 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
9445 (20, inbound_capacity_msat, required),
9446 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
9447 (22, confirmations_required, option),
9448 (24, force_close_spend_delay, option),
9449 (26, is_outbound, required),
9450 (28, is_channel_ready, required),
9451 (30, is_usable, required),
9452 (32, is_public, required),
9453 (33, inbound_htlc_minimum_msat, option),
9454 (35, inbound_htlc_maximum_msat, option),
9455 (37, user_channel_id_high_opt, option),
9456 (39, feerate_sat_per_1000_weight, option),
9457 (41, channel_shutdown_state, option),
9460 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9461 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9462 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
9463 let user_channel_id = user_channel_id_low as u128 +
9464 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
9468 channel_id: channel_id.0.unwrap(),
9470 counterparty: counterparty.0.unwrap(),
9471 outbound_scid_alias,
9475 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
9476 unspendable_punishment_reserve,
9478 balance_msat: balance_msat.0.unwrap(),
9479 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
9480 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
9481 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
9482 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
9483 confirmations_required,
9485 force_close_spend_delay,
9486 is_outbound: is_outbound.0.unwrap(),
9487 is_channel_ready: is_channel_ready.0.unwrap(),
9488 is_usable: is_usable.0.unwrap(),
9489 is_public: is_public.0.unwrap(),
9490 inbound_htlc_minimum_msat,
9491 inbound_htlc_maximum_msat,
9492 feerate_sat_per_1000_weight,
9493 channel_shutdown_state,
9498 impl_writeable_tlv_based!(PhantomRouteHints, {
9499 (2, channels, required_vec),
9500 (4, phantom_scid, required),
9501 (6, real_node_pubkey, required),
9504 impl_writeable_tlv_based!(BlindedForward, {
9505 (0, inbound_blinding_point, required),
9506 (1, failure, (default_value, BlindedFailure::FromIntroductionNode)),
9509 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
9511 (0, onion_packet, required),
9512 (1, blinded, option),
9513 (2, short_channel_id, required),
9516 (0, payment_data, required),
9517 (1, phantom_shared_secret, option),
9518 (2, incoming_cltv_expiry, required),
9519 (3, payment_metadata, option),
9520 (5, custom_tlvs, optional_vec),
9521 (7, requires_blinded_error, (default_value, false)),
9523 (2, ReceiveKeysend) => {
9524 (0, payment_preimage, required),
9525 (2, incoming_cltv_expiry, required),
9526 (3, payment_metadata, option),
9527 (4, payment_data, option), // Added in 0.0.116
9528 (5, custom_tlvs, optional_vec),
9532 impl_writeable_tlv_based!(PendingHTLCInfo, {
9533 (0, routing, required),
9534 (2, incoming_shared_secret, required),
9535 (4, payment_hash, required),
9536 (6, outgoing_amt_msat, required),
9537 (8, outgoing_cltv_value, required),
9538 (9, incoming_amt_msat, option),
9539 (10, skimmed_fee_msat, option),
9543 impl Writeable for HTLCFailureMsg {
9544 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9546 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
9548 channel_id.write(writer)?;
9549 htlc_id.write(writer)?;
9550 reason.write(writer)?;
9552 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9553 channel_id, htlc_id, sha256_of_onion, failure_code
9556 channel_id.write(writer)?;
9557 htlc_id.write(writer)?;
9558 sha256_of_onion.write(writer)?;
9559 failure_code.write(writer)?;
9566 impl Readable for HTLCFailureMsg {
9567 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9568 let id: u8 = Readable::read(reader)?;
9571 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
9572 channel_id: Readable::read(reader)?,
9573 htlc_id: Readable::read(reader)?,
9574 reason: Readable::read(reader)?,
9578 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9579 channel_id: Readable::read(reader)?,
9580 htlc_id: Readable::read(reader)?,
9581 sha256_of_onion: Readable::read(reader)?,
9582 failure_code: Readable::read(reader)?,
9585 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
9586 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
9587 // messages contained in the variants.
9588 // In version 0.0.101, support for reading the variants with these types was added, and
9589 // we should migrate to writing these variants when UpdateFailHTLC or
9590 // UpdateFailMalformedHTLC get TLV fields.
9592 let length: BigSize = Readable::read(reader)?;
9593 let mut s = FixedLengthReader::new(reader, length.0);
9594 let res = Readable::read(&mut s)?;
9595 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9596 Ok(HTLCFailureMsg::Relay(res))
9599 let length: BigSize = Readable::read(reader)?;
9600 let mut s = FixedLengthReader::new(reader, length.0);
9601 let res = Readable::read(&mut s)?;
9602 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9603 Ok(HTLCFailureMsg::Malformed(res))
9605 _ => Err(DecodeError::UnknownRequiredFeature),
9610 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
9615 impl_writeable_tlv_based_enum!(BlindedFailure,
9616 (0, FromIntroductionNode) => {},
9617 (2, FromBlindedNode) => {}, ;
9620 impl_writeable_tlv_based!(HTLCPreviousHopData, {
9621 (0, short_channel_id, required),
9622 (1, phantom_shared_secret, option),
9623 (2, outpoint, required),
9624 (3, blinded_failure, option),
9625 (4, htlc_id, required),
9626 (6, incoming_packet_shared_secret, required),
9627 (7, user_channel_id, option),
9630 impl Writeable for ClaimableHTLC {
9631 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9632 let (payment_data, keysend_preimage) = match &self.onion_payload {
9633 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
9634 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
9636 write_tlv_fields!(writer, {
9637 (0, self.prev_hop, required),
9638 (1, self.total_msat, required),
9639 (2, self.value, required),
9640 (3, self.sender_intended_value, required),
9641 (4, payment_data, option),
9642 (5, self.total_value_received, option),
9643 (6, self.cltv_expiry, required),
9644 (8, keysend_preimage, option),
9645 (10, self.counterparty_skimmed_fee_msat, option),
9651 impl Readable for ClaimableHTLC {
9652 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9653 _init_and_read_len_prefixed_tlv_fields!(reader, {
9654 (0, prev_hop, required),
9655 (1, total_msat, option),
9656 (2, value_ser, required),
9657 (3, sender_intended_value, option),
9658 (4, payment_data_opt, option),
9659 (5, total_value_received, option),
9660 (6, cltv_expiry, required),
9661 (8, keysend_preimage, option),
9662 (10, counterparty_skimmed_fee_msat, option),
9664 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
9665 let value = value_ser.0.unwrap();
9666 let onion_payload = match keysend_preimage {
9668 if payment_data.is_some() {
9669 return Err(DecodeError::InvalidValue)
9671 if total_msat.is_none() {
9672 total_msat = Some(value);
9674 OnionPayload::Spontaneous(p)
9677 if total_msat.is_none() {
9678 if payment_data.is_none() {
9679 return Err(DecodeError::InvalidValue)
9681 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
9683 OnionPayload::Invoice { _legacy_hop_data: payment_data }
9687 prev_hop: prev_hop.0.unwrap(),
9690 sender_intended_value: sender_intended_value.unwrap_or(value),
9691 total_value_received,
9692 total_msat: total_msat.unwrap(),
9694 cltv_expiry: cltv_expiry.0.unwrap(),
9695 counterparty_skimmed_fee_msat,
9700 impl Readable for HTLCSource {
9701 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9702 let id: u8 = Readable::read(reader)?;
9705 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
9706 let mut first_hop_htlc_msat: u64 = 0;
9707 let mut path_hops = Vec::new();
9708 let mut payment_id = None;
9709 let mut payment_params: Option<PaymentParameters> = None;
9710 let mut blinded_tail: Option<BlindedTail> = None;
9711 read_tlv_fields!(reader, {
9712 (0, session_priv, required),
9713 (1, payment_id, option),
9714 (2, first_hop_htlc_msat, required),
9715 (4, path_hops, required_vec),
9716 (5, payment_params, (option: ReadableArgs, 0)),
9717 (6, blinded_tail, option),
9719 if payment_id.is_none() {
9720 // For backwards compat, if there was no payment_id written, use the session_priv bytes
9722 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
9724 let path = Path { hops: path_hops, blinded_tail };
9725 if path.hops.len() == 0 {
9726 return Err(DecodeError::InvalidValue);
9728 if let Some(params) = payment_params.as_mut() {
9729 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
9730 if final_cltv_expiry_delta == &0 {
9731 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
9735 Ok(HTLCSource::OutboundRoute {
9736 session_priv: session_priv.0.unwrap(),
9737 first_hop_htlc_msat,
9739 payment_id: payment_id.unwrap(),
9742 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
9743 _ => Err(DecodeError::UnknownRequiredFeature),
9748 impl Writeable for HTLCSource {
9749 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
9751 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
9753 let payment_id_opt = Some(payment_id);
9754 write_tlv_fields!(writer, {
9755 (0, session_priv, required),
9756 (1, payment_id_opt, option),
9757 (2, first_hop_htlc_msat, required),
9758 // 3 was previously used to write a PaymentSecret for the payment.
9759 (4, path.hops, required_vec),
9760 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
9761 (6, path.blinded_tail, option),
9764 HTLCSource::PreviousHopData(ref field) => {
9766 field.write(writer)?;
9773 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
9774 (0, forward_info, required),
9775 (1, prev_user_channel_id, (default_value, 0)),
9776 (2, prev_short_channel_id, required),
9777 (4, prev_htlc_id, required),
9778 (6, prev_funding_outpoint, required),
9781 impl Writeable for HTLCForwardInfo {
9782 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9783 const FAIL_HTLC_VARIANT_ID: u8 = 1;
9785 Self::AddHTLC(info) => {
9789 Self::FailHTLC { htlc_id, err_packet } => {
9790 FAIL_HTLC_VARIANT_ID.write(w)?;
9791 write_tlv_fields!(w, {
9792 (0, htlc_id, required),
9793 (2, err_packet, required),
9796 Self::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
9797 // Since this variant was added in 0.0.119, write this as `::FailHTLC` with an empty error
9798 // packet so older versions have something to fail back with, but serialize the real data as
9799 // optional TLVs for the benefit of newer versions.
9800 FAIL_HTLC_VARIANT_ID.write(w)?;
9801 let dummy_err_packet = msgs::OnionErrorPacket { data: Vec::new() };
9802 write_tlv_fields!(w, {
9803 (0, htlc_id, required),
9804 (1, failure_code, required),
9805 (2, dummy_err_packet, required),
9806 (3, sha256_of_onion, required),
9814 impl Readable for HTLCForwardInfo {
9815 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
9816 let id: u8 = Readable::read(r)?;
9818 0 => Self::AddHTLC(Readable::read(r)?),
9820 _init_and_read_len_prefixed_tlv_fields!(r, {
9821 (0, htlc_id, required),
9822 (1, malformed_htlc_failure_code, option),
9823 (2, err_packet, required),
9824 (3, sha256_of_onion, option),
9826 if let Some(failure_code) = malformed_htlc_failure_code {
9827 Self::FailMalformedHTLC {
9828 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9830 sha256_of_onion: sha256_of_onion.ok_or(DecodeError::InvalidValue)?,
9834 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9835 err_packet: _init_tlv_based_struct_field!(err_packet, required),
9839 _ => return Err(DecodeError::InvalidValue),
9844 impl_writeable_tlv_based!(PendingInboundPayment, {
9845 (0, payment_secret, required),
9846 (2, expiry_time, required),
9847 (4, user_payment_id, required),
9848 (6, payment_preimage, required),
9849 (8, min_value_msat, required),
9852 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>
9854 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9855 T::Target: BroadcasterInterface,
9856 ES::Target: EntropySource,
9857 NS::Target: NodeSigner,
9858 SP::Target: SignerProvider,
9859 F::Target: FeeEstimator,
9863 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9864 let _consistency_lock = self.total_consistency_lock.write().unwrap();
9866 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
9868 self.chain_hash.write(writer)?;
9870 let best_block = self.best_block.read().unwrap();
9871 best_block.height().write(writer)?;
9872 best_block.block_hash().write(writer)?;
9875 let mut serializable_peer_count: u64 = 0;
9877 let per_peer_state = self.per_peer_state.read().unwrap();
9878 let mut number_of_funded_channels = 0;
9879 for (_, peer_state_mutex) in per_peer_state.iter() {
9880 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9881 let peer_state = &mut *peer_state_lock;
9882 if !peer_state.ok_to_remove(false) {
9883 serializable_peer_count += 1;
9886 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
9887 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_broadcast() } else { false }
9891 (number_of_funded_channels as u64).write(writer)?;
9893 for (_, peer_state_mutex) in per_peer_state.iter() {
9894 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9895 let peer_state = &mut *peer_state_lock;
9896 for channel in peer_state.channel_by_id.iter().filter_map(
9897 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
9898 if channel.context.is_funding_broadcast() { Some(channel) } else { None }
9901 channel.write(writer)?;
9907 let forward_htlcs = self.forward_htlcs.lock().unwrap();
9908 (forward_htlcs.len() as u64).write(writer)?;
9909 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
9910 short_channel_id.write(writer)?;
9911 (pending_forwards.len() as u64).write(writer)?;
9912 for forward in pending_forwards {
9913 forward.write(writer)?;
9918 let per_peer_state = self.per_peer_state.write().unwrap();
9920 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
9921 let claimable_payments = self.claimable_payments.lock().unwrap();
9922 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
9924 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
9925 let mut htlc_onion_fields: Vec<&_> = Vec::new();
9926 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
9927 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
9928 payment_hash.write(writer)?;
9929 (payment.htlcs.len() as u64).write(writer)?;
9930 for htlc in payment.htlcs.iter() {
9931 htlc.write(writer)?;
9933 htlc_purposes.push(&payment.purpose);
9934 htlc_onion_fields.push(&payment.onion_fields);
9937 let mut monitor_update_blocked_actions_per_peer = None;
9938 let mut peer_states = Vec::new();
9939 for (_, peer_state_mutex) in per_peer_state.iter() {
9940 // Because we're holding the owning `per_peer_state` write lock here there's no chance
9941 // of a lockorder violation deadlock - no other thread can be holding any
9942 // per_peer_state lock at all.
9943 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
9946 (serializable_peer_count).write(writer)?;
9947 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9948 // Peers which we have no channels to should be dropped once disconnected. As we
9949 // disconnect all peers when shutting down and serializing the ChannelManager, we
9950 // consider all peers as disconnected here. There's therefore no need write peers with
9952 if !peer_state.ok_to_remove(false) {
9953 peer_pubkey.write(writer)?;
9954 peer_state.latest_features.write(writer)?;
9955 if !peer_state.monitor_update_blocked_actions.is_empty() {
9956 monitor_update_blocked_actions_per_peer
9957 .get_or_insert_with(Vec::new)
9958 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
9963 let events = self.pending_events.lock().unwrap();
9964 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
9965 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
9966 // refuse to read the new ChannelManager.
9967 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
9968 if events_not_backwards_compatible {
9969 // If we're gonna write a even TLV that will overwrite our events anyway we might as
9970 // well save the space and not write any events here.
9971 0u64.write(writer)?;
9973 (events.len() as u64).write(writer)?;
9974 for (event, _) in events.iter() {
9975 event.write(writer)?;
9979 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
9980 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
9981 // the closing monitor updates were always effectively replayed on startup (either directly
9982 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
9983 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
9984 0u64.write(writer)?;
9986 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
9987 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
9988 // likely to be identical.
9989 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
9990 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
9992 (pending_inbound_payments.len() as u64).write(writer)?;
9993 for (hash, pending_payment) in pending_inbound_payments.iter() {
9994 hash.write(writer)?;
9995 pending_payment.write(writer)?;
9998 // For backwards compat, write the session privs and their total length.
9999 let mut num_pending_outbounds_compat: u64 = 0;
10000 for (_, outbound) in pending_outbound_payments.iter() {
10001 if !outbound.is_fulfilled() && !outbound.abandoned() {
10002 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
10005 num_pending_outbounds_compat.write(writer)?;
10006 for (_, outbound) in pending_outbound_payments.iter() {
10008 PendingOutboundPayment::Legacy { session_privs } |
10009 PendingOutboundPayment::Retryable { session_privs, .. } => {
10010 for session_priv in session_privs.iter() {
10011 session_priv.write(writer)?;
10014 PendingOutboundPayment::AwaitingInvoice { .. } => {},
10015 PendingOutboundPayment::InvoiceReceived { .. } => {},
10016 PendingOutboundPayment::Fulfilled { .. } => {},
10017 PendingOutboundPayment::Abandoned { .. } => {},
10021 // Encode without retry info for 0.0.101 compatibility.
10022 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
10023 for (id, outbound) in pending_outbound_payments.iter() {
10025 PendingOutboundPayment::Legacy { session_privs } |
10026 PendingOutboundPayment::Retryable { session_privs, .. } => {
10027 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
10033 let mut pending_intercepted_htlcs = None;
10034 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
10035 if our_pending_intercepts.len() != 0 {
10036 pending_intercepted_htlcs = Some(our_pending_intercepts);
10039 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
10040 if pending_claiming_payments.as_ref().unwrap().is_empty() {
10041 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
10042 // map. Thus, if there are no entries we skip writing a TLV for it.
10043 pending_claiming_payments = None;
10046 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
10047 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
10048 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
10049 if !updates.is_empty() {
10050 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
10051 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
10056 write_tlv_fields!(writer, {
10057 (1, pending_outbound_payments_no_retry, required),
10058 (2, pending_intercepted_htlcs, option),
10059 (3, pending_outbound_payments, required),
10060 (4, pending_claiming_payments, option),
10061 (5, self.our_network_pubkey, required),
10062 (6, monitor_update_blocked_actions_per_peer, option),
10063 (7, self.fake_scid_rand_bytes, required),
10064 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
10065 (9, htlc_purposes, required_vec),
10066 (10, in_flight_monitor_updates, option),
10067 (11, self.probing_cookie_secret, required),
10068 (13, htlc_onion_fields, optional_vec),
10075 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
10076 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
10077 (self.len() as u64).write(w)?;
10078 for (event, action) in self.iter() {
10081 #[cfg(debug_assertions)] {
10082 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
10083 // be persisted and are regenerated on restart. However, if such an event has a
10084 // post-event-handling action we'll write nothing for the event and would have to
10085 // either forget the action or fail on deserialization (which we do below). Thus,
10086 // check that the event is sane here.
10087 let event_encoded = event.encode();
10088 let event_read: Option<Event> =
10089 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
10090 if action.is_some() { assert!(event_read.is_some()); }
10096 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
10097 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
10098 let len: u64 = Readable::read(reader)?;
10099 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
10100 let mut events: Self = VecDeque::with_capacity(cmp::min(
10101 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
10104 let ev_opt = MaybeReadable::read(reader)?;
10105 let action = Readable::read(reader)?;
10106 if let Some(ev) = ev_opt {
10107 events.push_back((ev, action));
10108 } else if action.is_some() {
10109 return Err(DecodeError::InvalidValue);
10116 impl_writeable_tlv_based_enum!(ChannelShutdownState,
10117 (0, NotShuttingDown) => {},
10118 (2, ShutdownInitiated) => {},
10119 (4, ResolvingHTLCs) => {},
10120 (6, NegotiatingClosingFee) => {},
10121 (8, ShutdownComplete) => {}, ;
10124 /// Arguments for the creation of a ChannelManager that are not deserialized.
10126 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
10128 /// 1) Deserialize all stored [`ChannelMonitor`]s.
10129 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
10130 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
10131 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
10132 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
10133 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
10134 /// same way you would handle a [`chain::Filter`] call using
10135 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
10136 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
10137 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
10138 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
10139 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
10140 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
10142 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
10143 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
10145 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
10146 /// call any other methods on the newly-deserialized [`ChannelManager`].
10148 /// Note that because some channels may be closed during deserialization, it is critical that you
10149 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
10150 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
10151 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
10152 /// not force-close the same channels but consider them live), you may end up revoking a state for
10153 /// which you've already broadcasted the transaction.
10155 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
10156 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10158 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10159 T::Target: BroadcasterInterface,
10160 ES::Target: EntropySource,
10161 NS::Target: NodeSigner,
10162 SP::Target: SignerProvider,
10163 F::Target: FeeEstimator,
10167 /// A cryptographically secure source of entropy.
10168 pub entropy_source: ES,
10170 /// A signer that is able to perform node-scoped cryptographic operations.
10171 pub node_signer: NS,
10173 /// The keys provider which will give us relevant keys. Some keys will be loaded during
10174 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
10176 pub signer_provider: SP,
10178 /// The fee_estimator for use in the ChannelManager in the future.
10180 /// No calls to the FeeEstimator will be made during deserialization.
10181 pub fee_estimator: F,
10182 /// The chain::Watch for use in the ChannelManager in the future.
10184 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
10185 /// you have deserialized ChannelMonitors separately and will add them to your
10186 /// chain::Watch after deserializing this ChannelManager.
10187 pub chain_monitor: M,
10189 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
10190 /// used to broadcast the latest local commitment transactions of channels which must be
10191 /// force-closed during deserialization.
10192 pub tx_broadcaster: T,
10193 /// The router which will be used in the ChannelManager in the future for finding routes
10194 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
10196 /// No calls to the router will be made during deserialization.
10198 /// The Logger for use in the ChannelManager and which may be used to log information during
10199 /// deserialization.
10201 /// Default settings used for new channels. Any existing channels will continue to use the
10202 /// runtime settings which were stored when the ChannelManager was serialized.
10203 pub default_config: UserConfig,
10205 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
10206 /// value.context.get_funding_txo() should be the key).
10208 /// If a monitor is inconsistent with the channel state during deserialization the channel will
10209 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
10210 /// is true for missing channels as well. If there is a monitor missing for which we find
10211 /// channel data Err(DecodeError::InvalidValue) will be returned.
10213 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
10216 /// This is not exported to bindings users because we have no HashMap bindings
10217 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>,
10220 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10221 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
10223 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10224 T::Target: BroadcasterInterface,
10225 ES::Target: EntropySource,
10226 NS::Target: NodeSigner,
10227 SP::Target: SignerProvider,
10228 F::Target: FeeEstimator,
10232 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
10233 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
10234 /// populate a HashMap directly from C.
10235 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,
10236 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>) -> Self {
10238 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
10239 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
10244 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
10245 // SipmleArcChannelManager type:
10246 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10247 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
10249 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10250 T::Target: BroadcasterInterface,
10251 ES::Target: EntropySource,
10252 NS::Target: NodeSigner,
10253 SP::Target: SignerProvider,
10254 F::Target: FeeEstimator,
10258 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10259 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
10260 Ok((blockhash, Arc::new(chan_manager)))
10264 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10265 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
10267 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10268 T::Target: BroadcasterInterface,
10269 ES::Target: EntropySource,
10270 NS::Target: NodeSigner,
10271 SP::Target: SignerProvider,
10272 F::Target: FeeEstimator,
10276 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10277 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
10279 let chain_hash: ChainHash = Readable::read(reader)?;
10280 let best_block_height: u32 = Readable::read(reader)?;
10281 let best_block_hash: BlockHash = Readable::read(reader)?;
10283 let mut failed_htlcs = Vec::new();
10285 let channel_count: u64 = Readable::read(reader)?;
10286 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
10287 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10288 let mut outpoint_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10289 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10290 let mut channel_closures = VecDeque::new();
10291 let mut close_background_events = Vec::new();
10292 for _ in 0..channel_count {
10293 let mut channel: Channel<SP> = Channel::read(reader, (
10294 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
10296 let logger = WithChannelContext::from(&args.logger, &channel.context);
10297 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10298 funding_txo_set.insert(funding_txo.clone());
10299 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
10300 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
10301 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
10302 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
10303 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10304 // But if the channel is behind of the monitor, close the channel:
10305 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
10306 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
10307 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10308 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
10309 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
10311 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
10312 log_error!(logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
10313 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
10315 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
10316 log_error!(logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
10317 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
10319 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
10320 log_error!(logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
10321 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
10323 let mut shutdown_result = channel.context.force_shutdown(true, ClosureReason::OutdatedChannelManager);
10324 if shutdown_result.unbroadcasted_batch_funding_txid.is_some() {
10325 return Err(DecodeError::InvalidValue);
10327 if let Some((counterparty_node_id, funding_txo, update)) = shutdown_result.monitor_update {
10328 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10329 counterparty_node_id, funding_txo, update
10332 failed_htlcs.append(&mut shutdown_result.dropped_outbound_htlcs);
10333 channel_closures.push_back((events::Event::ChannelClosed {
10334 channel_id: channel.context.channel_id(),
10335 user_channel_id: channel.context.get_user_id(),
10336 reason: ClosureReason::OutdatedChannelManager,
10337 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10338 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10340 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
10341 let mut found_htlc = false;
10342 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
10343 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
10346 // If we have some HTLCs in the channel which are not present in the newer
10347 // ChannelMonitor, they have been removed and should be failed back to
10348 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
10349 // were actually claimed we'd have generated and ensured the previous-hop
10350 // claim update ChannelMonitor updates were persisted prior to persising
10351 // the ChannelMonitor update for the forward leg, so attempting to fail the
10352 // backwards leg of the HTLC will simply be rejected.
10354 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
10355 &channel.context.channel_id(), &payment_hash);
10356 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10360 log_info!(logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
10361 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
10362 monitor.get_latest_update_id());
10363 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
10364 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10366 if let Some(funding_txo) = channel.context.get_funding_txo() {
10367 outpoint_to_peer.insert(funding_txo, channel.context.get_counterparty_node_id());
10369 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
10370 hash_map::Entry::Occupied(mut entry) => {
10371 let by_id_map = entry.get_mut();
10372 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10374 hash_map::Entry::Vacant(entry) => {
10375 let mut by_id_map = HashMap::new();
10376 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10377 entry.insert(by_id_map);
10381 } else if channel.is_awaiting_initial_mon_persist() {
10382 // If we were persisted and shut down while the initial ChannelMonitor persistence
10383 // was in-progress, we never broadcasted the funding transaction and can still
10384 // safely discard the channel.
10385 let _ = channel.context.force_shutdown(false, ClosureReason::DisconnectedPeer);
10386 channel_closures.push_back((events::Event::ChannelClosed {
10387 channel_id: channel.context.channel_id(),
10388 user_channel_id: channel.context.get_user_id(),
10389 reason: ClosureReason::DisconnectedPeer,
10390 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10391 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10394 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
10395 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10396 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10397 log_error!(logger, " Without the ChannelMonitor we cannot continue without risking funds.");
10398 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10399 return Err(DecodeError::InvalidValue);
10403 for (funding_txo, monitor) in args.channel_monitors.iter() {
10404 if !funding_txo_set.contains(funding_txo) {
10405 let logger = WithChannelMonitor::from(&args.logger, monitor);
10406 log_info!(logger, "Queueing monitor update to ensure missing channel {} is force closed",
10407 &funding_txo.to_channel_id());
10408 let monitor_update = ChannelMonitorUpdate {
10409 update_id: CLOSED_CHANNEL_UPDATE_ID,
10410 counterparty_node_id: None,
10411 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
10413 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
10417 const MAX_ALLOC_SIZE: usize = 1024 * 64;
10418 let forward_htlcs_count: u64 = Readable::read(reader)?;
10419 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
10420 for _ in 0..forward_htlcs_count {
10421 let short_channel_id = Readable::read(reader)?;
10422 let pending_forwards_count: u64 = Readable::read(reader)?;
10423 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
10424 for _ in 0..pending_forwards_count {
10425 pending_forwards.push(Readable::read(reader)?);
10427 forward_htlcs.insert(short_channel_id, pending_forwards);
10430 let claimable_htlcs_count: u64 = Readable::read(reader)?;
10431 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
10432 for _ in 0..claimable_htlcs_count {
10433 let payment_hash = Readable::read(reader)?;
10434 let previous_hops_len: u64 = Readable::read(reader)?;
10435 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
10436 for _ in 0..previous_hops_len {
10437 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
10439 claimable_htlcs_list.push((payment_hash, previous_hops));
10442 let peer_state_from_chans = |channel_by_id| {
10445 inbound_channel_request_by_id: HashMap::new(),
10446 latest_features: InitFeatures::empty(),
10447 pending_msg_events: Vec::new(),
10448 in_flight_monitor_updates: BTreeMap::new(),
10449 monitor_update_blocked_actions: BTreeMap::new(),
10450 actions_blocking_raa_monitor_updates: BTreeMap::new(),
10451 is_connected: false,
10455 let peer_count: u64 = Readable::read(reader)?;
10456 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
10457 for _ in 0..peer_count {
10458 let peer_pubkey = Readable::read(reader)?;
10459 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
10460 let mut peer_state = peer_state_from_chans(peer_chans);
10461 peer_state.latest_features = Readable::read(reader)?;
10462 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
10465 let event_count: u64 = Readable::read(reader)?;
10466 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
10467 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
10468 for _ in 0..event_count {
10469 match MaybeReadable::read(reader)? {
10470 Some(event) => pending_events_read.push_back((event, None)),
10475 let background_event_count: u64 = Readable::read(reader)?;
10476 for _ in 0..background_event_count {
10477 match <u8 as Readable>::read(reader)? {
10479 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
10480 // however we really don't (and never did) need them - we regenerate all
10481 // on-startup monitor updates.
10482 let _: OutPoint = Readable::read(reader)?;
10483 let _: ChannelMonitorUpdate = Readable::read(reader)?;
10485 _ => return Err(DecodeError::InvalidValue),
10489 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
10490 let highest_seen_timestamp: u32 = Readable::read(reader)?;
10492 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
10493 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
10494 for _ in 0..pending_inbound_payment_count {
10495 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
10496 return Err(DecodeError::InvalidValue);
10500 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
10501 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
10502 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
10503 for _ in 0..pending_outbound_payments_count_compat {
10504 let session_priv = Readable::read(reader)?;
10505 let payment = PendingOutboundPayment::Legacy {
10506 session_privs: [session_priv].iter().cloned().collect()
10508 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
10509 return Err(DecodeError::InvalidValue)
10513 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
10514 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
10515 let mut pending_outbound_payments = None;
10516 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
10517 let mut received_network_pubkey: Option<PublicKey> = None;
10518 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
10519 let mut probing_cookie_secret: Option<[u8; 32]> = None;
10520 let mut claimable_htlc_purposes = None;
10521 let mut claimable_htlc_onion_fields = None;
10522 let mut pending_claiming_payments = Some(HashMap::new());
10523 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
10524 let mut events_override = None;
10525 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
10526 read_tlv_fields!(reader, {
10527 (1, pending_outbound_payments_no_retry, option),
10528 (2, pending_intercepted_htlcs, option),
10529 (3, pending_outbound_payments, option),
10530 (4, pending_claiming_payments, option),
10531 (5, received_network_pubkey, option),
10532 (6, monitor_update_blocked_actions_per_peer, option),
10533 (7, fake_scid_rand_bytes, option),
10534 (8, events_override, option),
10535 (9, claimable_htlc_purposes, optional_vec),
10536 (10, in_flight_monitor_updates, option),
10537 (11, probing_cookie_secret, option),
10538 (13, claimable_htlc_onion_fields, optional_vec),
10540 if fake_scid_rand_bytes.is_none() {
10541 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
10544 if probing_cookie_secret.is_none() {
10545 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
10548 if let Some(events) = events_override {
10549 pending_events_read = events;
10552 if !channel_closures.is_empty() {
10553 pending_events_read.append(&mut channel_closures);
10556 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
10557 pending_outbound_payments = Some(pending_outbound_payments_compat);
10558 } else if pending_outbound_payments.is_none() {
10559 let mut outbounds = HashMap::new();
10560 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
10561 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
10563 pending_outbound_payments = Some(outbounds);
10565 let pending_outbounds = OutboundPayments {
10566 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
10567 retry_lock: Mutex::new(())
10570 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
10571 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
10572 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
10573 // replayed, and for each monitor update we have to replay we have to ensure there's a
10574 // `ChannelMonitor` for it.
10576 // In order to do so we first walk all of our live channels (so that we can check their
10577 // state immediately after doing the update replays, when we have the `update_id`s
10578 // available) and then walk any remaining in-flight updates.
10580 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
10581 let mut pending_background_events = Vec::new();
10582 macro_rules! handle_in_flight_updates {
10583 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
10584 $monitor: expr, $peer_state: expr, $logger: expr, $channel_info_log: expr
10586 let mut max_in_flight_update_id = 0;
10587 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
10588 for update in $chan_in_flight_upds.iter() {
10589 log_trace!($logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
10590 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
10591 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
10592 pending_background_events.push(
10593 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10594 counterparty_node_id: $counterparty_node_id,
10595 funding_txo: $funding_txo,
10596 update: update.clone(),
10599 if $chan_in_flight_upds.is_empty() {
10600 // We had some updates to apply, but it turns out they had completed before we
10601 // were serialized, we just weren't notified of that. Thus, we may have to run
10602 // the completion actions for any monitor updates, but otherwise are done.
10603 pending_background_events.push(
10604 BackgroundEvent::MonitorUpdatesComplete {
10605 counterparty_node_id: $counterparty_node_id,
10606 channel_id: $funding_txo.to_channel_id(),
10609 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
10610 log_error!($logger, "Duplicate in-flight monitor update set for the same channel!");
10611 return Err(DecodeError::InvalidValue);
10613 max_in_flight_update_id
10617 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
10618 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
10619 let peer_state = &mut *peer_state_lock;
10620 for phase in peer_state.channel_by_id.values() {
10621 if let ChannelPhase::Funded(chan) = phase {
10622 let logger = WithChannelContext::from(&args.logger, &chan.context);
10624 // Channels that were persisted have to be funded, otherwise they should have been
10626 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10627 let monitor = args.channel_monitors.get(&funding_txo)
10628 .expect("We already checked for monitor presence when loading channels");
10629 let mut max_in_flight_update_id = monitor.get_latest_update_id();
10630 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
10631 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
10632 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
10633 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
10634 funding_txo, monitor, peer_state, logger, ""));
10637 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
10638 // If the channel is ahead of the monitor, return InvalidValue:
10639 log_error!(logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
10640 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
10641 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
10642 log_error!(logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
10643 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10644 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10645 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10646 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10647 return Err(DecodeError::InvalidValue);
10650 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10651 // created in this `channel_by_id` map.
10652 debug_assert!(false);
10653 return Err(DecodeError::InvalidValue);
10658 if let Some(in_flight_upds) = in_flight_monitor_updates {
10659 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
10660 let logger = WithContext::from(&args.logger, Some(counterparty_id), Some(funding_txo.to_channel_id()));
10661 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
10662 // Now that we've removed all the in-flight monitor updates for channels that are
10663 // still open, we need to replay any monitor updates that are for closed channels,
10664 // creating the neccessary peer_state entries as we go.
10665 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
10666 Mutex::new(peer_state_from_chans(HashMap::new()))
10668 let mut peer_state = peer_state_mutex.lock().unwrap();
10669 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
10670 funding_txo, monitor, peer_state, logger, "closed ");
10672 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!");
10673 log_error!(logger, " The ChannelMonitor for channel {} is missing.",
10674 &funding_txo.to_channel_id());
10675 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10676 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10677 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10678 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10679 return Err(DecodeError::InvalidValue);
10684 // Note that we have to do the above replays before we push new monitor updates.
10685 pending_background_events.append(&mut close_background_events);
10687 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
10688 // should ensure we try them again on the inbound edge. We put them here and do so after we
10689 // have a fully-constructed `ChannelManager` at the end.
10690 let mut pending_claims_to_replay = Vec::new();
10693 // If we're tracking pending payments, ensure we haven't lost any by looking at the
10694 // ChannelMonitor data for any channels for which we do not have authorative state
10695 // (i.e. those for which we just force-closed above or we otherwise don't have a
10696 // corresponding `Channel` at all).
10697 // This avoids several edge-cases where we would otherwise "forget" about pending
10698 // payments which are still in-flight via their on-chain state.
10699 // We only rebuild the pending payments map if we were most recently serialized by
10701 for (_, monitor) in args.channel_monitors.iter() {
10702 let counterparty_opt = outpoint_to_peer.get(&monitor.get_funding_txo().0);
10703 if counterparty_opt.is_none() {
10704 let logger = WithChannelMonitor::from(&args.logger, monitor);
10705 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
10706 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
10707 if path.hops.is_empty() {
10708 log_error!(logger, "Got an empty path for a pending payment");
10709 return Err(DecodeError::InvalidValue);
10712 let path_amt = path.final_value_msat();
10713 let mut session_priv_bytes = [0; 32];
10714 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
10715 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
10716 hash_map::Entry::Occupied(mut entry) => {
10717 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
10718 log_info!(logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
10719 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), htlc.payment_hash);
10721 hash_map::Entry::Vacant(entry) => {
10722 let path_fee = path.fee_msat();
10723 entry.insert(PendingOutboundPayment::Retryable {
10724 retry_strategy: None,
10725 attempts: PaymentAttempts::new(),
10726 payment_params: None,
10727 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
10728 payment_hash: htlc.payment_hash,
10729 payment_secret: None, // only used for retries, and we'll never retry on startup
10730 payment_metadata: None, // only used for retries, and we'll never retry on startup
10731 keysend_preimage: None, // only used for retries, and we'll never retry on startup
10732 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
10733 pending_amt_msat: path_amt,
10734 pending_fee_msat: Some(path_fee),
10735 total_msat: path_amt,
10736 starting_block_height: best_block_height,
10737 remaining_max_total_routing_fee_msat: None, // only used for retries, and we'll never retry on startup
10739 log_info!(logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
10740 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
10745 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
10746 match htlc_source {
10747 HTLCSource::PreviousHopData(prev_hop_data) => {
10748 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
10749 info.prev_funding_outpoint == prev_hop_data.outpoint &&
10750 info.prev_htlc_id == prev_hop_data.htlc_id
10752 // The ChannelMonitor is now responsible for this HTLC's
10753 // failure/success and will let us know what its outcome is. If we
10754 // still have an entry for this HTLC in `forward_htlcs` or
10755 // `pending_intercepted_htlcs`, we were apparently not persisted after
10756 // the monitor was when forwarding the payment.
10757 forward_htlcs.retain(|_, forwards| {
10758 forwards.retain(|forward| {
10759 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
10760 if pending_forward_matches_htlc(&htlc_info) {
10761 log_info!(logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
10762 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
10767 !forwards.is_empty()
10769 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
10770 if pending_forward_matches_htlc(&htlc_info) {
10771 log_info!(logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
10772 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
10773 pending_events_read.retain(|(event, _)| {
10774 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
10775 intercepted_id != ev_id
10782 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
10783 if let Some(preimage) = preimage_opt {
10784 let pending_events = Mutex::new(pending_events_read);
10785 // Note that we set `from_onchain` to "false" here,
10786 // deliberately keeping the pending payment around forever.
10787 // Given it should only occur when we have a channel we're
10788 // force-closing for being stale that's okay.
10789 // The alternative would be to wipe the state when claiming,
10790 // generating a `PaymentPathSuccessful` event but regenerating
10791 // it and the `PaymentSent` on every restart until the
10792 // `ChannelMonitor` is removed.
10794 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
10795 channel_funding_outpoint: monitor.get_funding_txo().0,
10796 counterparty_node_id: path.hops[0].pubkey,
10798 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
10799 path, false, compl_action, &pending_events, &&logger);
10800 pending_events_read = pending_events.into_inner().unwrap();
10807 // Whether the downstream channel was closed or not, try to re-apply any payment
10808 // preimages from it which may be needed in upstream channels for forwarded
10810 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
10812 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
10813 if let HTLCSource::PreviousHopData(_) = htlc_source {
10814 if let Some(payment_preimage) = preimage_opt {
10815 Some((htlc_source, payment_preimage, htlc.amount_msat,
10816 // Check if `counterparty_opt.is_none()` to see if the
10817 // downstream chan is closed (because we don't have a
10818 // channel_id -> peer map entry).
10819 counterparty_opt.is_none(),
10820 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
10821 monitor.get_funding_txo().0))
10824 // If it was an outbound payment, we've handled it above - if a preimage
10825 // came in and we persisted the `ChannelManager` we either handled it and
10826 // are good to go or the channel force-closed - we don't have to handle the
10827 // channel still live case here.
10831 for tuple in outbound_claimed_htlcs_iter {
10832 pending_claims_to_replay.push(tuple);
10837 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
10838 // If we have pending HTLCs to forward, assume we either dropped a
10839 // `PendingHTLCsForwardable` or the user received it but never processed it as they
10840 // shut down before the timer hit. Either way, set the time_forwardable to a small
10841 // constant as enough time has likely passed that we should simply handle the forwards
10842 // now, or at least after the user gets a chance to reconnect to our peers.
10843 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
10844 time_forwardable: Duration::from_secs(2),
10848 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
10849 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
10851 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
10852 if let Some(purposes) = claimable_htlc_purposes {
10853 if purposes.len() != claimable_htlcs_list.len() {
10854 return Err(DecodeError::InvalidValue);
10856 if let Some(onion_fields) = claimable_htlc_onion_fields {
10857 if onion_fields.len() != claimable_htlcs_list.len() {
10858 return Err(DecodeError::InvalidValue);
10860 for (purpose, (onion, (payment_hash, htlcs))) in
10861 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
10863 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10864 purpose, htlcs, onion_fields: onion,
10866 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10869 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
10870 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10871 purpose, htlcs, onion_fields: None,
10873 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10877 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
10878 // include a `_legacy_hop_data` in the `OnionPayload`.
10879 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
10880 if htlcs.is_empty() {
10881 return Err(DecodeError::InvalidValue);
10883 let purpose = match &htlcs[0].onion_payload {
10884 OnionPayload::Invoice { _legacy_hop_data } => {
10885 if let Some(hop_data) = _legacy_hop_data {
10886 events::PaymentPurpose::InvoicePayment {
10887 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
10888 Some(inbound_payment) => inbound_payment.payment_preimage,
10889 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
10890 Ok((payment_preimage, _)) => payment_preimage,
10892 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);
10893 return Err(DecodeError::InvalidValue);
10897 payment_secret: hop_data.payment_secret,
10899 } else { return Err(DecodeError::InvalidValue); }
10901 OnionPayload::Spontaneous(payment_preimage) =>
10902 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
10904 claimable_payments.insert(payment_hash, ClaimablePayment {
10905 purpose, htlcs, onion_fields: None,
10910 let mut secp_ctx = Secp256k1::new();
10911 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
10913 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
10915 Err(()) => return Err(DecodeError::InvalidValue)
10917 if let Some(network_pubkey) = received_network_pubkey {
10918 if network_pubkey != our_network_pubkey {
10919 log_error!(args.logger, "Key that was generated does not match the existing key.");
10920 return Err(DecodeError::InvalidValue);
10924 let mut outbound_scid_aliases = HashSet::new();
10925 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
10926 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
10927 let peer_state = &mut *peer_state_lock;
10928 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
10929 if let ChannelPhase::Funded(chan) = phase {
10930 let logger = WithChannelContext::from(&args.logger, &chan.context);
10931 if chan.context.outbound_scid_alias() == 0 {
10932 let mut outbound_scid_alias;
10934 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
10935 .get_fake_scid(best_block_height, &chain_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
10936 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
10938 chan.context.set_outbound_scid_alias(outbound_scid_alias);
10939 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
10940 // Note that in rare cases its possible to hit this while reading an older
10941 // channel if we just happened to pick a colliding outbound alias above.
10942 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
10943 return Err(DecodeError::InvalidValue);
10945 if chan.context.is_usable() {
10946 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
10947 // Note that in rare cases its possible to hit this while reading an older
10948 // channel if we just happened to pick a colliding outbound alias above.
10949 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
10950 return Err(DecodeError::InvalidValue);
10954 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10955 // created in this `channel_by_id` map.
10956 debug_assert!(false);
10957 return Err(DecodeError::InvalidValue);
10962 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
10964 for (_, monitor) in args.channel_monitors.iter() {
10965 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
10966 if let Some(payment) = claimable_payments.remove(&payment_hash) {
10967 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
10968 let mut claimable_amt_msat = 0;
10969 let mut receiver_node_id = Some(our_network_pubkey);
10970 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
10971 if phantom_shared_secret.is_some() {
10972 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
10973 .expect("Failed to get node_id for phantom node recipient");
10974 receiver_node_id = Some(phantom_pubkey)
10976 for claimable_htlc in &payment.htlcs {
10977 claimable_amt_msat += claimable_htlc.value;
10979 // Add a holding-cell claim of the payment to the Channel, which should be
10980 // applied ~immediately on peer reconnection. Because it won't generate a
10981 // new commitment transaction we can just provide the payment preimage to
10982 // the corresponding ChannelMonitor and nothing else.
10984 // We do so directly instead of via the normal ChannelMonitor update
10985 // procedure as the ChainMonitor hasn't yet been initialized, implying
10986 // we're not allowed to call it directly yet. Further, we do the update
10987 // without incrementing the ChannelMonitor update ID as there isn't any
10989 // If we were to generate a new ChannelMonitor update ID here and then
10990 // crash before the user finishes block connect we'd end up force-closing
10991 // this channel as well. On the flip side, there's no harm in restarting
10992 // without the new monitor persisted - we'll end up right back here on
10994 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
10995 if let Some(peer_node_id) = outpoint_to_peer.get(&claimable_htlc.prev_hop.outpoint) {
10996 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
10997 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
10998 let peer_state = &mut *peer_state_lock;
10999 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
11000 let logger = WithChannelContext::from(&args.logger, &channel.context);
11001 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &&logger);
11004 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
11005 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
11008 pending_events_read.push_back((events::Event::PaymentClaimed {
11011 purpose: payment.purpose,
11012 amount_msat: claimable_amt_msat,
11013 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
11014 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
11020 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
11021 if let Some(peer_state) = per_peer_state.get(&node_id) {
11022 for (channel_id, actions) in monitor_update_blocked_actions.iter() {
11023 let logger = WithContext::from(&args.logger, Some(node_id), Some(*channel_id));
11024 for action in actions.iter() {
11025 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
11026 downstream_counterparty_and_funding_outpoint:
11027 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
11029 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
11031 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
11032 blocked_channel_outpoint.to_channel_id());
11033 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
11034 .entry(blocked_channel_outpoint.to_channel_id())
11035 .or_insert_with(Vec::new).push(blocking_action.clone());
11037 // If the channel we were blocking has closed, we don't need to
11038 // worry about it - the blocked monitor update should never have
11039 // been released from the `Channel` object so it can't have
11040 // completed, and if the channel closed there's no reason to bother
11044 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately { .. } = action {
11045 debug_assert!(false, "Non-event-generating channel freeing should not appear in our queue");
11049 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
11051 log_error!(WithContext::from(&args.logger, Some(node_id), None), "Got blocked actions without a per-peer-state for {}", node_id);
11052 return Err(DecodeError::InvalidValue);
11056 let channel_manager = ChannelManager {
11058 fee_estimator: bounded_fee_estimator,
11059 chain_monitor: args.chain_monitor,
11060 tx_broadcaster: args.tx_broadcaster,
11061 router: args.router,
11063 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
11065 inbound_payment_key: expanded_inbound_key,
11066 pending_inbound_payments: Mutex::new(pending_inbound_payments),
11067 pending_outbound_payments: pending_outbounds,
11068 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
11070 forward_htlcs: Mutex::new(forward_htlcs),
11071 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
11072 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
11073 outpoint_to_peer: Mutex::new(outpoint_to_peer),
11074 short_to_chan_info: FairRwLock::new(short_to_chan_info),
11075 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
11077 probing_cookie_secret: probing_cookie_secret.unwrap(),
11079 our_network_pubkey,
11082 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
11084 per_peer_state: FairRwLock::new(per_peer_state),
11086 pending_events: Mutex::new(pending_events_read),
11087 pending_events_processor: AtomicBool::new(false),
11088 pending_background_events: Mutex::new(pending_background_events),
11089 total_consistency_lock: RwLock::new(()),
11090 background_events_processed_since_startup: AtomicBool::new(false),
11092 event_persist_notifier: Notifier::new(),
11093 needs_persist_flag: AtomicBool::new(false),
11095 funding_batch_states: Mutex::new(BTreeMap::new()),
11097 pending_offers_messages: Mutex::new(Vec::new()),
11099 entropy_source: args.entropy_source,
11100 node_signer: args.node_signer,
11101 signer_provider: args.signer_provider,
11103 logger: args.logger,
11104 default_configuration: args.default_config,
11107 for htlc_source in failed_htlcs.drain(..) {
11108 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
11109 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
11110 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
11111 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
11114 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding) in pending_claims_to_replay {
11115 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
11116 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
11117 // channel is closed we just assume that it probably came from an on-chain claim.
11118 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
11119 downstream_closed, true, downstream_node_id, downstream_funding);
11122 //TODO: Broadcast channel update for closed channels, but only after we've made a
11123 //connection or two.
11125 Ok((best_block_hash.clone(), channel_manager))
11131 use bitcoin::hashes::Hash;
11132 use bitcoin::hashes::sha256::Hash as Sha256;
11133 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
11134 use core::sync::atomic::Ordering;
11135 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
11136 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
11137 use crate::ln::ChannelId;
11138 use crate::ln::channelmanager::{create_recv_pending_htlc_info, HTLCForwardInfo, inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
11139 use crate::ln::functional_test_utils::*;
11140 use crate::ln::msgs::{self, ErrorAction};
11141 use crate::ln::msgs::ChannelMessageHandler;
11142 use crate::prelude::*;
11143 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
11144 use crate::util::errors::APIError;
11145 use crate::util::ser::Writeable;
11146 use crate::util::test_utils;
11147 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
11148 use crate::sign::EntropySource;
11151 fn test_notify_limits() {
11152 // Check that a few cases which don't require the persistence of a new ChannelManager,
11153 // indeed, do not cause the persistence of a new ChannelManager.
11154 let chanmon_cfgs = create_chanmon_cfgs(3);
11155 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
11156 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
11157 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
11159 // All nodes start with a persistable update pending as `create_network` connects each node
11160 // with all other nodes to make most tests simpler.
11161 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11162 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11163 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11165 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11167 // We check that the channel info nodes have doesn't change too early, even though we try
11168 // to connect messages with new values
11169 chan.0.contents.fee_base_msat *= 2;
11170 chan.1.contents.fee_base_msat *= 2;
11171 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
11172 &nodes[1].node.get_our_node_id()).pop().unwrap();
11173 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
11174 &nodes[0].node.get_our_node_id()).pop().unwrap();
11176 // The first two nodes (which opened a channel) should now require fresh persistence
11177 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11178 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11179 // ... but the last node should not.
11180 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11181 // After persisting the first two nodes they should no longer need fresh persistence.
11182 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11183 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11185 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
11186 // about the channel.
11187 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
11188 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
11189 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11191 // The nodes which are a party to the channel should also ignore messages from unrelated
11193 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11194 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11195 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11196 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11197 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11198 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11200 // At this point the channel info given by peers should still be the same.
11201 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11202 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11204 // An earlier version of handle_channel_update didn't check the directionality of the
11205 // update message and would always update the local fee info, even if our peer was
11206 // (spuriously) forwarding us our own channel_update.
11207 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
11208 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
11209 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
11211 // First deliver each peers' own message, checking that the node doesn't need to be
11212 // persisted and that its channel info remains the same.
11213 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
11214 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
11215 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11216 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11217 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11218 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11220 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
11221 // the channel info has updated.
11222 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
11223 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
11224 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11225 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11226 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
11227 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
11231 fn test_keysend_dup_hash_partial_mpp() {
11232 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
11234 let chanmon_cfgs = create_chanmon_cfgs(2);
11235 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11236 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11237 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11238 create_announced_chan_between_nodes(&nodes, 0, 1);
11240 // First, send a partial MPP payment.
11241 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
11242 let mut mpp_route = route.clone();
11243 mpp_route.paths.push(mpp_route.paths[0].clone());
11245 let payment_id = PaymentId([42; 32]);
11246 // Use the utility function send_payment_along_path to send the payment with MPP data which
11247 // indicates there are more HTLCs coming.
11248 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.
11249 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
11250 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
11251 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
11252 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
11253 check_added_monitors!(nodes[0], 1);
11254 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11255 assert_eq!(events.len(), 1);
11256 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
11258 // Next, send a keysend payment with the same payment_hash and make sure it fails.
11259 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11260 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11261 check_added_monitors!(nodes[0], 1);
11262 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11263 assert_eq!(events.len(), 1);
11264 let ev = events.drain(..).next().unwrap();
11265 let payment_event = SendEvent::from_event(ev);
11266 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11267 check_added_monitors!(nodes[1], 0);
11268 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11269 expect_pending_htlcs_forwardable!(nodes[1]);
11270 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
11271 check_added_monitors!(nodes[1], 1);
11272 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11273 assert!(updates.update_add_htlcs.is_empty());
11274 assert!(updates.update_fulfill_htlcs.is_empty());
11275 assert_eq!(updates.update_fail_htlcs.len(), 1);
11276 assert!(updates.update_fail_malformed_htlcs.is_empty());
11277 assert!(updates.update_fee.is_none());
11278 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11279 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11280 expect_payment_failed!(nodes[0], our_payment_hash, true);
11282 // Send the second half of the original MPP payment.
11283 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
11284 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
11285 check_added_monitors!(nodes[0], 1);
11286 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11287 assert_eq!(events.len(), 1);
11288 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
11290 // Claim the full MPP payment. Note that we can't use a test utility like
11291 // claim_funds_along_route because the ordering of the messages causes the second half of the
11292 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
11293 // lightning messages manually.
11294 nodes[1].node.claim_funds(payment_preimage);
11295 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
11296 check_added_monitors!(nodes[1], 2);
11298 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11299 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
11300 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
11301 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
11302 check_added_monitors!(nodes[0], 1);
11303 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11304 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
11305 check_added_monitors!(nodes[1], 1);
11306 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11307 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
11308 check_added_monitors!(nodes[1], 1);
11309 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11310 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
11311 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
11312 check_added_monitors!(nodes[0], 1);
11313 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
11314 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
11315 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11316 check_added_monitors!(nodes[0], 1);
11317 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
11318 check_added_monitors!(nodes[1], 1);
11319 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
11320 check_added_monitors!(nodes[1], 1);
11321 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11322 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
11323 check_added_monitors!(nodes[0], 1);
11325 // Note that successful MPP payments will generate a single PaymentSent event upon the first
11326 // path's success and a PaymentPathSuccessful event for each path's success.
11327 let events = nodes[0].node.get_and_clear_pending_events();
11328 assert_eq!(events.len(), 2);
11330 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11331 assert_eq!(payment_id, *actual_payment_id);
11332 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11333 assert_eq!(route.paths[0], *path);
11335 _ => panic!("Unexpected event"),
11338 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11339 assert_eq!(payment_id, *actual_payment_id);
11340 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11341 assert_eq!(route.paths[0], *path);
11343 _ => panic!("Unexpected event"),
11348 fn test_keysend_dup_payment_hash() {
11349 do_test_keysend_dup_payment_hash(false);
11350 do_test_keysend_dup_payment_hash(true);
11353 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
11354 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
11355 // outbound regular payment fails as expected.
11356 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
11357 // fails as expected.
11358 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
11359 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
11360 // reject MPP keysend payments, since in this case where the payment has no payment
11361 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
11362 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
11363 // payment secrets and reject otherwise.
11364 let chanmon_cfgs = create_chanmon_cfgs(2);
11365 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11366 let mut mpp_keysend_cfg = test_default_channel_config();
11367 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
11368 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
11369 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11370 create_announced_chan_between_nodes(&nodes, 0, 1);
11371 let scorer = test_utils::TestScorer::new();
11372 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11374 // To start (1), send a regular payment but don't claim it.
11375 let expected_route = [&nodes[1]];
11376 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
11378 // Next, attempt a keysend payment and make sure it fails.
11379 let route_params = RouteParameters::from_payment_params_and_value(
11380 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
11381 TEST_FINAL_CLTV, false), 100_000);
11382 let route = find_route(
11383 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11384 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11386 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11387 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11388 check_added_monitors!(nodes[0], 1);
11389 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11390 assert_eq!(events.len(), 1);
11391 let ev = events.drain(..).next().unwrap();
11392 let payment_event = SendEvent::from_event(ev);
11393 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11394 check_added_monitors!(nodes[1], 0);
11395 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11396 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
11397 // fails), the second will process the resulting failure and fail the HTLC backward
11398 expect_pending_htlcs_forwardable!(nodes[1]);
11399 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11400 check_added_monitors!(nodes[1], 1);
11401 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11402 assert!(updates.update_add_htlcs.is_empty());
11403 assert!(updates.update_fulfill_htlcs.is_empty());
11404 assert_eq!(updates.update_fail_htlcs.len(), 1);
11405 assert!(updates.update_fail_malformed_htlcs.is_empty());
11406 assert!(updates.update_fee.is_none());
11407 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11408 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11409 expect_payment_failed!(nodes[0], payment_hash, true);
11411 // Finally, claim the original payment.
11412 claim_payment(&nodes[0], &expected_route, payment_preimage);
11414 // To start (2), send a keysend payment but don't claim it.
11415 let payment_preimage = PaymentPreimage([42; 32]);
11416 let route = find_route(
11417 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11418 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11420 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11421 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11422 check_added_monitors!(nodes[0], 1);
11423 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11424 assert_eq!(events.len(), 1);
11425 let event = events.pop().unwrap();
11426 let path = vec![&nodes[1]];
11427 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11429 // Next, attempt a regular payment and make sure it fails.
11430 let payment_secret = PaymentSecret([43; 32]);
11431 nodes[0].node.send_payment_with_route(&route, payment_hash,
11432 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
11433 check_added_monitors!(nodes[0], 1);
11434 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11435 assert_eq!(events.len(), 1);
11436 let ev = events.drain(..).next().unwrap();
11437 let payment_event = SendEvent::from_event(ev);
11438 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11439 check_added_monitors!(nodes[1], 0);
11440 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11441 expect_pending_htlcs_forwardable!(nodes[1]);
11442 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11443 check_added_monitors!(nodes[1], 1);
11444 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11445 assert!(updates.update_add_htlcs.is_empty());
11446 assert!(updates.update_fulfill_htlcs.is_empty());
11447 assert_eq!(updates.update_fail_htlcs.len(), 1);
11448 assert!(updates.update_fail_malformed_htlcs.is_empty());
11449 assert!(updates.update_fee.is_none());
11450 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11451 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11452 expect_payment_failed!(nodes[0], payment_hash, true);
11454 // Finally, succeed the keysend payment.
11455 claim_payment(&nodes[0], &expected_route, payment_preimage);
11457 // To start (3), send a keysend payment but don't claim it.
11458 let payment_id_1 = PaymentId([44; 32]);
11459 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11460 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
11461 check_added_monitors!(nodes[0], 1);
11462 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11463 assert_eq!(events.len(), 1);
11464 let event = events.pop().unwrap();
11465 let path = vec![&nodes[1]];
11466 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11468 // Next, attempt a keysend payment and make sure it fails.
11469 let route_params = RouteParameters::from_payment_params_and_value(
11470 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
11473 let route = find_route(
11474 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11475 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11477 let payment_id_2 = PaymentId([45; 32]);
11478 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11479 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
11480 check_added_monitors!(nodes[0], 1);
11481 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11482 assert_eq!(events.len(), 1);
11483 let ev = events.drain(..).next().unwrap();
11484 let payment_event = SendEvent::from_event(ev);
11485 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11486 check_added_monitors!(nodes[1], 0);
11487 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11488 expect_pending_htlcs_forwardable!(nodes[1]);
11489 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11490 check_added_monitors!(nodes[1], 1);
11491 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11492 assert!(updates.update_add_htlcs.is_empty());
11493 assert!(updates.update_fulfill_htlcs.is_empty());
11494 assert_eq!(updates.update_fail_htlcs.len(), 1);
11495 assert!(updates.update_fail_malformed_htlcs.is_empty());
11496 assert!(updates.update_fee.is_none());
11497 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11498 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11499 expect_payment_failed!(nodes[0], payment_hash, true);
11501 // Finally, claim the original payment.
11502 claim_payment(&nodes[0], &expected_route, payment_preimage);
11506 fn test_keysend_hash_mismatch() {
11507 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
11508 // preimage doesn't match the msg's payment hash.
11509 let chanmon_cfgs = create_chanmon_cfgs(2);
11510 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11511 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11512 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11514 let payer_pubkey = nodes[0].node.get_our_node_id();
11515 let payee_pubkey = nodes[1].node.get_our_node_id();
11517 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11518 let route_params = RouteParameters::from_payment_params_and_value(
11519 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11520 let network_graph = nodes[0].network_graph;
11521 let first_hops = nodes[0].node.list_usable_channels();
11522 let scorer = test_utils::TestScorer::new();
11523 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11524 let route = find_route(
11525 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11526 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11529 let test_preimage = PaymentPreimage([42; 32]);
11530 let mismatch_payment_hash = PaymentHash([43; 32]);
11531 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
11532 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
11533 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
11534 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
11535 check_added_monitors!(nodes[0], 1);
11537 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11538 assert_eq!(updates.update_add_htlcs.len(), 1);
11539 assert!(updates.update_fulfill_htlcs.is_empty());
11540 assert!(updates.update_fail_htlcs.is_empty());
11541 assert!(updates.update_fail_malformed_htlcs.is_empty());
11542 assert!(updates.update_fee.is_none());
11543 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11545 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
11549 fn test_keysend_msg_with_secret_err() {
11550 // Test that we error as expected if we receive a keysend payment that includes a payment
11551 // secret when we don't support MPP keysend.
11552 let mut reject_mpp_keysend_cfg = test_default_channel_config();
11553 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
11554 let chanmon_cfgs = create_chanmon_cfgs(2);
11555 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11556 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
11557 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11559 let payer_pubkey = nodes[0].node.get_our_node_id();
11560 let payee_pubkey = nodes[1].node.get_our_node_id();
11562 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11563 let route_params = RouteParameters::from_payment_params_and_value(
11564 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11565 let network_graph = nodes[0].network_graph;
11566 let first_hops = nodes[0].node.list_usable_channels();
11567 let scorer = test_utils::TestScorer::new();
11568 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11569 let route = find_route(
11570 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11571 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11574 let test_preimage = PaymentPreimage([42; 32]);
11575 let test_secret = PaymentSecret([43; 32]);
11576 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).to_byte_array());
11577 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
11578 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
11579 nodes[0].node.test_send_payment_internal(&route, payment_hash,
11580 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
11581 PaymentId(payment_hash.0), None, session_privs).unwrap();
11582 check_added_monitors!(nodes[0], 1);
11584 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11585 assert_eq!(updates.update_add_htlcs.len(), 1);
11586 assert!(updates.update_fulfill_htlcs.is_empty());
11587 assert!(updates.update_fail_htlcs.is_empty());
11588 assert!(updates.update_fail_malformed_htlcs.is_empty());
11589 assert!(updates.update_fee.is_none());
11590 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11592 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
11596 fn test_multi_hop_missing_secret() {
11597 let chanmon_cfgs = create_chanmon_cfgs(4);
11598 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
11599 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
11600 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
11602 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
11603 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
11604 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
11605 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
11607 // Marshall an MPP route.
11608 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
11609 let path = route.paths[0].clone();
11610 route.paths.push(path);
11611 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
11612 route.paths[0].hops[0].short_channel_id = chan_1_id;
11613 route.paths[0].hops[1].short_channel_id = chan_3_id;
11614 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
11615 route.paths[1].hops[0].short_channel_id = chan_2_id;
11616 route.paths[1].hops[1].short_channel_id = chan_4_id;
11618 match nodes[0].node.send_payment_with_route(&route, payment_hash,
11619 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
11621 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
11622 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
11624 _ => panic!("unexpected error")
11629 fn test_drop_disconnected_peers_when_removing_channels() {
11630 let chanmon_cfgs = create_chanmon_cfgs(2);
11631 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11632 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11633 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11635 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11637 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
11638 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11640 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
11641 check_closed_broadcast!(nodes[0], true);
11642 check_added_monitors!(nodes[0], 1);
11643 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
11646 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
11647 // disconnected and the channel between has been force closed.
11648 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
11649 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
11650 assert_eq!(nodes_0_per_peer_state.len(), 1);
11651 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
11654 nodes[0].node.timer_tick_occurred();
11657 // Assert that nodes[1] has now been removed.
11658 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
11663 fn bad_inbound_payment_hash() {
11664 // Add coverage for checking that a user-provided payment hash matches the payment secret.
11665 let chanmon_cfgs = create_chanmon_cfgs(2);
11666 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11667 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11668 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11670 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
11671 let payment_data = msgs::FinalOnionHopData {
11673 total_msat: 100_000,
11676 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
11677 // payment verification fails as expected.
11678 let mut bad_payment_hash = payment_hash.clone();
11679 bad_payment_hash.0[0] += 1;
11680 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) {
11681 Ok(_) => panic!("Unexpected ok"),
11683 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
11687 // Check that using the original payment hash succeeds.
11688 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());
11692 fn test_outpoint_to_peer_coverage() {
11693 // Test that the `ChannelManager:outpoint_to_peer` contains channels which have been assigned
11694 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
11695 // the channel is successfully closed.
11696 let chanmon_cfgs = create_chanmon_cfgs(2);
11697 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11698 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11699 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11701 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, None).unwrap();
11702 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11703 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
11704 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11705 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11707 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
11708 let channel_id = ChannelId::from_bytes(tx.txid().to_byte_array());
11710 // Ensure that the `outpoint_to_peer` map is empty until either party has received the
11711 // funding transaction, and have the real `channel_id`.
11712 assert_eq!(nodes[0].node.outpoint_to_peer.lock().unwrap().len(), 0);
11713 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11716 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
11718 // Assert that `nodes[0]`'s `outpoint_to_peer` map is populated with the channel as soon as
11719 // as it has the funding transaction.
11720 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11721 assert_eq!(nodes_0_lock.len(), 1);
11722 assert!(nodes_0_lock.contains_key(&funding_output));
11725 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11727 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11729 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11731 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11732 assert_eq!(nodes_0_lock.len(), 1);
11733 assert!(nodes_0_lock.contains_key(&funding_output));
11735 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11738 // Assert that `nodes[1]`'s `outpoint_to_peer` map is populated with the channel as
11739 // soon as it has the funding transaction.
11740 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11741 assert_eq!(nodes_1_lock.len(), 1);
11742 assert!(nodes_1_lock.contains_key(&funding_output));
11744 check_added_monitors!(nodes[1], 1);
11745 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11746 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11747 check_added_monitors!(nodes[0], 1);
11748 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11749 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
11750 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
11751 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
11753 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
11754 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()));
11755 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
11756 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
11758 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
11759 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
11761 // Assert that the channel is kept in the `outpoint_to_peer` map for both nodes until the
11762 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
11763 // fee for the closing transaction has been negotiated and the parties has the other
11764 // party's signature for the fee negotiated closing transaction.)
11765 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11766 assert_eq!(nodes_0_lock.len(), 1);
11767 assert!(nodes_0_lock.contains_key(&funding_output));
11771 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
11772 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
11773 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
11774 // kept in the `nodes[1]`'s `outpoint_to_peer` map.
11775 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11776 assert_eq!(nodes_1_lock.len(), 1);
11777 assert!(nodes_1_lock.contains_key(&funding_output));
11780 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()));
11782 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
11783 // therefore has all it needs to fully close the channel (both signatures for the
11784 // closing transaction).
11785 // Assert that the channel is removed from `nodes[0]`'s `outpoint_to_peer` map as it can be
11786 // fully closed by `nodes[0]`.
11787 assert_eq!(nodes[0].node.outpoint_to_peer.lock().unwrap().len(), 0);
11789 // Assert that the channel is still in `nodes[1]`'s `outpoint_to_peer` map, as `nodes[1]`
11790 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
11791 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11792 assert_eq!(nodes_1_lock.len(), 1);
11793 assert!(nodes_1_lock.contains_key(&funding_output));
11796 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
11798 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
11800 // Assert that the channel has now been removed from both parties `outpoint_to_peer` map once
11801 // they both have everything required to fully close the channel.
11802 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11804 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
11806 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
11807 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
11810 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11811 let expected_message = format!("Not connected to node: {}", expected_public_key);
11812 check_api_error_message(expected_message, res_err)
11815 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11816 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
11817 check_api_error_message(expected_message, res_err)
11820 fn check_channel_unavailable_error<T>(res_err: Result<T, APIError>, expected_channel_id: ChannelId, peer_node_id: PublicKey) {
11821 let expected_message = format!("Channel with id {} not found for the passed counterparty node_id {}", expected_channel_id, peer_node_id);
11822 check_api_error_message(expected_message, res_err)
11825 fn check_api_misuse_error<T>(res_err: Result<T, APIError>) {
11826 let expected_message = "No such channel awaiting to be accepted.".to_string();
11827 check_api_error_message(expected_message, res_err)
11830 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
11832 Err(APIError::APIMisuseError { err }) => {
11833 assert_eq!(err, expected_err_message);
11835 Err(APIError::ChannelUnavailable { err }) => {
11836 assert_eq!(err, expected_err_message);
11838 Ok(_) => panic!("Unexpected Ok"),
11839 Err(_) => panic!("Unexpected Error"),
11844 fn test_api_calls_with_unkown_counterparty_node() {
11845 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
11846 // expected if the `counterparty_node_id` is an unkown peer in the
11847 // `ChannelManager::per_peer_state` map.
11848 let chanmon_cfg = create_chanmon_cfgs(2);
11849 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11850 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11851 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11854 let channel_id = ChannelId::from_bytes([4; 32]);
11855 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
11856 let intercept_id = InterceptId([0; 32]);
11858 // Test the API functions.
11859 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);
11861 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
11863 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
11865 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
11867 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
11869 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
11871 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
11875 fn test_api_calls_with_unavailable_channel() {
11876 // Tests that our API functions that expects a `counterparty_node_id` and a `channel_id`
11877 // as input, behaves as expected if the `counterparty_node_id` is a known peer in the
11878 // `ChannelManager::per_peer_state` map, but the peer state doesn't contain a channel with
11879 // the given `channel_id`.
11880 let chanmon_cfg = create_chanmon_cfgs(2);
11881 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11882 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11883 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11885 let counterparty_node_id = nodes[1].node.get_our_node_id();
11888 let channel_id = ChannelId::from_bytes([4; 32]);
11890 // Test the API functions.
11891 check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42));
11893 check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11895 check_channel_unavailable_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11897 check_channel_unavailable_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11899 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);
11901 check_channel_unavailable_error(nodes[0].node.update_channel_config(&counterparty_node_id, &[channel_id], &ChannelConfig::default()), channel_id, counterparty_node_id);
11905 fn test_connection_limiting() {
11906 // Test that we limit un-channel'd peers and un-funded channels properly.
11907 let chanmon_cfgs = create_chanmon_cfgs(2);
11908 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11909 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11910 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11912 // Note that create_network connects the nodes together for us
11914 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11915 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11917 let mut funding_tx = None;
11918 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
11919 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11920 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11923 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11924 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
11925 funding_tx = Some(tx.clone());
11926 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
11927 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11929 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11930 check_added_monitors!(nodes[1], 1);
11931 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11933 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11935 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11936 check_added_monitors!(nodes[0], 1);
11937 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11939 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11942 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
11943 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11944 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11945 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11946 open_channel_msg.temporary_channel_id);
11948 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
11949 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
11951 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
11952 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
11953 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11954 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11955 peer_pks.push(random_pk);
11956 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
11957 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11960 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11961 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11962 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11963 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11964 }, true).unwrap_err();
11966 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
11967 // them if we have too many un-channel'd peers.
11968 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11969 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
11970 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
11971 for ev in chan_closed_events {
11972 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
11974 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11975 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11977 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11978 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11979 }, true).unwrap_err();
11981 // but of course if the connection is outbound its allowed...
11982 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11983 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11984 }, false).unwrap();
11985 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11987 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
11988 // Even though we accept one more connection from new peers, we won't actually let them
11990 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
11991 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
11992 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
11993 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
11994 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11996 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11997 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
11998 open_channel_msg.temporary_channel_id);
12000 // Of course, however, outbound channels are always allowed
12001 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None, None).unwrap();
12002 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
12004 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
12005 // "protected" and can connect again.
12006 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
12007 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12008 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12010 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
12012 // Further, because the first channel was funded, we can open another channel with
12014 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12015 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
12019 fn test_outbound_chans_unlimited() {
12020 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
12021 let chanmon_cfgs = create_chanmon_cfgs(2);
12022 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12023 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
12024 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12026 // Note that create_network connects the nodes together for us
12028 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12029 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12031 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
12032 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12033 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12034 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12037 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
12039 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12040 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12041 open_channel_msg.temporary_channel_id);
12043 // but we can still open an outbound channel.
12044 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12045 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
12047 // but even with such an outbound channel, additional inbound channels will still fail.
12048 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12049 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12050 open_channel_msg.temporary_channel_id);
12054 fn test_0conf_limiting() {
12055 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12056 // flag set and (sometimes) accept channels as 0conf.
12057 let chanmon_cfgs = create_chanmon_cfgs(2);
12058 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12059 let mut settings = test_default_channel_config();
12060 settings.manually_accept_inbound_channels = true;
12061 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
12062 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12064 // Note that create_network connects the nodes together for us
12066 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12067 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12069 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
12070 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
12071 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12072 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12073 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
12074 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12077 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
12078 let events = nodes[1].node.get_and_clear_pending_events();
12080 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12081 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
12083 _ => panic!("Unexpected event"),
12085 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
12086 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12089 // If we try to accept a channel from another peer non-0conf it will fail.
12090 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12091 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12092 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12093 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12095 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12096 let events = nodes[1].node.get_and_clear_pending_events();
12098 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12099 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
12100 Err(APIError::APIMisuseError { err }) =>
12101 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
12105 _ => panic!("Unexpected event"),
12107 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
12108 open_channel_msg.temporary_channel_id);
12110 // ...however if we accept the same channel 0conf it should work just fine.
12111 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12112 let events = nodes[1].node.get_and_clear_pending_events();
12114 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12115 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
12117 _ => panic!("Unexpected event"),
12119 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
12123 fn reject_excessively_underpaying_htlcs() {
12124 let chanmon_cfg = create_chanmon_cfgs(1);
12125 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12126 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12127 let node = create_network(1, &node_cfg, &node_chanmgr);
12128 let sender_intended_amt_msat = 100;
12129 let extra_fee_msat = 10;
12130 let hop_data = msgs::InboundOnionPayload::Receive {
12131 sender_intended_htlc_amt_msat: 100,
12132 cltv_expiry_height: 42,
12133 payment_metadata: None,
12134 keysend_preimage: None,
12135 payment_data: Some(msgs::FinalOnionHopData {
12136 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12138 custom_tlvs: Vec::new(),
12140 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
12141 // intended amount, we fail the payment.
12142 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12143 if let Err(crate::ln::channelmanager::InboundHTLCErr { err_code, .. }) =
12144 create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12145 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat),
12146 current_height, node[0].node.default_configuration.accept_mpp_keysend)
12148 assert_eq!(err_code, 19);
12149 } else { panic!(); }
12151 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
12152 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
12153 sender_intended_htlc_amt_msat: 100,
12154 cltv_expiry_height: 42,
12155 payment_metadata: None,
12156 keysend_preimage: None,
12157 payment_data: Some(msgs::FinalOnionHopData {
12158 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12160 custom_tlvs: Vec::new(),
12162 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12163 assert!(create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12164 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat),
12165 current_height, node[0].node.default_configuration.accept_mpp_keysend).is_ok());
12169 fn test_final_incorrect_cltv(){
12170 let chanmon_cfg = create_chanmon_cfgs(1);
12171 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12172 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12173 let node = create_network(1, &node_cfg, &node_chanmgr);
12175 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12176 let result = create_recv_pending_htlc_info(msgs::InboundOnionPayload::Receive {
12177 sender_intended_htlc_amt_msat: 100,
12178 cltv_expiry_height: 22,
12179 payment_metadata: None,
12180 keysend_preimage: None,
12181 payment_data: Some(msgs::FinalOnionHopData {
12182 payment_secret: PaymentSecret([0; 32]), total_msat: 100,
12184 custom_tlvs: Vec::new(),
12185 }, [0; 32], PaymentHash([0; 32]), 100, 23, None, true, None, current_height,
12186 node[0].node.default_configuration.accept_mpp_keysend);
12188 // Should not return an error as this condition:
12189 // https://github.com/lightning/bolts/blob/4dcc377209509b13cf89a4b91fde7d478f5b46d8/04-onion-routing.md?plain=1#L334
12190 // is not satisfied.
12191 assert!(result.is_ok());
12195 fn test_inbound_anchors_manual_acceptance() {
12196 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12197 // flag set and (sometimes) accept channels as 0conf.
12198 let mut anchors_cfg = test_default_channel_config();
12199 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12201 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
12202 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
12204 let chanmon_cfgs = create_chanmon_cfgs(3);
12205 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
12206 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
12207 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
12208 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
12210 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12211 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12213 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12214 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12215 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
12216 match &msg_events[0] {
12217 MessageSendEvent::HandleError { node_id, action } => {
12218 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
12220 ErrorAction::SendErrorMessage { msg } =>
12221 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
12222 _ => panic!("Unexpected error action"),
12225 _ => panic!("Unexpected event"),
12228 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12229 let events = nodes[2].node.get_and_clear_pending_events();
12231 Event::OpenChannelRequest { temporary_channel_id, .. } =>
12232 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
12233 _ => panic!("Unexpected event"),
12235 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12239 fn test_anchors_zero_fee_htlc_tx_fallback() {
12240 // Tests that if both nodes support anchors, but the remote node does not want to accept
12241 // anchor channels at the moment, an error it sent to the local node such that it can retry
12242 // the channel without the anchors feature.
12243 let chanmon_cfgs = create_chanmon_cfgs(2);
12244 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12245 let mut anchors_config = test_default_channel_config();
12246 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12247 anchors_config.manually_accept_inbound_channels = true;
12248 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
12249 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12251 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None, None).unwrap();
12252 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12253 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
12255 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12256 let events = nodes[1].node.get_and_clear_pending_events();
12258 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12259 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
12261 _ => panic!("Unexpected event"),
12264 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
12265 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
12267 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12268 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
12270 // Since nodes[1] should not have accepted the channel, it should
12271 // not have generated any events.
12272 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12276 fn test_update_channel_config() {
12277 let chanmon_cfg = create_chanmon_cfgs(2);
12278 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12279 let mut user_config = test_default_channel_config();
12280 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12281 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12282 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
12283 let channel = &nodes[0].node.list_channels()[0];
12285 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12286 let events = nodes[0].node.get_and_clear_pending_msg_events();
12287 assert_eq!(events.len(), 0);
12289 user_config.channel_config.forwarding_fee_base_msat += 10;
12290 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12291 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
12292 let events = nodes[0].node.get_and_clear_pending_msg_events();
12293 assert_eq!(events.len(), 1);
12295 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12296 _ => panic!("expected BroadcastChannelUpdate event"),
12299 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
12300 let events = nodes[0].node.get_and_clear_pending_msg_events();
12301 assert_eq!(events.len(), 0);
12303 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
12304 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12305 cltv_expiry_delta: Some(new_cltv_expiry_delta),
12306 ..Default::default()
12308 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12309 let events = nodes[0].node.get_and_clear_pending_msg_events();
12310 assert_eq!(events.len(), 1);
12312 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12313 _ => panic!("expected BroadcastChannelUpdate event"),
12316 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
12317 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12318 forwarding_fee_proportional_millionths: Some(new_fee),
12319 ..Default::default()
12321 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12322 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
12323 let events = nodes[0].node.get_and_clear_pending_msg_events();
12324 assert_eq!(events.len(), 1);
12326 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12327 _ => panic!("expected BroadcastChannelUpdate event"),
12330 // If we provide a channel_id not associated with the peer, we should get an error and no updates
12331 // should be applied to ensure update atomicity as specified in the API docs.
12332 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
12333 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
12334 let new_fee = current_fee + 100;
12337 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
12338 forwarding_fee_proportional_millionths: Some(new_fee),
12339 ..Default::default()
12341 Err(APIError::ChannelUnavailable { err: _ }),
12344 // Check that the fee hasn't changed for the channel that exists.
12345 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
12346 let events = nodes[0].node.get_and_clear_pending_msg_events();
12347 assert_eq!(events.len(), 0);
12351 fn test_payment_display() {
12352 let payment_id = PaymentId([42; 32]);
12353 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12354 let payment_hash = PaymentHash([42; 32]);
12355 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12356 let payment_preimage = PaymentPreimage([42; 32]);
12357 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12361 fn test_trigger_lnd_force_close() {
12362 let chanmon_cfg = create_chanmon_cfgs(2);
12363 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12364 let user_config = test_default_channel_config();
12365 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12366 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12368 // Open a channel, immediately disconnect each other, and broadcast Alice's latest state.
12369 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
12370 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
12371 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12372 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
12373 check_closed_broadcast(&nodes[0], 1, true);
12374 check_added_monitors(&nodes[0], 1);
12375 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
12377 let txn = nodes[0].tx_broadcaster.txn_broadcast();
12378 assert_eq!(txn.len(), 1);
12379 check_spends!(txn[0], funding_tx);
12382 // Since they're disconnected, Bob won't receive Alice's `Error` message. Reconnect them
12383 // such that Bob sends a `ChannelReestablish` to Alice since the channel is still open from
12385 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
12386 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
12388 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12389 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12390 }, false).unwrap();
12391 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
12392 let channel_reestablish = get_event_msg!(
12393 nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()
12395 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &channel_reestablish);
12397 // Alice should respond with an error since the channel isn't known, but a bogus
12398 // `ChannelReestablish` should be sent first, such that we actually trigger Bob to force
12399 // close even if it was an lnd node.
12400 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
12401 assert_eq!(msg_events.len(), 2);
12402 if let MessageSendEvent::SendChannelReestablish { node_id, msg } = &msg_events[0] {
12403 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
12404 assert_eq!(msg.next_local_commitment_number, 0);
12405 assert_eq!(msg.next_remote_commitment_number, 0);
12406 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &msg);
12407 } else { panic!() };
12408 check_closed_broadcast(&nodes[1], 1, true);
12409 check_added_monitors(&nodes[1], 1);
12410 let expected_close_reason = ClosureReason::ProcessingError {
12411 err: "Peer sent an invalid channel_reestablish to force close in a non-standard way".to_string()
12413 check_closed_event!(nodes[1], 1, expected_close_reason, [nodes[0].node.get_our_node_id()], 100000);
12415 let txn = nodes[1].tx_broadcaster.txn_broadcast();
12416 assert_eq!(txn.len(), 1);
12417 check_spends!(txn[0], funding_tx);
12422 fn test_malformed_forward_htlcs_ser() {
12423 // Ensure that `HTLCForwardInfo::FailMalformedHTLC`s are (de)serialized properly.
12424 let chanmon_cfg = create_chanmon_cfgs(1);
12425 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12428 let chanmgrs = create_node_chanmgrs(1, &node_cfg, &[None]);
12429 let deserialized_chanmgr;
12430 let mut nodes = create_network(1, &node_cfg, &chanmgrs);
12432 let dummy_failed_htlc = |htlc_id| {
12433 HTLCForwardInfo::FailHTLC { htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }, }
12435 let dummy_malformed_htlc = |htlc_id| {
12436 HTLCForwardInfo::FailMalformedHTLC { htlc_id, failure_code: 0x4000, sha256_of_onion: [0; 32] }
12439 let dummy_htlcs_1: Vec<HTLCForwardInfo> = (1..10).map(|htlc_id| {
12440 if htlc_id % 2 == 0 {
12441 dummy_failed_htlc(htlc_id)
12443 dummy_malformed_htlc(htlc_id)
12447 let dummy_htlcs_2: Vec<HTLCForwardInfo> = (1..10).map(|htlc_id| {
12448 if htlc_id % 2 == 1 {
12449 dummy_failed_htlc(htlc_id)
12451 dummy_malformed_htlc(htlc_id)
12456 let (scid_1, scid_2) = (42, 43);
12457 let mut forward_htlcs = HashMap::new();
12458 forward_htlcs.insert(scid_1, dummy_htlcs_1.clone());
12459 forward_htlcs.insert(scid_2, dummy_htlcs_2.clone());
12461 let mut chanmgr_fwd_htlcs = nodes[0].node.forward_htlcs.lock().unwrap();
12462 *chanmgr_fwd_htlcs = forward_htlcs.clone();
12463 core::mem::drop(chanmgr_fwd_htlcs);
12465 reload_node!(nodes[0], nodes[0].node.encode(), &[], persister, chain_monitor, deserialized_chanmgr);
12467 let mut deserialized_fwd_htlcs = nodes[0].node.forward_htlcs.lock().unwrap();
12468 for scid in [scid_1, scid_2].iter() {
12469 let deserialized_htlcs = deserialized_fwd_htlcs.remove(scid).unwrap();
12470 assert_eq!(forward_htlcs.remove(scid).unwrap(), deserialized_htlcs);
12472 assert!(deserialized_fwd_htlcs.is_empty());
12473 core::mem::drop(deserialized_fwd_htlcs);
12475 expect_pending_htlcs_forwardable!(nodes[0]);
12481 use crate::chain::Listen;
12482 use crate::chain::chainmonitor::{ChainMonitor, Persist};
12483 use crate::sign::{KeysManager, InMemorySigner};
12484 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
12485 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
12486 use crate::ln::functional_test_utils::*;
12487 use crate::ln::msgs::{ChannelMessageHandler, Init};
12488 use crate::routing::gossip::NetworkGraph;
12489 use crate::routing::router::{PaymentParameters, RouteParameters};
12490 use crate::util::test_utils;
12491 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
12493 use bitcoin::blockdata::locktime::absolute::LockTime;
12494 use bitcoin::hashes::Hash;
12495 use bitcoin::hashes::sha256::Hash as Sha256;
12496 use bitcoin::{Block, Transaction, TxOut};
12498 use crate::sync::{Arc, Mutex, RwLock};
12500 use criterion::Criterion;
12502 type Manager<'a, P> = ChannelManager<
12503 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
12504 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
12505 &'a test_utils::TestLogger, &'a P>,
12506 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
12507 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
12508 &'a test_utils::TestLogger>;
12510 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
12511 node: &'node_cfg Manager<'chan_mon_cfg, P>,
12513 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
12514 type CM = Manager<'chan_mon_cfg, P>;
12516 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
12518 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
12521 pub fn bench_sends(bench: &mut Criterion) {
12522 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
12525 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
12526 // Do a simple benchmark of sending a payment back and forth between two nodes.
12527 // Note that this is unrealistic as each payment send will require at least two fsync
12529 let network = bitcoin::Network::Testnet;
12530 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
12532 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
12533 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
12534 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
12535 let scorer = RwLock::new(test_utils::TestScorer::new());
12536 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
12538 let mut config: UserConfig = Default::default();
12539 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
12540 config.channel_handshake_config.minimum_depth = 1;
12542 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
12543 let seed_a = [1u8; 32];
12544 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
12545 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 {
12547 best_block: BestBlock::from_network(network),
12548 }, genesis_block.header.time);
12549 let node_a_holder = ANodeHolder { node: &node_a };
12551 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
12552 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
12553 let seed_b = [2u8; 32];
12554 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
12555 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 {
12557 best_block: BestBlock::from_network(network),
12558 }, genesis_block.header.time);
12559 let node_b_holder = ANodeHolder { node: &node_b };
12561 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
12562 features: node_b.init_features(), networks: None, remote_network_address: None
12564 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
12565 features: node_a.init_features(), networks: None, remote_network_address: None
12566 }, false).unwrap();
12567 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None, None).unwrap();
12568 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()));
12569 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()));
12572 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
12573 tx = Transaction { version: 2, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
12574 value: 8_000_000, script_pubkey: output_script,
12576 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
12577 } else { panic!(); }
12579 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()));
12580 let events_b = node_b.get_and_clear_pending_events();
12581 assert_eq!(events_b.len(), 1);
12582 match events_b[0] {
12583 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12584 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12586 _ => panic!("Unexpected event"),
12589 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()));
12590 let events_a = node_a.get_and_clear_pending_events();
12591 assert_eq!(events_a.len(), 1);
12592 match events_a[0] {
12593 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12594 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12596 _ => panic!("Unexpected event"),
12599 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
12601 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
12602 Listen::block_connected(&node_a, &block, 1);
12603 Listen::block_connected(&node_b, &block, 1);
12605 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()));
12606 let msg_events = node_a.get_and_clear_pending_msg_events();
12607 assert_eq!(msg_events.len(), 2);
12608 match msg_events[0] {
12609 MessageSendEvent::SendChannelReady { ref msg, .. } => {
12610 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
12611 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
12615 match msg_events[1] {
12616 MessageSendEvent::SendChannelUpdate { .. } => {},
12620 let events_a = node_a.get_and_clear_pending_events();
12621 assert_eq!(events_a.len(), 1);
12622 match events_a[0] {
12623 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12624 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12626 _ => panic!("Unexpected event"),
12629 let events_b = node_b.get_and_clear_pending_events();
12630 assert_eq!(events_b.len(), 1);
12631 match events_b[0] {
12632 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12633 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12635 _ => panic!("Unexpected event"),
12638 let mut payment_count: u64 = 0;
12639 macro_rules! send_payment {
12640 ($node_a: expr, $node_b: expr) => {
12641 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
12642 .with_bolt11_features($node_b.bolt11_invoice_features()).unwrap();
12643 let mut payment_preimage = PaymentPreimage([0; 32]);
12644 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
12645 payment_count += 1;
12646 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
12647 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
12649 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
12650 PaymentId(payment_hash.0),
12651 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
12652 Retry::Attempts(0)).unwrap();
12653 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
12654 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
12655 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
12656 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
12657 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
12658 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
12659 $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()));
12661 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
12662 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
12663 $node_b.claim_funds(payment_preimage);
12664 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
12666 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
12667 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
12668 assert_eq!(node_id, $node_a.get_our_node_id());
12669 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
12670 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
12672 _ => panic!("Failed to generate claim event"),
12675 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
12676 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
12677 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
12678 $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()));
12680 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
12684 bench.bench_function(bench_name, |b| b.iter(|| {
12685 send_payment!(node_a, node_b);
12686 send_payment!(node_b, node_a);