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_channel_id: ChannelId,
292 prev_funding_outpoint: OutPoint,
293 prev_user_channel_id: u128,
296 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
297 pub(super) enum HTLCForwardInfo {
298 AddHTLC(PendingAddHTLCInfo),
301 err_packet: msgs::OnionErrorPacket,
306 sha256_of_onion: [u8; 32],
310 /// Whether this blinded HTLC is being failed backwards by the introduction node or a blinded node,
311 /// which determines the failure message that should be used.
312 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
313 pub enum BlindedFailure {
314 /// This HTLC is being failed backwards by the introduction node, and thus should be failed with
315 /// [`msgs::UpdateFailHTLC`] and error code `0x8000|0x4000|24`.
316 FromIntroductionNode,
317 /// This HTLC is being failed backwards by a blinded node within the path, and thus should be
318 /// failed with [`msgs::UpdateFailMalformedHTLC`] and error code `0x8000|0x4000|24`.
322 /// Tracks the inbound corresponding to an outbound HTLC
323 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
324 pub(crate) struct HTLCPreviousHopData {
325 // Note that this may be an outbound SCID alias for the associated channel.
326 short_channel_id: u64,
327 user_channel_id: Option<u128>,
329 incoming_packet_shared_secret: [u8; 32],
330 phantom_shared_secret: Option<[u8; 32]>,
331 blinded_failure: Option<BlindedFailure>,
332 channel_id: ChannelId,
334 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
335 // channel with a preimage provided by the forward channel.
340 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
342 /// This is only here for backwards-compatibility in serialization, in the future it can be
343 /// removed, breaking clients running 0.0.106 and earlier.
344 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
346 /// Contains the payer-provided preimage.
347 Spontaneous(PaymentPreimage),
350 /// HTLCs that are to us and can be failed/claimed by the user
351 struct ClaimableHTLC {
352 prev_hop: HTLCPreviousHopData,
354 /// The amount (in msats) of this MPP part
356 /// The amount (in msats) that the sender intended to be sent in this MPP
357 /// part (used for validating total MPP amount)
358 sender_intended_value: u64,
359 onion_payload: OnionPayload,
361 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
362 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
363 total_value_received: Option<u64>,
364 /// The sender intended sum total of all MPP parts specified in the onion
366 /// The extra fee our counterparty skimmed off the top of this HTLC.
367 counterparty_skimmed_fee_msat: Option<u64>,
370 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
371 fn from(val: &ClaimableHTLC) -> Self {
372 events::ClaimedHTLC {
373 channel_id: val.prev_hop.channel_id,
374 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
375 cltv_expiry: val.cltv_expiry,
376 value_msat: val.value,
377 counterparty_skimmed_fee_msat: val.counterparty_skimmed_fee_msat.unwrap_or(0),
382 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
383 /// a payment and ensure idempotency in LDK.
385 /// This is not exported to bindings users as we just use [u8; 32] directly
386 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
387 pub struct PaymentId(pub [u8; Self::LENGTH]);
390 /// Number of bytes in the id.
391 pub const LENGTH: usize = 32;
394 impl Writeable for PaymentId {
395 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
400 impl Readable for PaymentId {
401 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
402 let buf: [u8; 32] = Readable::read(r)?;
407 impl core::fmt::Display for PaymentId {
408 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
409 crate::util::logger::DebugBytes(&self.0).fmt(f)
413 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
415 /// This is not exported to bindings users as we just use [u8; 32] directly
416 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
417 pub struct InterceptId(pub [u8; 32]);
419 impl Writeable for InterceptId {
420 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
425 impl Readable for InterceptId {
426 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
427 let buf: [u8; 32] = Readable::read(r)?;
432 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
433 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
434 pub(crate) enum SentHTLCId {
435 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
436 OutboundRoute { session_priv: [u8; SECRET_KEY_SIZE] },
439 pub(crate) fn from_source(source: &HTLCSource) -> Self {
441 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
442 short_channel_id: hop_data.short_channel_id,
443 htlc_id: hop_data.htlc_id,
445 HTLCSource::OutboundRoute { session_priv, .. } =>
446 Self::OutboundRoute { session_priv: session_priv.secret_bytes() },
450 impl_writeable_tlv_based_enum!(SentHTLCId,
451 (0, PreviousHopData) => {
452 (0, short_channel_id, required),
453 (2, htlc_id, required),
455 (2, OutboundRoute) => {
456 (0, session_priv, required),
461 /// Tracks the inbound corresponding to an outbound HTLC
462 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
463 #[derive(Clone, Debug, PartialEq, Eq)]
464 pub(crate) enum HTLCSource {
465 PreviousHopData(HTLCPreviousHopData),
468 session_priv: SecretKey,
469 /// Technically we can recalculate this from the route, but we cache it here to avoid
470 /// doing a double-pass on route when we get a failure back
471 first_hop_htlc_msat: u64,
472 payment_id: PaymentId,
475 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
476 impl core::hash::Hash for HTLCSource {
477 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
479 HTLCSource::PreviousHopData(prev_hop_data) => {
481 prev_hop_data.hash(hasher);
483 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
486 session_priv[..].hash(hasher);
487 payment_id.hash(hasher);
488 first_hop_htlc_msat.hash(hasher);
494 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
496 pub fn dummy() -> Self {
497 HTLCSource::OutboundRoute {
498 path: Path { hops: Vec::new(), blinded_tail: None },
499 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
500 first_hop_htlc_msat: 0,
501 payment_id: PaymentId([2; 32]),
505 #[cfg(debug_assertions)]
506 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
507 /// transaction. Useful to ensure different datastructures match up.
508 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
509 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
510 *first_hop_htlc_msat == htlc.amount_msat
512 // There's nothing we can check for forwarded HTLCs
518 /// This enum is used to specify which error data to send to peers when failing back an HTLC
519 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
521 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
522 #[derive(Clone, Copy)]
523 pub enum FailureCode {
524 /// We had a temporary error processing the payment. Useful if no other error codes fit
525 /// and you want to indicate that the payer may want to retry.
526 TemporaryNodeFailure,
527 /// We have a required feature which was not in this onion. For example, you may require
528 /// some additional metadata that was not provided with this payment.
529 RequiredNodeFeatureMissing,
530 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
531 /// the HTLC is too close to the current block height for safe handling.
532 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
533 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
534 IncorrectOrUnknownPaymentDetails,
535 /// We failed to process the payload after the onion was decrypted. You may wish to
536 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
538 /// If available, the tuple data may include the type number and byte offset in the
539 /// decrypted byte stream where the failure occurred.
540 InvalidOnionPayload(Option<(u64, u16)>),
543 impl Into<u16> for FailureCode {
544 fn into(self) -> u16 {
546 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
547 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
548 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
549 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
554 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
555 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
556 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
557 /// peer_state lock. We then return the set of things that need to be done outside the lock in
558 /// this struct and call handle_error!() on it.
560 struct MsgHandleErrInternal {
561 err: msgs::LightningError,
562 closes_channel: bool,
563 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
565 impl MsgHandleErrInternal {
567 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
569 err: LightningError {
571 action: msgs::ErrorAction::SendErrorMessage {
572 msg: msgs::ErrorMessage {
578 closes_channel: false,
579 shutdown_finish: None,
583 fn from_no_close(err: msgs::LightningError) -> Self {
584 Self { err, closes_channel: false, shutdown_finish: None }
587 fn from_finish_shutdown(err: String, channel_id: ChannelId, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
588 let err_msg = msgs::ErrorMessage { channel_id, data: err.clone() };
589 let action = if shutdown_res.monitor_update.is_some() {
590 // We have a closing `ChannelMonitorUpdate`, which means the channel was funded and we
591 // should disconnect our peer such that we force them to broadcast their latest
592 // commitment upon reconnecting.
593 msgs::ErrorAction::DisconnectPeer { msg: Some(err_msg) }
595 msgs::ErrorAction::SendErrorMessage { msg: err_msg }
598 err: LightningError { err, action },
599 closes_channel: true,
600 shutdown_finish: Some((shutdown_res, channel_update)),
604 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
607 ChannelError::Warn(msg) => LightningError {
609 action: msgs::ErrorAction::SendWarningMessage {
610 msg: msgs::WarningMessage {
614 log_level: Level::Warn,
617 ChannelError::Ignore(msg) => LightningError {
619 action: msgs::ErrorAction::IgnoreError,
621 ChannelError::Close(msg) => LightningError {
623 action: msgs::ErrorAction::SendErrorMessage {
624 msg: msgs::ErrorMessage {
631 closes_channel: false,
632 shutdown_finish: None,
636 fn closes_channel(&self) -> bool {
641 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
642 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
643 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
644 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
645 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
647 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
648 /// be sent in the order they appear in the return value, however sometimes the order needs to be
649 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
650 /// they were originally sent). In those cases, this enum is also returned.
651 #[derive(Clone, PartialEq)]
652 pub(super) enum RAACommitmentOrder {
653 /// Send the CommitmentUpdate messages first
655 /// Send the RevokeAndACK message first
659 /// Information about a payment which is currently being claimed.
660 struct ClaimingPayment {
662 payment_purpose: events::PaymentPurpose,
663 receiver_node_id: PublicKey,
664 htlcs: Vec<events::ClaimedHTLC>,
665 sender_intended_value: Option<u64>,
667 impl_writeable_tlv_based!(ClaimingPayment, {
668 (0, amount_msat, required),
669 (2, payment_purpose, required),
670 (4, receiver_node_id, required),
671 (5, htlcs, optional_vec),
672 (7, sender_intended_value, option),
675 struct ClaimablePayment {
676 purpose: events::PaymentPurpose,
677 onion_fields: Option<RecipientOnionFields>,
678 htlcs: Vec<ClaimableHTLC>,
681 /// Information about claimable or being-claimed payments
682 struct ClaimablePayments {
683 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
684 /// failed/claimed by the user.
686 /// Note that, no consistency guarantees are made about the channels given here actually
687 /// existing anymore by the time you go to read them!
689 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
690 /// we don't get a duplicate payment.
691 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
693 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
694 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
695 /// as an [`events::Event::PaymentClaimed`].
696 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
699 /// Events which we process internally but cannot be processed immediately at the generation site
700 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
701 /// running normally, and specifically must be processed before any other non-background
702 /// [`ChannelMonitorUpdate`]s are applied.
704 enum BackgroundEvent {
705 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
706 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
707 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
708 /// channel has been force-closed we do not need the counterparty node_id.
710 /// Note that any such events are lost on shutdown, so in general they must be updates which
711 /// are regenerated on startup.
712 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelId, ChannelMonitorUpdate)),
713 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
714 /// channel to continue normal operation.
716 /// In general this should be used rather than
717 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
718 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
719 /// error the other variant is acceptable.
721 /// Note that any such events are lost on shutdown, so in general they must be updates which
722 /// are regenerated on startup.
723 MonitorUpdateRegeneratedOnStartup {
724 counterparty_node_id: PublicKey,
725 funding_txo: OutPoint,
726 channel_id: ChannelId,
727 update: ChannelMonitorUpdate
729 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
730 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
732 MonitorUpdatesComplete {
733 counterparty_node_id: PublicKey,
734 channel_id: ChannelId,
739 pub(crate) enum MonitorUpdateCompletionAction {
740 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
741 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
742 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
743 /// event can be generated.
744 PaymentClaimed { payment_hash: PaymentHash },
745 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
746 /// operation of another channel.
748 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
749 /// from completing a monitor update which removes the payment preimage until the inbound edge
750 /// completes a monitor update containing the payment preimage. In that case, after the inbound
751 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
753 EmitEventAndFreeOtherChannel {
754 event: events::Event,
755 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, ChannelId, RAAMonitorUpdateBlockingAction)>,
757 /// Indicates we should immediately resume the operation of another channel, unless there is
758 /// some other reason why the channel is blocked. In practice this simply means immediately
759 /// removing the [`RAAMonitorUpdateBlockingAction`] provided from the blocking set.
761 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
762 /// from completing a monitor update which removes the payment preimage until the inbound edge
763 /// completes a monitor update containing the payment preimage. However, we use this variant
764 /// instead of [`Self::EmitEventAndFreeOtherChannel`] when we discover that the claim was in
765 /// fact duplicative and we simply want to resume the outbound edge channel immediately.
767 /// This variant should thus never be written to disk, as it is processed inline rather than
768 /// stored for later processing.
769 FreeOtherChannelImmediately {
770 downstream_counterparty_node_id: PublicKey,
771 downstream_funding_outpoint: OutPoint,
772 blocking_action: RAAMonitorUpdateBlockingAction,
773 downstream_channel_id: ChannelId,
777 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
778 (0, PaymentClaimed) => { (0, payment_hash, required) },
779 // Note that FreeOtherChannelImmediately should never be written - we were supposed to free
780 // *immediately*. However, for simplicity we implement read/write here.
781 (1, FreeOtherChannelImmediately) => {
782 (0, downstream_counterparty_node_id, required),
783 (2, downstream_funding_outpoint, required),
784 (4, blocking_action, required),
785 // Note that by the time we get past the required read above, downstream_funding_outpoint will be
786 // filled in, so we can safely unwrap it here.
787 (5, downstream_channel_id, (default_value, ChannelId::v1_from_funding_outpoint(downstream_funding_outpoint.0.unwrap()))),
789 (2, EmitEventAndFreeOtherChannel) => {
790 (0, event, upgradable_required),
791 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
792 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
793 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
794 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
795 // downgrades to prior versions.
796 (1, downstream_counterparty_and_funding_outpoint, option),
800 #[derive(Clone, Debug, PartialEq, Eq)]
801 pub(crate) enum EventCompletionAction {
802 ReleaseRAAChannelMonitorUpdate {
803 counterparty_node_id: PublicKey,
804 channel_funding_outpoint: OutPoint,
805 channel_id: ChannelId,
808 impl_writeable_tlv_based_enum!(EventCompletionAction,
809 (0, ReleaseRAAChannelMonitorUpdate) => {
810 (0, channel_funding_outpoint, required),
811 (2, counterparty_node_id, required),
812 // Note that by the time we get past the required read above, channel_funding_outpoint will be
813 // filled in, so we can safely unwrap it here.
814 (3, channel_id, (default_value, ChannelId::v1_from_funding_outpoint(channel_funding_outpoint.0.unwrap()))),
818 #[derive(Clone, PartialEq, Eq, Debug)]
819 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
820 /// the blocked action here. See enum variants for more info.
821 pub(crate) enum RAAMonitorUpdateBlockingAction {
822 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
823 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
825 ForwardedPaymentInboundClaim {
826 /// The upstream channel ID (i.e. the inbound edge).
827 channel_id: ChannelId,
828 /// The HTLC ID on the inbound edge.
833 impl RAAMonitorUpdateBlockingAction {
834 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
835 Self::ForwardedPaymentInboundClaim {
836 channel_id: prev_hop.channel_id,
837 htlc_id: prev_hop.htlc_id,
842 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
843 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
847 /// State we hold per-peer.
848 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
849 /// `channel_id` -> `ChannelPhase`
851 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
852 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
853 /// `temporary_channel_id` -> `InboundChannelRequest`.
855 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
856 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
857 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
858 /// the channel is rejected, then the entry is simply removed.
859 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
860 /// The latest `InitFeatures` we heard from the peer.
861 latest_features: InitFeatures,
862 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
863 /// for broadcast messages, where ordering isn't as strict).
864 pub(super) pending_msg_events: Vec<MessageSendEvent>,
865 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
866 /// user but which have not yet completed.
868 /// Note that the channel may no longer exist. For example if the channel was closed but we
869 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
870 /// for a missing channel.
871 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
872 /// Map from a specific channel to some action(s) that should be taken when all pending
873 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
875 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
876 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
877 /// channels with a peer this will just be one allocation and will amount to a linear list of
878 /// channels to walk, avoiding the whole hashing rigmarole.
880 /// Note that the channel may no longer exist. For example, if a channel was closed but we
881 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
882 /// for a missing channel. While a malicious peer could construct a second channel with the
883 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
884 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
885 /// duplicates do not occur, so such channels should fail without a monitor update completing.
886 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
887 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
888 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
889 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
890 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
891 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
892 /// The peer is currently connected (i.e. we've seen a
893 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
894 /// [`ChannelMessageHandler::peer_disconnected`].
898 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
899 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
900 /// If true is passed for `require_disconnected`, the function will return false if we haven't
901 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
902 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
903 if require_disconnected && self.is_connected {
906 self.channel_by_id.iter().filter(|(_, phase)| matches!(phase, ChannelPhase::Funded(_))).count() == 0
907 && self.monitor_update_blocked_actions.is_empty()
908 && self.in_flight_monitor_updates.is_empty()
911 // Returns a count of all channels we have with this peer, including unfunded channels.
912 fn total_channel_count(&self) -> usize {
913 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
916 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
917 fn has_channel(&self, channel_id: &ChannelId) -> bool {
918 self.channel_by_id.contains_key(channel_id) ||
919 self.inbound_channel_request_by_id.contains_key(channel_id)
923 /// A not-yet-accepted inbound (from counterparty) channel. Once
924 /// accepted, the parameters will be used to construct a channel.
925 pub(super) struct InboundChannelRequest {
926 /// The original OpenChannel message.
927 pub open_channel_msg: msgs::OpenChannel,
928 /// The number of ticks remaining before the request expires.
929 pub ticks_remaining: i32,
932 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
933 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
934 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
936 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
937 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
939 /// For users who don't want to bother doing their own payment preimage storage, we also store that
942 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
943 /// and instead encoding it in the payment secret.
944 struct PendingInboundPayment {
945 /// The payment secret that the sender must use for us to accept this payment
946 payment_secret: PaymentSecret,
947 /// Time at which this HTLC expires - blocks with a header time above this value will result in
948 /// this payment being removed.
950 /// Arbitrary identifier the user specifies (or not)
951 user_payment_id: u64,
952 // Other required attributes of the payment, optionally enforced:
953 payment_preimage: Option<PaymentPreimage>,
954 min_value_msat: Option<u64>,
957 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
958 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
959 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
960 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
961 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
962 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
963 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
964 /// of [`KeysManager`] and [`DefaultRouter`].
966 /// This is not exported to bindings users as type aliases aren't supported in most languages.
967 #[cfg(not(c_bindings))]
968 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
976 Arc<NetworkGraph<Arc<L>>>,
978 Arc<RwLock<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
979 ProbabilisticScoringFeeParameters,
980 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
985 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
986 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
987 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
988 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
989 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
990 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
991 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
992 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
993 /// of [`KeysManager`] and [`DefaultRouter`].
995 /// This is not exported to bindings users as type aliases aren't supported in most languages.
996 #[cfg(not(c_bindings))]
997 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
1006 &'f NetworkGraph<&'g L>,
1008 &'h RwLock<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
1009 ProbabilisticScoringFeeParameters,
1010 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
1015 /// A trivial trait which describes any [`ChannelManager`].
1017 /// This is not exported to bindings users as general cover traits aren't useful in other
1019 pub trait AChannelManager {
1020 /// A type implementing [`chain::Watch`].
1021 type Watch: chain::Watch<Self::Signer> + ?Sized;
1022 /// A type that may be dereferenced to [`Self::Watch`].
1023 type M: Deref<Target = Self::Watch>;
1024 /// A type implementing [`BroadcasterInterface`].
1025 type Broadcaster: BroadcasterInterface + ?Sized;
1026 /// A type that may be dereferenced to [`Self::Broadcaster`].
1027 type T: Deref<Target = Self::Broadcaster>;
1028 /// A type implementing [`EntropySource`].
1029 type EntropySource: EntropySource + ?Sized;
1030 /// A type that may be dereferenced to [`Self::EntropySource`].
1031 type ES: Deref<Target = Self::EntropySource>;
1032 /// A type implementing [`NodeSigner`].
1033 type NodeSigner: NodeSigner + ?Sized;
1034 /// A type that may be dereferenced to [`Self::NodeSigner`].
1035 type NS: Deref<Target = Self::NodeSigner>;
1036 /// A type implementing [`WriteableEcdsaChannelSigner`].
1037 type Signer: WriteableEcdsaChannelSigner + Sized;
1038 /// A type implementing [`SignerProvider`] for [`Self::Signer`].
1039 type SignerProvider: SignerProvider<EcdsaSigner= Self::Signer> + ?Sized;
1040 /// A type that may be dereferenced to [`Self::SignerProvider`].
1041 type SP: Deref<Target = Self::SignerProvider>;
1042 /// A type implementing [`FeeEstimator`].
1043 type FeeEstimator: FeeEstimator + ?Sized;
1044 /// A type that may be dereferenced to [`Self::FeeEstimator`].
1045 type F: Deref<Target = Self::FeeEstimator>;
1046 /// A type implementing [`Router`].
1047 type Router: Router + ?Sized;
1048 /// A type that may be dereferenced to [`Self::Router`].
1049 type R: Deref<Target = Self::Router>;
1050 /// A type implementing [`Logger`].
1051 type Logger: Logger + ?Sized;
1052 /// A type that may be dereferenced to [`Self::Logger`].
1053 type L: Deref<Target = Self::Logger>;
1054 /// Returns a reference to the actual [`ChannelManager`] object.
1055 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
1058 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
1059 for ChannelManager<M, T, ES, NS, SP, F, R, L>
1061 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
1062 T::Target: BroadcasterInterface,
1063 ES::Target: EntropySource,
1064 NS::Target: NodeSigner,
1065 SP::Target: SignerProvider,
1066 F::Target: FeeEstimator,
1070 type Watch = M::Target;
1072 type Broadcaster = T::Target;
1074 type EntropySource = ES::Target;
1076 type NodeSigner = NS::Target;
1078 type Signer = <SP::Target as SignerProvider>::EcdsaSigner;
1079 type SignerProvider = SP::Target;
1081 type FeeEstimator = F::Target;
1083 type Router = R::Target;
1085 type Logger = L::Target;
1087 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
1090 /// Manager which keeps track of a number of channels and sends messages to the appropriate
1091 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
1093 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
1094 /// to individual Channels.
1096 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
1097 /// all peers during write/read (though does not modify this instance, only the instance being
1098 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
1099 /// called [`funding_transaction_generated`] for outbound channels) being closed.
1101 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
1102 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST durably write each
1103 /// [`ChannelMonitorUpdate`] before returning from
1104 /// [`chain::Watch::watch_channel`]/[`update_channel`] or before completing async writes. With
1105 /// `ChannelManager`s, writing updates happens out-of-band (and will prevent any other
1106 /// `ChannelManager` operations from occurring during the serialization process). If the
1107 /// deserialized version is out-of-date compared to the [`ChannelMonitor`] passed by reference to
1108 /// [`read`], those channels will be force-closed based on the `ChannelMonitor` state and no funds
1109 /// will be lost (modulo on-chain transaction fees).
1111 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
1112 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
1113 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
1115 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
1116 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
1117 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
1118 /// offline for a full minute. In order to track this, you must call
1119 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
1121 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
1122 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
1123 /// not have a channel with being unable to connect to us or open new channels with us if we have
1124 /// many peers with unfunded channels.
1126 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
1127 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
1128 /// never limited. Please ensure you limit the count of such channels yourself.
1130 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
1131 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
1132 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
1133 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
1134 /// you're using lightning-net-tokio.
1136 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
1137 /// [`funding_created`]: msgs::FundingCreated
1138 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
1139 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
1140 /// [`update_channel`]: chain::Watch::update_channel
1141 /// [`ChannelUpdate`]: msgs::ChannelUpdate
1142 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
1143 /// [`read`]: ReadableArgs::read
1146 // The tree structure below illustrates the lock order requirements for the different locks of the
1147 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
1148 // and should then be taken in the order of the lowest to the highest level in the tree.
1149 // Note that locks on different branches shall not be taken at the same time, as doing so will
1150 // create a new lock order for those specific locks in the order they were taken.
1154 // `pending_offers_messages`
1156 // `total_consistency_lock`
1158 // |__`forward_htlcs`
1160 // | |__`pending_intercepted_htlcs`
1162 // |__`per_peer_state`
1164 // |__`pending_inbound_payments`
1166 // |__`claimable_payments`
1168 // |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
1172 // |__`outpoint_to_peer`
1174 // |__`short_to_chan_info`
1176 // |__`outbound_scid_aliases`
1180 // |__`pending_events`
1182 // |__`pending_background_events`
1184 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
1186 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
1187 T::Target: BroadcasterInterface,
1188 ES::Target: EntropySource,
1189 NS::Target: NodeSigner,
1190 SP::Target: SignerProvider,
1191 F::Target: FeeEstimator,
1195 default_configuration: UserConfig,
1196 chain_hash: ChainHash,
1197 fee_estimator: LowerBoundedFeeEstimator<F>,
1203 /// See `ChannelManager` struct-level documentation for lock order requirements.
1205 pub(super) best_block: RwLock<BestBlock>,
1207 best_block: RwLock<BestBlock>,
1208 secp_ctx: Secp256k1<secp256k1::All>,
1210 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1211 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1212 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1213 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1215 /// See `ChannelManager` struct-level documentation for lock order requirements.
1216 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1218 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1219 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1220 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1221 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1222 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1223 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1224 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1225 /// after reloading from disk while replaying blocks against ChannelMonitors.
1227 /// See `PendingOutboundPayment` documentation for more info.
1229 /// See `ChannelManager` struct-level documentation for lock order requirements.
1230 pending_outbound_payments: OutboundPayments,
1232 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1234 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1235 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1236 /// and via the classic SCID.
1238 /// Note that no consistency guarantees are made about the existence of a channel with the
1239 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1241 /// See `ChannelManager` struct-level documentation for lock order requirements.
1243 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1245 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1246 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1247 /// until the user tells us what we should do with them.
1249 /// See `ChannelManager` struct-level documentation for lock order requirements.
1250 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1252 /// The sets of payments which are claimable or currently being claimed. See
1253 /// [`ClaimablePayments`]' individual field docs for more info.
1255 /// See `ChannelManager` struct-level documentation for lock order requirements.
1256 claimable_payments: Mutex<ClaimablePayments>,
1258 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1259 /// and some closed channels which reached a usable state prior to being closed. This is used
1260 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1261 /// active channel list on load.
1263 /// See `ChannelManager` struct-level documentation for lock order requirements.
1264 outbound_scid_aliases: Mutex<HashSet<u64>>,
1266 /// Channel funding outpoint -> `counterparty_node_id`.
1268 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1269 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1270 /// the handling of the events.
1272 /// Note that no consistency guarantees are made about the existence of a peer with the
1273 /// `counterparty_node_id` in our other maps.
1276 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1277 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1278 /// would break backwards compatability.
1279 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1280 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1281 /// required to access the channel with the `counterparty_node_id`.
1283 /// See `ChannelManager` struct-level documentation for lock order requirements.
1285 outpoint_to_peer: Mutex<HashMap<OutPoint, PublicKey>>,
1287 pub(crate) outpoint_to_peer: Mutex<HashMap<OutPoint, PublicKey>>,
1289 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1291 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1292 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1293 /// confirmation depth.
1295 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1296 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1297 /// channel with the `channel_id` in our other maps.
1299 /// See `ChannelManager` struct-level documentation for lock order requirements.
1301 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1303 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1305 our_network_pubkey: PublicKey,
1307 inbound_payment_key: inbound_payment::ExpandedKey,
1309 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1310 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1311 /// we encrypt the namespace identifier using these bytes.
1313 /// [fake scids]: crate::util::scid_utils::fake_scid
1314 fake_scid_rand_bytes: [u8; 32],
1316 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1317 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1318 /// keeping additional state.
1319 probing_cookie_secret: [u8; 32],
1321 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1322 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1323 /// very far in the past, and can only ever be up to two hours in the future.
1324 highest_seen_timestamp: AtomicUsize,
1326 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1327 /// basis, as well as the peer's latest features.
1329 /// If we are connected to a peer we always at least have an entry here, even if no channels
1330 /// are currently open with that peer.
1332 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1333 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1336 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1338 /// See `ChannelManager` struct-level documentation for lock order requirements.
1339 #[cfg(not(any(test, feature = "_test_utils")))]
1340 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1341 #[cfg(any(test, feature = "_test_utils"))]
1342 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1344 /// The set of events which we need to give to the user to handle. In some cases an event may
1345 /// require some further action after the user handles it (currently only blocking a monitor
1346 /// update from being handed to the user to ensure the included changes to the channel state
1347 /// are handled by the user before they're persisted durably to disk). In that case, the second
1348 /// element in the tuple is set to `Some` with further details of the action.
1350 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1351 /// could be in the middle of being processed without the direct mutex held.
1353 /// See `ChannelManager` struct-level documentation for lock order requirements.
1354 #[cfg(not(any(test, feature = "_test_utils")))]
1355 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1356 #[cfg(any(test, feature = "_test_utils"))]
1357 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1359 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1360 pending_events_processor: AtomicBool,
1362 /// If we are running during init (either directly during the deserialization method or in
1363 /// block connection methods which run after deserialization but before normal operation) we
1364 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1365 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1366 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1368 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1370 /// See `ChannelManager` struct-level documentation for lock order requirements.
1372 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1373 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1374 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1375 /// Essentially just when we're serializing ourselves out.
1376 /// Taken first everywhere where we are making changes before any other locks.
1377 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1378 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1379 /// Notifier the lock contains sends out a notification when the lock is released.
1380 total_consistency_lock: RwLock<()>,
1381 /// Tracks the progress of channels going through batch funding by whether funding_signed was
1382 /// received and the monitor has been persisted.
1384 /// This information does not need to be persisted as funding nodes can forget
1385 /// unfunded channels upon disconnection.
1386 funding_batch_states: Mutex<BTreeMap<Txid, Vec<(ChannelId, PublicKey, bool)>>>,
1388 background_events_processed_since_startup: AtomicBool,
1390 event_persist_notifier: Notifier,
1391 needs_persist_flag: AtomicBool,
1393 pending_offers_messages: Mutex<Vec<PendingOnionMessage<OffersMessage>>>,
1397 signer_provider: SP,
1402 /// Chain-related parameters used to construct a new `ChannelManager`.
1404 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1405 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1406 /// are not needed when deserializing a previously constructed `ChannelManager`.
1407 #[derive(Clone, Copy, PartialEq)]
1408 pub struct ChainParameters {
1409 /// The network for determining the `chain_hash` in Lightning messages.
1410 pub network: Network,
1412 /// The hash and height of the latest block successfully connected.
1414 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1415 pub best_block: BestBlock,
1418 #[derive(Copy, Clone, PartialEq)]
1422 SkipPersistHandleEvents,
1423 SkipPersistNoEvents,
1426 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1427 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1428 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1429 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1430 /// sending the aforementioned notification (since the lock being released indicates that the
1431 /// updates are ready for persistence).
1433 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1434 /// notify or not based on whether relevant changes have been made, providing a closure to
1435 /// `optionally_notify` which returns a `NotifyOption`.
1436 struct PersistenceNotifierGuard<'a, F: FnMut() -> NotifyOption> {
1437 event_persist_notifier: &'a Notifier,
1438 needs_persist_flag: &'a AtomicBool,
1440 // We hold onto this result so the lock doesn't get released immediately.
1441 _read_guard: RwLockReadGuard<'a, ()>,
1444 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1445 /// Notifies any waiters and indicates that we need to persist, in addition to possibly having
1446 /// events to handle.
1448 /// This must always be called if the changes included a `ChannelMonitorUpdate`, as well as in
1449 /// other cases where losing the changes on restart may result in a force-close or otherwise
1451 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1452 Self::optionally_notify(cm, || -> NotifyOption { NotifyOption::DoPersist })
1455 fn optionally_notify<F: FnMut() -> NotifyOption, C: AChannelManager>(cm: &'a C, mut persist_check: F)
1456 -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1457 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1458 let force_notify = cm.get_cm().process_background_events();
1460 PersistenceNotifierGuard {
1461 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1462 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1463 should_persist: move || {
1464 // Pick the "most" action between `persist_check` and the background events
1465 // processing and return that.
1466 let notify = persist_check();
1467 match (notify, force_notify) {
1468 (NotifyOption::DoPersist, _) => NotifyOption::DoPersist,
1469 (_, NotifyOption::DoPersist) => NotifyOption::DoPersist,
1470 (NotifyOption::SkipPersistHandleEvents, _) => NotifyOption::SkipPersistHandleEvents,
1471 (_, NotifyOption::SkipPersistHandleEvents) => NotifyOption::SkipPersistHandleEvents,
1472 _ => NotifyOption::SkipPersistNoEvents,
1475 _read_guard: read_guard,
1479 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1480 /// [`ChannelManager::process_background_events`] MUST be called first (or
1481 /// [`Self::optionally_notify`] used).
1482 fn optionally_notify_skipping_background_events<F: Fn() -> NotifyOption, C: AChannelManager>
1483 (cm: &'a C, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1484 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1486 PersistenceNotifierGuard {
1487 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1488 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1489 should_persist: persist_check,
1490 _read_guard: read_guard,
1495 impl<'a, F: FnMut() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1496 fn drop(&mut self) {
1497 match (self.should_persist)() {
1498 NotifyOption::DoPersist => {
1499 self.needs_persist_flag.store(true, Ordering::Release);
1500 self.event_persist_notifier.notify()
1502 NotifyOption::SkipPersistHandleEvents =>
1503 self.event_persist_notifier.notify(),
1504 NotifyOption::SkipPersistNoEvents => {},
1509 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1510 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1512 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1514 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1515 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1516 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1517 /// the maximum required amount in lnd as of March 2021.
1518 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1520 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1521 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1523 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1525 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1526 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1527 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1528 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1529 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1530 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1531 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1532 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1533 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1534 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1535 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1536 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1537 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1539 /// Minimum CLTV difference between the current block height and received inbound payments.
1540 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1542 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1543 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1544 // a payment was being routed, so we add an extra block to be safe.
1545 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1547 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1548 // ie that if the next-hop peer fails the HTLC within
1549 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1550 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1551 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1552 // LATENCY_GRACE_PERIOD_BLOCKS.
1554 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;
1556 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1557 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1559 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1561 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1562 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1564 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1565 /// until we mark the channel disabled and gossip the update.
1566 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1568 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1569 /// we mark the channel enabled and gossip the update.
1570 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1572 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1573 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1574 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1575 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1577 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1578 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1579 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1581 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1582 /// many peers we reject new (inbound) connections.
1583 const MAX_NO_CHANNEL_PEERS: usize = 250;
1585 /// Information needed for constructing an invoice route hint for this channel.
1586 #[derive(Clone, Debug, PartialEq)]
1587 pub struct CounterpartyForwardingInfo {
1588 /// Base routing fee in millisatoshis.
1589 pub fee_base_msat: u32,
1590 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1591 pub fee_proportional_millionths: u32,
1592 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1593 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1594 /// `cltv_expiry_delta` for more details.
1595 pub cltv_expiry_delta: u16,
1598 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1599 /// to better separate parameters.
1600 #[derive(Clone, Debug, PartialEq)]
1601 pub struct ChannelCounterparty {
1602 /// The node_id of our counterparty
1603 pub node_id: PublicKey,
1604 /// The Features the channel counterparty provided upon last connection.
1605 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1606 /// many routing-relevant features are present in the init context.
1607 pub features: InitFeatures,
1608 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1609 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1610 /// claiming at least this value on chain.
1612 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1614 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1615 pub unspendable_punishment_reserve: u64,
1616 /// Information on the fees and requirements that the counterparty requires when forwarding
1617 /// payments to us through this channel.
1618 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1619 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1620 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1621 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1622 pub outbound_htlc_minimum_msat: Option<u64>,
1623 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1624 pub outbound_htlc_maximum_msat: Option<u64>,
1627 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1628 #[derive(Clone, Debug, PartialEq)]
1629 pub struct ChannelDetails {
1630 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1631 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1632 /// Note that this means this value is *not* persistent - it can change once during the
1633 /// lifetime of the channel.
1634 pub channel_id: ChannelId,
1635 /// Parameters which apply to our counterparty. See individual fields for more information.
1636 pub counterparty: ChannelCounterparty,
1637 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1638 /// our counterparty already.
1640 /// Note that, if this has been set, `channel_id` for V1-established channels will be equivalent to
1641 /// `ChannelId::v1_from_funding_outpoint(funding_txo.unwrap())`.
1642 pub funding_txo: Option<OutPoint>,
1643 /// The features which this channel operates with. See individual features for more info.
1645 /// `None` until negotiation completes and the channel type is finalized.
1646 pub channel_type: Option<ChannelTypeFeatures>,
1647 /// The position of the funding transaction in the chain. None if the funding transaction has
1648 /// not yet been confirmed and the channel fully opened.
1650 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1651 /// payments instead of this. See [`get_inbound_payment_scid`].
1653 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1654 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1656 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1657 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1658 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1659 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1660 /// [`confirmations_required`]: Self::confirmations_required
1661 pub short_channel_id: Option<u64>,
1662 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1663 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1664 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1667 /// This will be `None` as long as the channel is not available for routing outbound payments.
1669 /// [`short_channel_id`]: Self::short_channel_id
1670 /// [`confirmations_required`]: Self::confirmations_required
1671 pub outbound_scid_alias: Option<u64>,
1672 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1673 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1674 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1675 /// when they see a payment to be routed to us.
1677 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1678 /// previous values for inbound payment forwarding.
1680 /// [`short_channel_id`]: Self::short_channel_id
1681 pub inbound_scid_alias: Option<u64>,
1682 /// The value, in satoshis, of this channel as appears in the funding output
1683 pub channel_value_satoshis: u64,
1684 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1685 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1686 /// this value on chain.
1688 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1690 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1692 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1693 pub unspendable_punishment_reserve: Option<u64>,
1694 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1695 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1696 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1697 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1698 /// serialized with LDK versions prior to 0.0.113.
1700 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1701 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1702 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1703 pub user_channel_id: u128,
1704 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1705 /// which is applied to commitment and HTLC transactions.
1707 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1708 pub feerate_sat_per_1000_weight: Option<u32>,
1709 /// Our total balance. This is the amount we would get if we close the channel.
1710 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1711 /// amount is not likely to be recoverable on close.
1713 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1714 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1715 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1716 /// This does not consider any on-chain fees.
1718 /// See also [`ChannelDetails::outbound_capacity_msat`]
1719 pub balance_msat: u64,
1720 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1721 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1722 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1723 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1725 /// See also [`ChannelDetails::balance_msat`]
1727 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1728 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1729 /// should be able to spend nearly this amount.
1730 pub outbound_capacity_msat: u64,
1731 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1732 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1733 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1734 /// to use a limit as close as possible to the HTLC limit we can currently send.
1736 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1737 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1738 pub next_outbound_htlc_limit_msat: u64,
1739 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1740 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1741 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1742 /// route which is valid.
1743 pub next_outbound_htlc_minimum_msat: u64,
1744 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1745 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1746 /// available for inclusion in new inbound HTLCs).
1747 /// Note that there are some corner cases not fully handled here, so the actual available
1748 /// inbound capacity may be slightly higher than this.
1750 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1751 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1752 /// However, our counterparty should be able to spend nearly this amount.
1753 pub inbound_capacity_msat: u64,
1754 /// The number of required confirmations on the funding transaction before the funding will be
1755 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1756 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1757 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1758 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1760 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1762 /// [`is_outbound`]: ChannelDetails::is_outbound
1763 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1764 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1765 pub confirmations_required: Option<u32>,
1766 /// The current number of confirmations on the funding transaction.
1768 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1769 pub confirmations: Option<u32>,
1770 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1771 /// until we can claim our funds after we force-close the channel. During this time our
1772 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1773 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1774 /// time to claim our non-HTLC-encumbered funds.
1776 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1777 pub force_close_spend_delay: Option<u16>,
1778 /// True if the channel was initiated (and thus funded) by us.
1779 pub is_outbound: bool,
1780 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1781 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1782 /// required confirmation count has been reached (and we were connected to the peer at some
1783 /// point after the funding transaction received enough confirmations). The required
1784 /// confirmation count is provided in [`confirmations_required`].
1786 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1787 pub is_channel_ready: bool,
1788 /// The stage of the channel's shutdown.
1789 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1790 pub channel_shutdown_state: Option<ChannelShutdownState>,
1791 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1792 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1794 /// This is a strict superset of `is_channel_ready`.
1795 pub is_usable: bool,
1796 /// True if this channel is (or will be) publicly-announced.
1797 pub is_public: bool,
1798 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1799 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1800 pub inbound_htlc_minimum_msat: Option<u64>,
1801 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1802 pub inbound_htlc_maximum_msat: Option<u64>,
1803 /// Set of configurable parameters that affect channel operation.
1805 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1806 pub config: Option<ChannelConfig>,
1809 impl ChannelDetails {
1810 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1811 /// This should be used for providing invoice hints or in any other context where our
1812 /// counterparty will forward a payment to us.
1814 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1815 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1816 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1817 self.inbound_scid_alias.or(self.short_channel_id)
1820 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1821 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1822 /// we're sending or forwarding a payment outbound over this channel.
1824 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1825 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1826 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1827 self.short_channel_id.or(self.outbound_scid_alias)
1830 fn from_channel_context<SP: Deref, F: Deref>(
1831 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1832 fee_estimator: &LowerBoundedFeeEstimator<F>
1835 SP::Target: SignerProvider,
1836 F::Target: FeeEstimator
1838 let balance = context.get_available_balances(fee_estimator);
1839 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1840 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1842 channel_id: context.channel_id(),
1843 counterparty: ChannelCounterparty {
1844 node_id: context.get_counterparty_node_id(),
1845 features: latest_features,
1846 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1847 forwarding_info: context.counterparty_forwarding_info(),
1848 // Ensures that we have actually received the `htlc_minimum_msat` value
1849 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1850 // message (as they are always the first message from the counterparty).
1851 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1852 // default `0` value set by `Channel::new_outbound`.
1853 outbound_htlc_minimum_msat: if context.have_received_message() {
1854 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1855 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1857 funding_txo: context.get_funding_txo(),
1858 // Note that accept_channel (or open_channel) is always the first message, so
1859 // `have_received_message` indicates that type negotiation has completed.
1860 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1861 short_channel_id: context.get_short_channel_id(),
1862 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1863 inbound_scid_alias: context.latest_inbound_scid_alias(),
1864 channel_value_satoshis: context.get_value_satoshis(),
1865 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1866 unspendable_punishment_reserve: to_self_reserve_satoshis,
1867 balance_msat: balance.balance_msat,
1868 inbound_capacity_msat: balance.inbound_capacity_msat,
1869 outbound_capacity_msat: balance.outbound_capacity_msat,
1870 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1871 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1872 user_channel_id: context.get_user_id(),
1873 confirmations_required: context.minimum_depth(),
1874 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1875 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1876 is_outbound: context.is_outbound(),
1877 is_channel_ready: context.is_usable(),
1878 is_usable: context.is_live(),
1879 is_public: context.should_announce(),
1880 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1881 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1882 config: Some(context.config()),
1883 channel_shutdown_state: Some(context.shutdown_state()),
1888 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1889 /// Further information on the details of the channel shutdown.
1890 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1891 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1892 /// the channel will be removed shortly.
1893 /// Also note, that in normal operation, peers could disconnect at any of these states
1894 /// and require peer re-connection before making progress onto other states
1895 pub enum ChannelShutdownState {
1896 /// Channel has not sent or received a shutdown message.
1898 /// Local node has sent a shutdown message for this channel.
1900 /// Shutdown message exchanges have concluded and the channels are in the midst of
1901 /// resolving all existing open HTLCs before closing can continue.
1903 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1904 NegotiatingClosingFee,
1905 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1906 /// to drop the channel.
1910 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1911 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1912 #[derive(Debug, PartialEq)]
1913 pub enum RecentPaymentDetails {
1914 /// When an invoice was requested and thus a payment has not yet been sent.
1916 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1917 /// a payment and ensure idempotency in LDK.
1918 payment_id: PaymentId,
1920 /// When a payment is still being sent and awaiting successful delivery.
1922 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1923 /// a payment and ensure idempotency in LDK.
1924 payment_id: PaymentId,
1925 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1927 payment_hash: PaymentHash,
1928 /// Total amount (in msat, excluding fees) across all paths for this payment,
1929 /// not just the amount currently inflight.
1932 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1933 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1934 /// payment is removed from tracking.
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 was claimed. `None` for serializations of [`ChannelManager`]
1940 /// made before LDK version 0.0.104.
1941 payment_hash: Option<PaymentHash>,
1943 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1944 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1945 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1947 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1948 /// a payment and ensure idempotency in LDK.
1949 payment_id: PaymentId,
1950 /// Hash of the payment that we have given up trying to send.
1951 payment_hash: PaymentHash,
1955 /// Route hints used in constructing invoices for [phantom node payents].
1957 /// [phantom node payments]: crate::sign::PhantomKeysManager
1959 pub struct PhantomRouteHints {
1960 /// The list of channels to be included in the invoice route hints.
1961 pub channels: Vec<ChannelDetails>,
1962 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1964 pub phantom_scid: u64,
1965 /// The pubkey of the real backing node that would ultimately receive the payment.
1966 pub real_node_pubkey: PublicKey,
1969 macro_rules! handle_error {
1970 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1971 // In testing, ensure there are no deadlocks where the lock is already held upon
1972 // entering the macro.
1973 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1974 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1978 Err(MsgHandleErrInternal { err, shutdown_finish, .. }) => {
1979 let mut msg_events = Vec::with_capacity(2);
1981 if let Some((shutdown_res, update_option)) = shutdown_finish {
1982 let counterparty_node_id = shutdown_res.counterparty_node_id;
1983 let channel_id = shutdown_res.channel_id;
1984 let logger = WithContext::from(
1985 &$self.logger, Some(counterparty_node_id), Some(channel_id),
1987 log_error!(logger, "Force-closing channel: {}", err.err);
1989 $self.finish_close_channel(shutdown_res);
1990 if let Some(update) = update_option {
1991 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1996 log_error!($self.logger, "Got non-closing error: {}", err.err);
1999 if let msgs::ErrorAction::IgnoreError = err.action {
2001 msg_events.push(events::MessageSendEvent::HandleError {
2002 node_id: $counterparty_node_id,
2003 action: err.action.clone()
2007 if !msg_events.is_empty() {
2008 let per_peer_state = $self.per_peer_state.read().unwrap();
2009 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
2010 let mut peer_state = peer_state_mutex.lock().unwrap();
2011 peer_state.pending_msg_events.append(&mut msg_events);
2015 // Return error in case higher-API need one
2022 macro_rules! update_maps_on_chan_removal {
2023 ($self: expr, $channel_context: expr) => {{
2024 if let Some(outpoint) = $channel_context.get_funding_txo() {
2025 $self.outpoint_to_peer.lock().unwrap().remove(&outpoint);
2027 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2028 if let Some(short_id) = $channel_context.get_short_channel_id() {
2029 short_to_chan_info.remove(&short_id);
2031 // If the channel was never confirmed on-chain prior to its closure, remove the
2032 // outbound SCID alias we used for it from the collision-prevention set. While we
2033 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
2034 // also don't want a counterparty to be able to trivially cause a memory leak by simply
2035 // opening a million channels with us which are closed before we ever reach the funding
2037 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
2038 debug_assert!(alias_removed);
2040 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
2044 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
2045 macro_rules! convert_chan_phase_err {
2046 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
2048 ChannelError::Warn(msg) => {
2049 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
2051 ChannelError::Ignore(msg) => {
2052 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
2054 ChannelError::Close(msg) => {
2055 let logger = WithChannelContext::from(&$self.logger, &$channel.context);
2056 log_error!(logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
2057 update_maps_on_chan_removal!($self, $channel.context);
2058 let reason = ClosureReason::ProcessingError { err: msg.clone() };
2059 let shutdown_res = $channel.context.force_shutdown(true, reason);
2061 MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $channel_update);
2066 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
2067 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
2069 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
2070 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
2072 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
2073 match $channel_phase {
2074 ChannelPhase::Funded(channel) => {
2075 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
2077 ChannelPhase::UnfundedOutboundV1(channel) => {
2078 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2080 ChannelPhase::UnfundedInboundV1(channel) => {
2081 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2087 macro_rules! break_chan_phase_entry {
2088 ($self: ident, $res: expr, $entry: expr) => {
2092 let key = *$entry.key();
2093 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2095 $entry.remove_entry();
2103 macro_rules! try_chan_phase_entry {
2104 ($self: ident, $res: expr, $entry: expr) => {
2108 let key = *$entry.key();
2109 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2111 $entry.remove_entry();
2119 macro_rules! remove_channel_phase {
2120 ($self: expr, $entry: expr) => {
2122 let channel = $entry.remove_entry().1;
2123 update_maps_on_chan_removal!($self, &channel.context());
2129 macro_rules! send_channel_ready {
2130 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
2131 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
2132 node_id: $channel.context.get_counterparty_node_id(),
2133 msg: $channel_ready_msg,
2135 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
2136 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
2137 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2138 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2139 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2140 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2141 if let Some(real_scid) = $channel.context.get_short_channel_id() {
2142 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2143 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2144 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2149 macro_rules! emit_channel_pending_event {
2150 ($locked_events: expr, $channel: expr) => {
2151 if $channel.context.should_emit_channel_pending_event() {
2152 $locked_events.push_back((events::Event::ChannelPending {
2153 channel_id: $channel.context.channel_id(),
2154 former_temporary_channel_id: $channel.context.temporary_channel_id(),
2155 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2156 user_channel_id: $channel.context.get_user_id(),
2157 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
2159 $channel.context.set_channel_pending_event_emitted();
2164 macro_rules! emit_channel_ready_event {
2165 ($locked_events: expr, $channel: expr) => {
2166 if $channel.context.should_emit_channel_ready_event() {
2167 debug_assert!($channel.context.channel_pending_event_emitted());
2168 $locked_events.push_back((events::Event::ChannelReady {
2169 channel_id: $channel.context.channel_id(),
2170 user_channel_id: $channel.context.get_user_id(),
2171 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2172 channel_type: $channel.context.get_channel_type().clone(),
2174 $channel.context.set_channel_ready_event_emitted();
2179 macro_rules! handle_monitor_update_completion {
2180 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2181 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2182 let mut updates = $chan.monitor_updating_restored(&&logger,
2183 &$self.node_signer, $self.chain_hash, &$self.default_configuration,
2184 $self.best_block.read().unwrap().height());
2185 let counterparty_node_id = $chan.context.get_counterparty_node_id();
2186 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
2187 // We only send a channel_update in the case where we are just now sending a
2188 // channel_ready and the channel is in a usable state. We may re-send a
2189 // channel_update later through the announcement_signatures process for public
2190 // channels, but there's no reason not to just inform our counterparty of our fees
2192 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
2193 Some(events::MessageSendEvent::SendChannelUpdate {
2194 node_id: counterparty_node_id,
2200 let update_actions = $peer_state.monitor_update_blocked_actions
2201 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
2203 let htlc_forwards = $self.handle_channel_resumption(
2204 &mut $peer_state.pending_msg_events, $chan, updates.raa,
2205 updates.commitment_update, updates.order, updates.accepted_htlcs,
2206 updates.funding_broadcastable, updates.channel_ready,
2207 updates.announcement_sigs);
2208 if let Some(upd) = channel_update {
2209 $peer_state.pending_msg_events.push(upd);
2212 let channel_id = $chan.context.channel_id();
2213 let unbroadcasted_batch_funding_txid = $chan.context.unbroadcasted_batch_funding_txid();
2214 core::mem::drop($peer_state_lock);
2215 core::mem::drop($per_peer_state_lock);
2217 // If the channel belongs to a batch funding transaction, the progress of the batch
2218 // should be updated as we have received funding_signed and persisted the monitor.
2219 if let Some(txid) = unbroadcasted_batch_funding_txid {
2220 let mut funding_batch_states = $self.funding_batch_states.lock().unwrap();
2221 let mut batch_completed = false;
2222 if let Some(batch_state) = funding_batch_states.get_mut(&txid) {
2223 let channel_state = batch_state.iter_mut().find(|(chan_id, pubkey, _)| (
2224 *chan_id == channel_id &&
2225 *pubkey == counterparty_node_id
2227 if let Some(channel_state) = channel_state {
2228 channel_state.2 = true;
2230 debug_assert!(false, "Missing channel batch state for channel which completed initial monitor update");
2232 batch_completed = batch_state.iter().all(|(_, _, completed)| *completed);
2234 debug_assert!(false, "Missing batch state for channel which completed initial monitor update");
2237 // When all channels in a batched funding transaction have become ready, it is not necessary
2238 // to track the progress of the batch anymore and the state of the channels can be updated.
2239 if batch_completed {
2240 let removed_batch_state = funding_batch_states.remove(&txid).into_iter().flatten();
2241 let per_peer_state = $self.per_peer_state.read().unwrap();
2242 let mut batch_funding_tx = None;
2243 for (channel_id, counterparty_node_id, _) in removed_batch_state {
2244 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2245 let mut peer_state = peer_state_mutex.lock().unwrap();
2246 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
2247 batch_funding_tx = batch_funding_tx.or_else(|| chan.context.unbroadcasted_funding());
2248 chan.set_batch_ready();
2249 let mut pending_events = $self.pending_events.lock().unwrap();
2250 emit_channel_pending_event!(pending_events, chan);
2254 if let Some(tx) = batch_funding_tx {
2255 log_info!($self.logger, "Broadcasting batch funding transaction with txid {}", tx.txid());
2256 $self.tx_broadcaster.broadcast_transactions(&[&tx]);
2261 $self.handle_monitor_update_completion_actions(update_actions);
2263 if let Some(forwards) = htlc_forwards {
2264 $self.forward_htlcs(&mut [forwards][..]);
2266 $self.finalize_claims(updates.finalized_claimed_htlcs);
2267 for failure in updates.failed_htlcs.drain(..) {
2268 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2269 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2274 macro_rules! handle_new_monitor_update {
2275 ($self: ident, $update_res: expr, $chan: expr, _internal, $completed: expr) => { {
2276 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2277 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2279 ChannelMonitorUpdateStatus::UnrecoverableError => {
2280 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
2281 log_error!(logger, "{}", err_str);
2282 panic!("{}", err_str);
2284 ChannelMonitorUpdateStatus::InProgress => {
2285 log_debug!(logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2286 &$chan.context.channel_id());
2289 ChannelMonitorUpdateStatus::Completed => {
2295 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, INITIAL_MONITOR) => {
2296 handle_new_monitor_update!($self, $update_res, $chan, _internal,
2297 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2299 ($self: ident, $funding_txo: expr, $channel_id: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2300 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2301 .or_insert_with(Vec::new);
2302 // During startup, we push monitor updates as background events through to here in
2303 // order to replay updates that were in-flight when we shut down. Thus, we have to
2304 // filter for uniqueness here.
2305 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2306 .unwrap_or_else(|| {
2307 in_flight_updates.push($update);
2308 in_flight_updates.len() - 1
2310 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2311 handle_new_monitor_update!($self, update_res, $chan, _internal,
2313 let _ = in_flight_updates.remove(idx);
2314 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2315 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2321 macro_rules! process_events_body {
2322 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2323 let mut processed_all_events = false;
2324 while !processed_all_events {
2325 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2332 // We'll acquire our total consistency lock so that we can be sure no other
2333 // persists happen while processing monitor events.
2334 let _read_guard = $self.total_consistency_lock.read().unwrap();
2336 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2337 // ensure any startup-generated background events are handled first.
2338 result = $self.process_background_events();
2340 // TODO: This behavior should be documented. It's unintuitive that we query
2341 // ChannelMonitors when clearing other events.
2342 if $self.process_pending_monitor_events() {
2343 result = NotifyOption::DoPersist;
2347 let pending_events = $self.pending_events.lock().unwrap().clone();
2348 let num_events = pending_events.len();
2349 if !pending_events.is_empty() {
2350 result = NotifyOption::DoPersist;
2353 let mut post_event_actions = Vec::new();
2355 for (event, action_opt) in pending_events {
2356 $event_to_handle = event;
2358 if let Some(action) = action_opt {
2359 post_event_actions.push(action);
2364 let mut pending_events = $self.pending_events.lock().unwrap();
2365 pending_events.drain(..num_events);
2366 processed_all_events = pending_events.is_empty();
2367 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2368 // updated here with the `pending_events` lock acquired.
2369 $self.pending_events_processor.store(false, Ordering::Release);
2372 if !post_event_actions.is_empty() {
2373 $self.handle_post_event_actions(post_event_actions);
2374 // If we had some actions, go around again as we may have more events now
2375 processed_all_events = false;
2379 NotifyOption::DoPersist => {
2380 $self.needs_persist_flag.store(true, Ordering::Release);
2381 $self.event_persist_notifier.notify();
2383 NotifyOption::SkipPersistHandleEvents =>
2384 $self.event_persist_notifier.notify(),
2385 NotifyOption::SkipPersistNoEvents => {},
2391 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>
2393 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
2394 T::Target: BroadcasterInterface,
2395 ES::Target: EntropySource,
2396 NS::Target: NodeSigner,
2397 SP::Target: SignerProvider,
2398 F::Target: FeeEstimator,
2402 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2404 /// The current time or latest block header time can be provided as the `current_timestamp`.
2406 /// This is the main "logic hub" for all channel-related actions, and implements
2407 /// [`ChannelMessageHandler`].
2409 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2411 /// Users need to notify the new `ChannelManager` when a new block is connected or
2412 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2413 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2416 /// [`block_connected`]: chain::Listen::block_connected
2417 /// [`block_disconnected`]: chain::Listen::block_disconnected
2418 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2420 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2421 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2422 current_timestamp: u32,
2424 let mut secp_ctx = Secp256k1::new();
2425 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2426 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2427 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2429 default_configuration: config.clone(),
2430 chain_hash: ChainHash::using_genesis_block(params.network),
2431 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2436 best_block: RwLock::new(params.best_block),
2438 outbound_scid_aliases: Mutex::new(HashSet::new()),
2439 pending_inbound_payments: Mutex::new(HashMap::new()),
2440 pending_outbound_payments: OutboundPayments::new(),
2441 forward_htlcs: Mutex::new(HashMap::new()),
2442 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2443 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2444 outpoint_to_peer: Mutex::new(HashMap::new()),
2445 short_to_chan_info: FairRwLock::new(HashMap::new()),
2447 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2450 inbound_payment_key: expanded_inbound_key,
2451 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2453 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2455 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2457 per_peer_state: FairRwLock::new(HashMap::new()),
2459 pending_events: Mutex::new(VecDeque::new()),
2460 pending_events_processor: AtomicBool::new(false),
2461 pending_background_events: Mutex::new(Vec::new()),
2462 total_consistency_lock: RwLock::new(()),
2463 background_events_processed_since_startup: AtomicBool::new(false),
2464 event_persist_notifier: Notifier::new(),
2465 needs_persist_flag: AtomicBool::new(false),
2466 funding_batch_states: Mutex::new(BTreeMap::new()),
2468 pending_offers_messages: Mutex::new(Vec::new()),
2478 /// Gets the current configuration applied to all new channels.
2479 pub fn get_current_default_configuration(&self) -> &UserConfig {
2480 &self.default_configuration
2483 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2484 let height = self.best_block.read().unwrap().height();
2485 let mut outbound_scid_alias = 0;
2488 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2489 outbound_scid_alias += 1;
2491 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2493 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2497 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"); }
2502 /// Creates a new outbound channel to the given remote node and with the given value.
2504 /// `user_channel_id` will be provided back as in
2505 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2506 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2507 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2508 /// is simply copied to events and otherwise ignored.
2510 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2511 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2513 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2514 /// generate a shutdown scriptpubkey or destination script set by
2515 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2517 /// Note that we do not check if you are currently connected to the given peer. If no
2518 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2519 /// the channel eventually being silently forgotten (dropped on reload).
2521 /// If `temporary_channel_id` is specified, it will be used as the temporary channel ID of the
2522 /// channel. Otherwise, a random one will be generated for you.
2524 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2525 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2526 /// [`ChannelDetails::channel_id`] until after
2527 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2528 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2529 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2531 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2532 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2533 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2534 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> {
2535 if channel_value_satoshis < 1000 {
2536 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2539 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2540 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2541 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2543 let per_peer_state = self.per_peer_state.read().unwrap();
2545 let peer_state_mutex = per_peer_state.get(&their_network_key)
2546 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2548 let mut peer_state = peer_state_mutex.lock().unwrap();
2550 if let Some(temporary_channel_id) = temporary_channel_id {
2551 if peer_state.channel_by_id.contains_key(&temporary_channel_id) {
2552 return Err(APIError::APIMisuseError{ err: format!("Channel with temporary channel ID {} already exists!", temporary_channel_id)});
2557 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2558 let their_features = &peer_state.latest_features;
2559 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2560 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2561 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2562 self.best_block.read().unwrap().height(), outbound_scid_alias, temporary_channel_id)
2566 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2571 let res = channel.get_open_channel(self.chain_hash);
2573 let temporary_channel_id = channel.context.channel_id();
2574 match peer_state.channel_by_id.entry(temporary_channel_id) {
2575 hash_map::Entry::Occupied(_) => {
2577 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2579 panic!("RNG is bad???");
2582 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2585 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2586 node_id: their_network_key,
2589 Ok(temporary_channel_id)
2592 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2593 // Allocate our best estimate of the number of channels we have in the `res`
2594 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2595 // a scid or a scid alias, and the `outpoint_to_peer` shouldn't be used outside
2596 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2597 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2598 // the same channel.
2599 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2601 let best_block_height = self.best_block.read().unwrap().height();
2602 let per_peer_state = self.per_peer_state.read().unwrap();
2603 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2604 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2605 let peer_state = &mut *peer_state_lock;
2606 res.extend(peer_state.channel_by_id.iter()
2607 .filter_map(|(chan_id, phase)| match phase {
2608 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2609 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2613 .map(|(_channel_id, channel)| {
2614 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2615 peer_state.latest_features.clone(), &self.fee_estimator)
2623 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2624 /// more information.
2625 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2626 // Allocate our best estimate of the number of channels we have in the `res`
2627 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2628 // a scid or a scid alias, and the `outpoint_to_peer` shouldn't be used outside
2629 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2630 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2631 // the same channel.
2632 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2634 let best_block_height = self.best_block.read().unwrap().height();
2635 let per_peer_state = self.per_peer_state.read().unwrap();
2636 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2637 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2638 let peer_state = &mut *peer_state_lock;
2639 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2640 let details = ChannelDetails::from_channel_context(context, best_block_height,
2641 peer_state.latest_features.clone(), &self.fee_estimator);
2649 /// Gets the list of usable channels, in random order. Useful as an argument to
2650 /// [`Router::find_route`] to ensure non-announced channels are used.
2652 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2653 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2655 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2656 // Note we use is_live here instead of usable which leads to somewhat confused
2657 // internal/external nomenclature, but that's ok cause that's probably what the user
2658 // really wanted anyway.
2659 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2662 /// Gets the list of channels we have with a given counterparty, in random order.
2663 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2664 let best_block_height = self.best_block.read().unwrap().height();
2665 let per_peer_state = self.per_peer_state.read().unwrap();
2667 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2668 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2669 let peer_state = &mut *peer_state_lock;
2670 let features = &peer_state.latest_features;
2671 let context_to_details = |context| {
2672 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2674 return peer_state.channel_by_id
2676 .map(|(_, phase)| phase.context())
2677 .map(context_to_details)
2683 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2684 /// successful path, or have unresolved HTLCs.
2686 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2687 /// result of a crash. If such a payment exists, is not listed here, and an
2688 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2690 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2691 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2692 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2693 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2694 PendingOutboundPayment::AwaitingInvoice { .. } => {
2695 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2697 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2698 PendingOutboundPayment::InvoiceReceived { .. } => {
2699 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2701 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2702 Some(RecentPaymentDetails::Pending {
2703 payment_id: *payment_id,
2704 payment_hash: *payment_hash,
2705 total_msat: *total_msat,
2708 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2709 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2711 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2712 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2714 PendingOutboundPayment::Legacy { .. } => None
2719 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> {
2720 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2722 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
2723 let mut shutdown_result = None;
2726 let per_peer_state = self.per_peer_state.read().unwrap();
2728 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2729 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2731 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2732 let peer_state = &mut *peer_state_lock;
2734 match peer_state.channel_by_id.entry(channel_id.clone()) {
2735 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2736 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2737 let funding_txo_opt = chan.context.get_funding_txo();
2738 let their_features = &peer_state.latest_features;
2739 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2740 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2741 failed_htlcs = htlcs;
2743 // We can send the `shutdown` message before updating the `ChannelMonitor`
2744 // here as we don't need the monitor update to complete until we send a
2745 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2746 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2747 node_id: *counterparty_node_id,
2751 debug_assert!(monitor_update_opt.is_none() || !chan.is_shutdown(),
2752 "We can't both complete shutdown and generate a monitor update");
2754 // Update the monitor with the shutdown script if necessary.
2755 if let Some(monitor_update) = monitor_update_opt.take() {
2756 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), *channel_id, monitor_update,
2757 peer_state_lock, peer_state, per_peer_state, chan);
2760 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2761 shutdown_result = Some(chan_phase.context_mut().force_shutdown(false, ClosureReason::HolderForceClosed));
2764 hash_map::Entry::Vacant(_) => {
2765 return Err(APIError::ChannelUnavailable {
2767 "Channel with id {} not found for the passed counterparty node_id {}",
2768 channel_id, counterparty_node_id,
2775 for htlc_source in failed_htlcs.drain(..) {
2776 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2777 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2778 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2781 if let Some(shutdown_result) = shutdown_result {
2782 self.finish_close_channel(shutdown_result);
2788 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2789 /// will be accepted on the given channel, and after additional timeout/the closing of all
2790 /// pending HTLCs, the channel will be closed on chain.
2792 /// * If we are the channel initiator, we will pay between our [`ChannelCloseMinimum`] and
2793 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2795 /// * If our counterparty is the channel initiator, we will require a channel closing
2796 /// transaction feerate of at least our [`ChannelCloseMinimum`] feerate or the feerate which
2797 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2798 /// counterparty to pay as much fee as they'd like, however.
2800 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2802 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2803 /// generate a shutdown scriptpubkey or destination script set by
2804 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2807 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2808 /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
2809 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2810 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2811 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2812 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2815 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2816 /// will be accepted on the given channel, and after additional timeout/the closing of all
2817 /// pending HTLCs, the channel will be closed on chain.
2819 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2820 /// the channel being closed or not:
2821 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2822 /// transaction. The upper-bound is set by
2823 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2824 /// fee estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2825 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2826 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2827 /// will appear on a force-closure transaction, whichever is lower).
2829 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2830 /// Will fail if a shutdown script has already been set for this channel by
2831 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2832 /// also be compatible with our and the counterparty's features.
2834 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2836 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2837 /// generate a shutdown scriptpubkey or destination script set by
2838 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2841 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2842 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2843 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2844 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> {
2845 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2848 fn finish_close_channel(&self, mut shutdown_res: ShutdownResult) {
2849 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
2850 #[cfg(debug_assertions)]
2851 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
2852 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
2855 let logger = WithContext::from(
2856 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
2859 log_debug!(logger, "Finishing closure of channel due to {} with {} HTLCs to fail",
2860 shutdown_res.closure_reason, shutdown_res.dropped_outbound_htlcs.len());
2861 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
2862 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2863 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2864 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2865 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2867 if let Some((_, funding_txo, _channel_id, monitor_update)) = shutdown_res.monitor_update {
2868 // There isn't anything we can do if we get an update failure - we're already
2869 // force-closing. The monitor update on the required in-memory copy should broadcast
2870 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2871 // ignore the result here.
2872 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2874 let mut shutdown_results = Vec::new();
2875 if let Some(txid) = shutdown_res.unbroadcasted_batch_funding_txid {
2876 let mut funding_batch_states = self.funding_batch_states.lock().unwrap();
2877 let affected_channels = funding_batch_states.remove(&txid).into_iter().flatten();
2878 let per_peer_state = self.per_peer_state.read().unwrap();
2879 let mut has_uncompleted_channel = None;
2880 for (channel_id, counterparty_node_id, state) in affected_channels {
2881 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2882 let mut peer_state = peer_state_mutex.lock().unwrap();
2883 if let Some(mut chan) = peer_state.channel_by_id.remove(&channel_id) {
2884 update_maps_on_chan_removal!(self, &chan.context());
2885 shutdown_results.push(chan.context_mut().force_shutdown(false, ClosureReason::FundingBatchClosure));
2888 has_uncompleted_channel = Some(has_uncompleted_channel.map_or(!state, |v| v || !state));
2891 has_uncompleted_channel.unwrap_or(true),
2892 "Closing a batch where all channels have completed initial monitor update",
2897 let mut pending_events = self.pending_events.lock().unwrap();
2898 pending_events.push_back((events::Event::ChannelClosed {
2899 channel_id: shutdown_res.channel_id,
2900 user_channel_id: shutdown_res.user_channel_id,
2901 reason: shutdown_res.closure_reason,
2902 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
2903 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
2904 channel_funding_txo: shutdown_res.channel_funding_txo,
2907 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
2908 pending_events.push_back((events::Event::DiscardFunding {
2909 channel_id: shutdown_res.channel_id, transaction
2913 for shutdown_result in shutdown_results.drain(..) {
2914 self.finish_close_channel(shutdown_result);
2918 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2919 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2920 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2921 -> Result<PublicKey, APIError> {
2922 let per_peer_state = self.per_peer_state.read().unwrap();
2923 let peer_state_mutex = per_peer_state.get(peer_node_id)
2924 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2925 let (update_opt, counterparty_node_id) = {
2926 let mut peer_state = peer_state_mutex.lock().unwrap();
2927 let closure_reason = if let Some(peer_msg) = peer_msg {
2928 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2930 ClosureReason::HolderForceClosed
2932 let logger = WithContext::from(&self.logger, Some(*peer_node_id), Some(*channel_id));
2933 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2934 log_error!(logger, "Force-closing channel {}", channel_id);
2935 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2936 mem::drop(peer_state);
2937 mem::drop(per_peer_state);
2939 ChannelPhase::Funded(mut chan) => {
2940 self.finish_close_channel(chan.context.force_shutdown(broadcast, closure_reason));
2941 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2943 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2944 self.finish_close_channel(chan_phase.context_mut().force_shutdown(false, closure_reason));
2945 // Unfunded channel has no update
2946 (None, chan_phase.context().get_counterparty_node_id())
2949 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2950 log_error!(logger, "Force-closing channel {}", &channel_id);
2951 // N.B. that we don't send any channel close event here: we
2952 // don't have a user_channel_id, and we never sent any opening
2954 (None, *peer_node_id)
2956 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2959 if let Some(update) = update_opt {
2960 // Try to send the `BroadcastChannelUpdate` to the peer we just force-closed on, but if
2961 // not try to broadcast it via whatever peer we have.
2962 let per_peer_state = self.per_peer_state.read().unwrap();
2963 let a_peer_state_opt = per_peer_state.get(peer_node_id)
2964 .ok_or(per_peer_state.values().next());
2965 if let Ok(a_peer_state_mutex) = a_peer_state_opt {
2966 let mut a_peer_state = a_peer_state_mutex.lock().unwrap();
2967 a_peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2973 Ok(counterparty_node_id)
2976 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2977 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2978 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2979 Ok(counterparty_node_id) => {
2980 let per_peer_state = self.per_peer_state.read().unwrap();
2981 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2982 let mut peer_state = peer_state_mutex.lock().unwrap();
2983 peer_state.pending_msg_events.push(
2984 events::MessageSendEvent::HandleError {
2985 node_id: counterparty_node_id,
2986 action: msgs::ErrorAction::DisconnectPeer {
2987 msg: Some(msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() })
2998 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2999 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
3000 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
3002 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
3003 -> Result<(), APIError> {
3004 self.force_close_sending_error(channel_id, counterparty_node_id, true)
3007 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
3008 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
3009 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
3011 /// You can always get the latest local transaction(s) to broadcast from
3012 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
3013 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
3014 -> Result<(), APIError> {
3015 self.force_close_sending_error(channel_id, counterparty_node_id, false)
3018 /// Force close all channels, immediately broadcasting the latest local commitment transaction
3019 /// for each to the chain and rejecting new HTLCs on each.
3020 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
3021 for chan in self.list_channels() {
3022 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
3026 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
3027 /// local transaction(s).
3028 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
3029 for chan in self.list_channels() {
3030 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
3034 fn decode_update_add_htlc_onion(
3035 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
3037 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
3039 let (next_hop, shared_secret, next_packet_details_opt) = decode_incoming_update_add_htlc_onion(
3040 msg, &self.node_signer, &self.logger, &self.secp_ctx
3043 let is_intro_node_forward = match next_hop {
3044 onion_utils::Hop::Forward {
3045 next_hop_data: msgs::InboundOnionPayload::BlindedForward {
3046 intro_node_blinding_point: Some(_), ..
3052 macro_rules! return_err {
3053 ($msg: expr, $err_code: expr, $data: expr) => {
3056 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
3057 "Failed to accept/forward incoming HTLC: {}", $msg
3059 // If `msg.blinding_point` is set, we must always fail with malformed.
3060 if msg.blinding_point.is_some() {
3061 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
3062 channel_id: msg.channel_id,
3063 htlc_id: msg.htlc_id,
3064 sha256_of_onion: [0; 32],
3065 failure_code: INVALID_ONION_BLINDING,
3069 let (err_code, err_data) = if is_intro_node_forward {
3070 (INVALID_ONION_BLINDING, &[0; 32][..])
3071 } else { ($err_code, $data) };
3072 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3073 channel_id: msg.channel_id,
3074 htlc_id: msg.htlc_id,
3075 reason: HTLCFailReason::reason(err_code, err_data.to_vec())
3076 .get_encrypted_failure_packet(&shared_secret, &None),
3082 let NextPacketDetails {
3083 next_packet_pubkey, outgoing_amt_msat, outgoing_scid, outgoing_cltv_value
3084 } = match next_packet_details_opt {
3085 Some(next_packet_details) => next_packet_details,
3086 // it is a receive, so no need for outbound checks
3087 None => return Ok((next_hop, shared_secret, None)),
3090 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
3091 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
3092 if let Some((err, mut code, chan_update)) = loop {
3093 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
3094 let forwarding_chan_info_opt = match id_option {
3095 None => { // unknown_next_peer
3096 // Note that this is likely a timing oracle for detecting whether an scid is a
3097 // phantom or an intercept.
3098 if (self.default_configuration.accept_intercept_htlcs &&
3099 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)) ||
3100 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)
3104 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3107 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
3109 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
3110 let per_peer_state = self.per_peer_state.read().unwrap();
3111 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3112 if peer_state_mutex_opt.is_none() {
3113 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3115 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3116 let peer_state = &mut *peer_state_lock;
3117 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
3118 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
3121 // Channel was removed. The short_to_chan_info and channel_by_id maps
3122 // have no consistency guarantees.
3123 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3127 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3128 // Note that the behavior here should be identical to the above block - we
3129 // should NOT reveal the existence or non-existence of a private channel if
3130 // we don't allow forwards outbound over them.
3131 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3133 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3134 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3135 // "refuse to forward unless the SCID alias was used", so we pretend
3136 // we don't have the channel here.
3137 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3139 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3141 // Note that we could technically not return an error yet here and just hope
3142 // that the connection is reestablished or monitor updated by the time we get
3143 // around to doing the actual forward, but better to fail early if we can and
3144 // hopefully an attacker trying to path-trace payments cannot make this occur
3145 // on a small/per-node/per-channel scale.
3146 if !chan.context.is_live() { // channel_disabled
3147 // If the channel_update we're going to return is disabled (i.e. the
3148 // peer has been disabled for some time), return `channel_disabled`,
3149 // otherwise return `temporary_channel_failure`.
3150 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3151 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3153 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3156 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3157 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3159 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3160 break Some((err, code, chan_update_opt));
3167 let cur_height = self.best_block.read().unwrap().height() + 1;
3169 if let Err((err_msg, code)) = check_incoming_htlc_cltv(
3170 cur_height, outgoing_cltv_value, msg.cltv_expiry
3172 if code & 0x1000 != 0 && chan_update_opt.is_none() {
3173 // We really should set `incorrect_cltv_expiry` here but as we're not
3174 // forwarding over a real channel we can't generate a channel_update
3175 // for it. Instead we just return a generic temporary_node_failure.
3176 break Some((err_msg, 0x2000 | 2, None))
3178 let chan_update_opt = if code & 0x1000 != 0 { chan_update_opt } else { None };
3179 break Some((err_msg, code, chan_update_opt));
3185 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3186 if let Some(chan_update) = chan_update {
3187 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3188 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3190 else if code == 0x1000 | 13 {
3191 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3193 else if code == 0x1000 | 20 {
3194 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3195 0u16.write(&mut res).expect("Writes cannot fail");
3197 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3198 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3199 chan_update.write(&mut res).expect("Writes cannot fail");
3200 } else if code & 0x1000 == 0x1000 {
3201 // If we're trying to return an error that requires a `channel_update` but
3202 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3203 // generate an update), just use the generic "temporary_node_failure"
3207 return_err!(err, code, &res.0[..]);
3209 Ok((next_hop, shared_secret, Some(next_packet_pubkey)))
3212 fn construct_pending_htlc_status<'a>(
3213 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
3214 decoded_hop: onion_utils::Hop, allow_underpay: bool,
3215 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
3216 ) -> PendingHTLCStatus {
3217 macro_rules! return_err {
3218 ($msg: expr, $err_code: expr, $data: expr) => {
3220 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
3221 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3222 if msg.blinding_point.is_some() {
3223 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(
3224 msgs::UpdateFailMalformedHTLC {
3225 channel_id: msg.channel_id,
3226 htlc_id: msg.htlc_id,
3227 sha256_of_onion: [0; 32],
3228 failure_code: INVALID_ONION_BLINDING,
3232 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3233 channel_id: msg.channel_id,
3234 htlc_id: msg.htlc_id,
3235 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3236 .get_encrypted_failure_packet(&shared_secret, &None),
3242 onion_utils::Hop::Receive(next_hop_data) => {
3244 let current_height: u32 = self.best_block.read().unwrap().height();
3245 match create_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3246 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat,
3247 current_height, self.default_configuration.accept_mpp_keysend)
3250 // Note that we could obviously respond immediately with an update_fulfill_htlc
3251 // message, however that would leak that we are the recipient of this payment, so
3252 // instead we stay symmetric with the forwarding case, only responding (after a
3253 // delay) once they've send us a commitment_signed!
3254 PendingHTLCStatus::Forward(info)
3256 Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3259 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3260 match create_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3261 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3262 Ok(info) => PendingHTLCStatus::Forward(info),
3263 Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3269 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3270 /// public, and thus should be called whenever the result is going to be passed out in a
3271 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3273 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3274 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3275 /// storage and the `peer_state` lock has been dropped.
3277 /// [`channel_update`]: msgs::ChannelUpdate
3278 /// [`internal_closing_signed`]: Self::internal_closing_signed
3279 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3280 if !chan.context.should_announce() {
3281 return Err(LightningError {
3282 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3283 action: msgs::ErrorAction::IgnoreError
3286 if chan.context.get_short_channel_id().is_none() {
3287 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3289 let logger = WithChannelContext::from(&self.logger, &chan.context);
3290 log_trace!(logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3291 self.get_channel_update_for_unicast(chan)
3294 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3295 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3296 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3297 /// provided evidence that they know about the existence of the channel.
3299 /// Note that through [`internal_closing_signed`], this function is called without the
3300 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3301 /// removed from the storage and the `peer_state` lock has been dropped.
3303 /// [`channel_update`]: msgs::ChannelUpdate
3304 /// [`internal_closing_signed`]: Self::internal_closing_signed
3305 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3306 let logger = WithChannelContext::from(&self.logger, &chan.context);
3307 log_trace!(logger, "Attempting to generate channel update for channel {}", chan.context.channel_id());
3308 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3309 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3313 self.get_channel_update_for_onion(short_channel_id, chan)
3316 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3317 let logger = WithChannelContext::from(&self.logger, &chan.context);
3318 log_trace!(logger, "Generating channel update for channel {}", chan.context.channel_id());
3319 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3321 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3322 ChannelUpdateStatus::Enabled => true,
3323 ChannelUpdateStatus::DisabledStaged(_) => true,
3324 ChannelUpdateStatus::Disabled => false,
3325 ChannelUpdateStatus::EnabledStaged(_) => false,
3328 let unsigned = msgs::UnsignedChannelUpdate {
3329 chain_hash: self.chain_hash,
3331 timestamp: chan.context.get_update_time_counter(),
3332 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3333 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3334 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3335 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3336 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3337 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3338 excess_data: Vec::new(),
3340 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3341 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3342 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3344 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3346 Ok(msgs::ChannelUpdate {
3353 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> {
3354 let _lck = self.total_consistency_lock.read().unwrap();
3355 self.send_payment_along_path(SendAlongPathArgs {
3356 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3361 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3362 let SendAlongPathArgs {
3363 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3366 // The top-level caller should hold the total_consistency_lock read lock.
3367 debug_assert!(self.total_consistency_lock.try_write().is_err());
3368 let prng_seed = self.entropy_source.get_secure_random_bytes();
3369 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3371 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
3372 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
3373 payment_hash, keysend_preimage, prng_seed
3375 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3376 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
3380 let err: Result<(), _> = loop {
3381 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3383 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3384 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
3385 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
3387 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3390 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
3392 "Attempting to send payment with payment hash {} along path with next hop {}",
3393 payment_hash, path.hops.first().unwrap().short_channel_id);
3395 let per_peer_state = self.per_peer_state.read().unwrap();
3396 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3397 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3398 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3399 let peer_state = &mut *peer_state_lock;
3400 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3401 match chan_phase_entry.get_mut() {
3402 ChannelPhase::Funded(chan) => {
3403 if !chan.context.is_live() {
3404 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3406 let funding_txo = chan.context.get_funding_txo().unwrap();
3407 let logger = WithChannelContext::from(&self.logger, &chan.context);
3408 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3409 htlc_cltv, HTLCSource::OutboundRoute {
3411 session_priv: session_priv.clone(),
3412 first_hop_htlc_msat: htlc_msat,
3414 }, onion_packet, None, &self.fee_estimator, &&logger);
3415 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3416 Some(monitor_update) => {
3417 match handle_new_monitor_update!(self, funding_txo, channel_id, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3419 // Note that MonitorUpdateInProgress here indicates (per function
3420 // docs) that we will resend the commitment update once monitor
3421 // updating completes. Therefore, we must return an error
3422 // indicating that it is unsafe to retry the payment wholesale,
3423 // which we do in the send_payment check for
3424 // MonitorUpdateInProgress, below.
3425 return Err(APIError::MonitorUpdateInProgress);
3433 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3436 // The channel was likely removed after we fetched the id from the
3437 // `short_to_chan_info` map, but before we successfully locked the
3438 // `channel_by_id` map.
3439 // This can occur as no consistency guarantees exists between the two maps.
3440 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3444 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3445 Ok(_) => unreachable!(),
3447 Err(APIError::ChannelUnavailable { err: e.err })
3452 /// Sends a payment along a given route.
3454 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3455 /// fields for more info.
3457 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3458 /// [`PeerManager::process_events`]).
3460 /// # Avoiding Duplicate Payments
3462 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3463 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3464 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3465 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3466 /// second payment with the same [`PaymentId`].
3468 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3469 /// tracking of payments, including state to indicate once a payment has completed. Because you
3470 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3471 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3472 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3474 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3475 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3476 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3477 /// [`ChannelManager::list_recent_payments`] for more information.
3479 /// # Possible Error States on [`PaymentSendFailure`]
3481 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3482 /// each entry matching the corresponding-index entry in the route paths, see
3483 /// [`PaymentSendFailure`] for more info.
3485 /// In general, a path may raise:
3486 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3487 /// node public key) is specified.
3488 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3489 /// closed, doesn't exist, or the peer is currently disconnected.
3490 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3491 /// relevant updates.
3493 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3494 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3495 /// different route unless you intend to pay twice!
3497 /// [`RouteHop`]: crate::routing::router::RouteHop
3498 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3499 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3500 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3501 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3502 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3503 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3504 let best_block_height = self.best_block.read().unwrap().height();
3505 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3506 self.pending_outbound_payments
3507 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3508 &self.entropy_source, &self.node_signer, best_block_height,
3509 |args| self.send_payment_along_path(args))
3512 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3513 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3514 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3515 let best_block_height = self.best_block.read().unwrap().height();
3516 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3517 self.pending_outbound_payments
3518 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3519 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3520 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3521 &self.pending_events, |args| self.send_payment_along_path(args))
3525 pub(super) fn test_send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
3526 let best_block_height = self.best_block.read().unwrap().height();
3527 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3528 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3529 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3530 best_block_height, |args| self.send_payment_along_path(args))
3534 pub(crate) fn test_add_new_pending_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
3535 let best_block_height = self.best_block.read().unwrap().height();
3536 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3540 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3541 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3544 pub(super) fn send_payment_for_bolt12_invoice(&self, invoice: &Bolt12Invoice, payment_id: PaymentId) -> Result<(), Bolt12PaymentError> {
3545 let best_block_height = self.best_block.read().unwrap().height();
3546 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3547 self.pending_outbound_payments
3548 .send_payment_for_bolt12_invoice(
3549 invoice, payment_id, &self.router, self.list_usable_channels(),
3550 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer,
3551 best_block_height, &self.logger, &self.pending_events,
3552 |args| self.send_payment_along_path(args)
3556 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3557 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3558 /// retries are exhausted.
3560 /// # Event Generation
3562 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3563 /// as there are no remaining pending HTLCs for this payment.
3565 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3566 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3567 /// determine the ultimate status of a payment.
3569 /// # Requested Invoices
3571 /// In the case of paying a [`Bolt12Invoice`] via [`ChannelManager::pay_for_offer`], abandoning
3572 /// the payment prior to receiving the invoice will result in an [`Event::InvoiceRequestFailed`]
3573 /// and prevent any attempts at paying it once received. The other events may only be generated
3574 /// once the invoice has been received.
3576 /// # Restart Behavior
3578 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3579 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3580 /// [`Event::InvoiceRequestFailed`].
3582 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3583 pub fn abandon_payment(&self, payment_id: PaymentId) {
3584 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3585 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3588 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3589 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3590 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3591 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3592 /// never reach the recipient.
3594 /// See [`send_payment`] documentation for more details on the return value of this function
3595 /// and idempotency guarantees provided by the [`PaymentId`] key.
3597 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3598 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3600 /// [`send_payment`]: Self::send_payment
3601 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3602 let best_block_height = self.best_block.read().unwrap().height();
3603 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3604 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3605 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3606 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3609 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3610 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3612 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3615 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3616 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> {
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_spontaneous_payment(payment_preimage, recipient_onion,
3620 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3621 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3622 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3625 /// Send a payment that is probing the given route for liquidity. We calculate the
3626 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3627 /// us to easily discern them from real payments.
3628 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3629 let best_block_height = self.best_block.read().unwrap().height();
3630 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3631 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3632 &self.entropy_source, &self.node_signer, best_block_height,
3633 |args| self.send_payment_along_path(args))
3636 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3639 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3640 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3643 /// Sends payment probes over all paths of a route that would be used to pay the given
3644 /// amount to the given `node_id`.
3646 /// See [`ChannelManager::send_preflight_probes`] for more information.
3647 pub fn send_spontaneous_preflight_probes(
3648 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3649 liquidity_limit_multiplier: Option<u64>,
3650 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3651 let payment_params =
3652 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3654 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
3656 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3659 /// Sends payment probes over all paths of a route that would be used to pay a route found
3660 /// according to the given [`RouteParameters`].
3662 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3663 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3664 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3665 /// confirmation in a wallet UI.
3667 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3668 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3669 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3670 /// payment. To mitigate this issue, channels with available liquidity less than the required
3671 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3672 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3673 pub fn send_preflight_probes(
3674 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3675 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3676 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3678 let payer = self.get_our_node_id();
3679 let usable_channels = self.list_usable_channels();
3680 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3681 let inflight_htlcs = self.compute_inflight_htlcs();
3685 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3687 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3688 ProbeSendFailure::RouteNotFound
3691 let mut used_liquidity_map = HashMap::with_capacity(first_hops.len());
3693 let mut res = Vec::new();
3695 for mut path in route.paths {
3696 // If the last hop is probably an unannounced channel we refrain from probing all the
3697 // way through to the end and instead probe up to the second-to-last channel.
3698 while let Some(last_path_hop) = path.hops.last() {
3699 if last_path_hop.maybe_announced_channel {
3700 // We found a potentially announced last hop.
3703 // Drop the last hop, as it's likely unannounced.
3706 "Avoided sending payment probe all the way to last hop {} as it is likely unannounced.",
3707 last_path_hop.short_channel_id
3709 let final_value_msat = path.final_value_msat();
3711 if let Some(new_last) = path.hops.last_mut() {
3712 new_last.fee_msat += final_value_msat;
3717 if path.hops.len() < 2 {
3720 "Skipped sending payment probe over path with less than two hops."
3725 if let Some(first_path_hop) = path.hops.first() {
3726 if let Some(first_hop) = first_hops.iter().find(|h| {
3727 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3729 let path_value = path.final_value_msat() + path.fee_msat();
3730 let used_liquidity =
3731 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3733 if first_hop.next_outbound_htlc_limit_msat
3734 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3736 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3739 *used_liquidity += path_value;
3744 res.push(self.send_probe(path).map_err(|e| {
3745 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3746 ProbeSendFailure::SendingFailed(e)
3753 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3754 /// which checks the correctness of the funding transaction given the associated channel.
3755 fn funding_transaction_generated_intern<FundingOutput: FnMut(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3756 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, is_batch_funding: bool,
3757 mut find_funding_output: FundingOutput,
3758 ) -> Result<(), APIError> {
3759 let per_peer_state = self.per_peer_state.read().unwrap();
3760 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3761 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3763 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3764 let peer_state = &mut *peer_state_lock;
3766 let (mut chan, msg_opt) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3767 Some(ChannelPhase::UnfundedOutboundV1(mut chan)) => {
3768 funding_txo = find_funding_output(&chan, &funding_transaction)?;
3770 let logger = WithChannelContext::from(&self.logger, &chan.context);
3771 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, is_batch_funding, &&logger)
3772 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3773 let channel_id = chan.context.channel_id();
3774 let reason = ClosureReason::ProcessingError { err: msg.clone() };
3775 let shutdown_res = chan.context.force_shutdown(false, reason);
3776 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, None))
3777 } else { unreachable!(); });
3779 Ok(funding_msg) => (chan, funding_msg),
3780 Err((chan, err)) => {
3781 mem::drop(peer_state_lock);
3782 mem::drop(per_peer_state);
3783 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3784 return Err(APIError::ChannelUnavailable {
3785 err: "Signer refused to sign the initial commitment transaction".to_owned()
3791 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3792 return Err(APIError::APIMisuseError {
3794 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3795 temporary_channel_id, counterparty_node_id),
3798 None => return Err(APIError::ChannelUnavailable {err: format!(
3799 "Channel with id {} not found for the passed counterparty node_id {}",
3800 temporary_channel_id, counterparty_node_id),
3804 if let Some(msg) = msg_opt {
3805 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3806 node_id: chan.context.get_counterparty_node_id(),
3810 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3811 hash_map::Entry::Occupied(_) => {
3812 panic!("Generated duplicate funding txid?");
3814 hash_map::Entry::Vacant(e) => {
3815 let mut outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
3816 match outpoint_to_peer.entry(funding_txo) {
3817 hash_map::Entry::Vacant(e) => { e.insert(chan.context.get_counterparty_node_id()); },
3818 hash_map::Entry::Occupied(o) => {
3820 "An existing channel using outpoint {} is open with peer {}",
3821 funding_txo, o.get()
3823 mem::drop(outpoint_to_peer);
3824 mem::drop(peer_state_lock);
3825 mem::drop(per_peer_state);
3826 let reason = ClosureReason::ProcessingError { err: err.clone() };
3827 self.finish_close_channel(chan.context.force_shutdown(true, reason));
3828 return Err(APIError::ChannelUnavailable { err });
3831 e.insert(ChannelPhase::UnfundedOutboundV1(chan));
3838 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3839 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, false, |_, tx| {
3840 Ok(OutPoint { txid: tx.txid(), index: output_index })
3844 /// Call this upon creation of a funding transaction for the given channel.
3846 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3847 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3849 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3850 /// across the p2p network.
3852 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3853 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3855 /// May panic if the output found in the funding transaction is duplicative with some other
3856 /// channel (note that this should be trivially prevented by using unique funding transaction
3857 /// keys per-channel).
3859 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3860 /// counterparty's signature the funding transaction will automatically be broadcast via the
3861 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3863 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3864 /// not currently support replacing a funding transaction on an existing channel. Instead,
3865 /// create a new channel with a conflicting funding transaction.
3867 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3868 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3869 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3870 /// for more details.
3872 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3873 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3874 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3875 self.batch_funding_transaction_generated(&[(temporary_channel_id, counterparty_node_id)], funding_transaction)
3878 /// Call this upon creation of a batch funding transaction for the given channels.
3880 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
3881 /// each individual channel and transaction output.
3883 /// Do NOT broadcast the funding transaction yourself. This batch funding transaction
3884 /// will only be broadcast when we have safely received and persisted the counterparty's
3885 /// signature for each channel.
3887 /// If there is an error, all channels in the batch are to be considered closed.
3888 pub fn batch_funding_transaction_generated(&self, temporary_channels: &[(&ChannelId, &PublicKey)], funding_transaction: Transaction) -> Result<(), APIError> {
3889 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3890 let mut result = Ok(());
3892 if !funding_transaction.is_coin_base() {
3893 for inp in funding_transaction.input.iter() {
3894 if inp.witness.is_empty() {
3895 result = result.and(Err(APIError::APIMisuseError {
3896 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3901 if funding_transaction.output.len() > u16::max_value() as usize {
3902 result = result.and(Err(APIError::APIMisuseError {
3903 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3907 let height = self.best_block.read().unwrap().height();
3908 // Transactions are evaluated as final by network mempools if their locktime is strictly
3909 // lower than the next block height. However, the modules constituting our Lightning
3910 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3911 // module is ahead of LDK, only allow one more block of headroom.
3912 if !funding_transaction.input.iter().all(|input| input.sequence == Sequence::MAX) &&
3913 funding_transaction.lock_time.is_block_height() &&
3914 funding_transaction.lock_time.to_consensus_u32() > height + 1
3916 result = result.and(Err(APIError::APIMisuseError {
3917 err: "Funding transaction absolute timelock is non-final".to_owned()
3922 let txid = funding_transaction.txid();
3923 let is_batch_funding = temporary_channels.len() > 1;
3924 let mut funding_batch_states = if is_batch_funding {
3925 Some(self.funding_batch_states.lock().unwrap())
3929 let mut funding_batch_state = funding_batch_states.as_mut().and_then(|states| {
3930 match states.entry(txid) {
3931 btree_map::Entry::Occupied(_) => {
3932 result = result.clone().and(Err(APIError::APIMisuseError {
3933 err: "Batch funding transaction with the same txid already exists".to_owned()
3937 btree_map::Entry::Vacant(vacant) => Some(vacant.insert(Vec::new())),
3940 for &(temporary_channel_id, counterparty_node_id) in temporary_channels {
3941 result = result.and_then(|_| self.funding_transaction_generated_intern(
3942 temporary_channel_id,
3943 counterparty_node_id,
3944 funding_transaction.clone(),
3947 let mut output_index = None;
3948 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3949 for (idx, outp) in tx.output.iter().enumerate() {
3950 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3951 if output_index.is_some() {
3952 return Err(APIError::APIMisuseError {
3953 err: "Multiple outputs matched the expected script and value".to_owned()
3956 output_index = Some(idx as u16);
3959 if output_index.is_none() {
3960 return Err(APIError::APIMisuseError {
3961 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3964 let outpoint = OutPoint { txid: tx.txid(), index: output_index.unwrap() };
3965 if let Some(funding_batch_state) = funding_batch_state.as_mut() {
3966 // TODO(dual_funding): We only do batch funding for V1 channels at the moment, but we'll probably
3967 // need to fix this somehow to not rely on using the outpoint for the channel ID if we
3968 // want to support V2 batching here as well.
3969 funding_batch_state.push((ChannelId::v1_from_funding_outpoint(outpoint), *counterparty_node_id, false));
3975 if let Err(ref e) = result {
3976 // Remaining channels need to be removed on any error.
3977 let e = format!("Error in transaction funding: {:?}", e);
3978 let mut channels_to_remove = Vec::new();
3979 channels_to_remove.extend(funding_batch_states.as_mut()
3980 .and_then(|states| states.remove(&txid))
3981 .into_iter().flatten()
3982 .map(|(chan_id, node_id, _state)| (chan_id, node_id))
3984 channels_to_remove.extend(temporary_channels.iter()
3985 .map(|(&chan_id, &node_id)| (chan_id, node_id))
3987 let mut shutdown_results = Vec::new();
3989 let per_peer_state = self.per_peer_state.read().unwrap();
3990 for (channel_id, counterparty_node_id) in channels_to_remove {
3991 per_peer_state.get(&counterparty_node_id)
3992 .map(|peer_state_mutex| peer_state_mutex.lock().unwrap())
3993 .and_then(|mut peer_state| peer_state.channel_by_id.remove(&channel_id))
3995 update_maps_on_chan_removal!(self, &chan.context());
3996 let closure_reason = ClosureReason::ProcessingError { err: e.clone() };
3997 shutdown_results.push(chan.context_mut().force_shutdown(false, closure_reason));
4001 mem::drop(funding_batch_states);
4002 for shutdown_result in shutdown_results.drain(..) {
4003 self.finish_close_channel(shutdown_result);
4009 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
4011 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4012 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4013 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4014 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4016 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4017 /// `counterparty_node_id` is provided.
4019 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4020 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4022 /// If an error is returned, none of the updates should be considered applied.
4024 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4025 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4026 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4027 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4028 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4029 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4030 /// [`APIMisuseError`]: APIError::APIMisuseError
4031 pub fn update_partial_channel_config(
4032 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
4033 ) -> Result<(), APIError> {
4034 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
4035 return Err(APIError::APIMisuseError {
4036 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
4040 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4041 let per_peer_state = self.per_peer_state.read().unwrap();
4042 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4043 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4044 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4045 let peer_state = &mut *peer_state_lock;
4046 for channel_id in channel_ids {
4047 if !peer_state.has_channel(channel_id) {
4048 return Err(APIError::ChannelUnavailable {
4049 err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, counterparty_node_id),
4053 for channel_id in channel_ids {
4054 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
4055 let mut config = channel_phase.context().config();
4056 config.apply(config_update);
4057 if !channel_phase.context_mut().update_config(&config) {
4060 if let ChannelPhase::Funded(channel) = channel_phase {
4061 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
4062 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
4063 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
4064 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4065 node_id: channel.context.get_counterparty_node_id(),
4072 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
4073 debug_assert!(false);
4074 return Err(APIError::ChannelUnavailable {
4076 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
4077 channel_id, counterparty_node_id),
4084 /// Atomically updates the [`ChannelConfig`] for the given channels.
4086 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4087 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4088 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4089 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4091 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4092 /// `counterparty_node_id` is provided.
4094 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4095 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4097 /// If an error is returned, none of the updates should be considered applied.
4099 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4100 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4101 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4102 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4103 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4104 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4105 /// [`APIMisuseError`]: APIError::APIMisuseError
4106 pub fn update_channel_config(
4107 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
4108 ) -> Result<(), APIError> {
4109 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
4112 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
4113 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
4115 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
4116 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
4118 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
4119 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
4120 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
4121 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
4122 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
4124 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
4125 /// you from forwarding more than you received. See
4126 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
4129 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4132 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
4133 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4134 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
4135 // TODO: when we move to deciding the best outbound channel at forward time, only take
4136 // `next_node_id` and not `next_hop_channel_id`
4137 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> {
4138 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4140 let next_hop_scid = {
4141 let peer_state_lock = self.per_peer_state.read().unwrap();
4142 let peer_state_mutex = peer_state_lock.get(&next_node_id)
4143 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
4144 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4145 let peer_state = &mut *peer_state_lock;
4146 match peer_state.channel_by_id.get(next_hop_channel_id) {
4147 Some(ChannelPhase::Funded(chan)) => {
4148 if !chan.context.is_usable() {
4149 return Err(APIError::ChannelUnavailable {
4150 err: format!("Channel with id {} not fully established", next_hop_channel_id)
4153 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
4155 Some(_) => return Err(APIError::ChannelUnavailable {
4156 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
4157 next_hop_channel_id, next_node_id)
4160 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
4161 next_hop_channel_id, next_node_id);
4162 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
4163 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
4164 return Err(APIError::ChannelUnavailable {
4171 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4172 .ok_or_else(|| APIError::APIMisuseError {
4173 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4176 let routing = match payment.forward_info.routing {
4177 PendingHTLCRouting::Forward { onion_packet, blinded, .. } => {
4178 PendingHTLCRouting::Forward {
4179 onion_packet, blinded, short_channel_id: next_hop_scid
4182 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
4184 let skimmed_fee_msat =
4185 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
4186 let pending_htlc_info = PendingHTLCInfo {
4187 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
4188 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
4191 let mut per_source_pending_forward = [(
4192 payment.prev_short_channel_id,
4193 payment.prev_funding_outpoint,
4194 payment.prev_channel_id,
4195 payment.prev_user_channel_id,
4196 vec![(pending_htlc_info, payment.prev_htlc_id)]
4198 self.forward_htlcs(&mut per_source_pending_forward);
4202 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
4203 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
4205 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4208 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4209 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
4210 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4212 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4213 .ok_or_else(|| APIError::APIMisuseError {
4214 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4217 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
4218 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4219 short_channel_id: payment.prev_short_channel_id,
4220 user_channel_id: Some(payment.prev_user_channel_id),
4221 outpoint: payment.prev_funding_outpoint,
4222 channel_id: payment.prev_channel_id,
4223 htlc_id: payment.prev_htlc_id,
4224 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
4225 phantom_shared_secret: None,
4226 blinded_failure: payment.forward_info.routing.blinded_failure(),
4229 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
4230 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
4231 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
4232 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
4237 /// Processes HTLCs which are pending waiting on random forward delay.
4239 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
4240 /// Will likely generate further events.
4241 pub fn process_pending_htlc_forwards(&self) {
4242 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4244 let mut new_events = VecDeque::new();
4245 let mut failed_forwards = Vec::new();
4246 let mut phantom_receives: Vec<(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
4248 let mut forward_htlcs = HashMap::new();
4249 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
4251 for (short_chan_id, mut pending_forwards) in forward_htlcs {
4252 if short_chan_id != 0 {
4253 let mut forwarding_counterparty = None;
4254 macro_rules! forwarding_channel_not_found {
4256 for forward_info in pending_forwards.drain(..) {
4257 match forward_info {
4258 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4259 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4260 prev_user_channel_id, forward_info: PendingHTLCInfo {
4261 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
4262 outgoing_cltv_value, ..
4265 macro_rules! failure_handler {
4266 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
4267 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_channel_id));
4268 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
4270 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4271 short_channel_id: prev_short_channel_id,
4272 user_channel_id: Some(prev_user_channel_id),
4273 channel_id: prev_channel_id,
4274 outpoint: prev_funding_outpoint,
4275 htlc_id: prev_htlc_id,
4276 incoming_packet_shared_secret: incoming_shared_secret,
4277 phantom_shared_secret: $phantom_ss,
4278 blinded_failure: routing.blinded_failure(),
4281 let reason = if $next_hop_unknown {
4282 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
4284 HTLCDestination::FailedPayment{ payment_hash }
4287 failed_forwards.push((htlc_source, payment_hash,
4288 HTLCFailReason::reason($err_code, $err_data),
4294 macro_rules! fail_forward {
4295 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4297 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4301 macro_rules! failed_payment {
4302 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4304 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4308 if let PendingHTLCRouting::Forward { ref onion_packet, .. } = routing {
4309 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4310 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.chain_hash) {
4311 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4312 let next_hop = match onion_utils::decode_next_payment_hop(
4313 phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac,
4314 payment_hash, None, &self.node_signer
4317 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4318 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).to_byte_array();
4319 // In this scenario, the phantom would have sent us an
4320 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4321 // if it came from us (the second-to-last hop) but contains the sha256
4323 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4325 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4326 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4330 onion_utils::Hop::Receive(hop_data) => {
4331 let current_height: u32 = self.best_block.read().unwrap().height();
4332 match create_recv_pending_htlc_info(hop_data,
4333 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4334 outgoing_cltv_value, Some(phantom_shared_secret), false, None,
4335 current_height, self.default_configuration.accept_mpp_keysend)
4337 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4338 Err(InboundHTLCErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4344 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4347 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4350 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4351 // Channel went away before we could fail it. This implies
4352 // the channel is now on chain and our counterparty is
4353 // trying to broadcast the HTLC-Timeout, but that's their
4354 // problem, not ours.
4360 let chan_info_opt = self.short_to_chan_info.read().unwrap().get(&short_chan_id).cloned();
4361 let (counterparty_node_id, forward_chan_id) = match chan_info_opt {
4362 Some((cp_id, chan_id)) => (cp_id, chan_id),
4364 forwarding_channel_not_found!();
4368 forwarding_counterparty = Some(counterparty_node_id);
4369 let per_peer_state = self.per_peer_state.read().unwrap();
4370 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4371 if peer_state_mutex_opt.is_none() {
4372 forwarding_channel_not_found!();
4375 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4376 let peer_state = &mut *peer_state_lock;
4377 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4378 let logger = WithChannelContext::from(&self.logger, &chan.context);
4379 for forward_info in pending_forwards.drain(..) {
4380 let queue_fail_htlc_res = match forward_info {
4381 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4382 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4383 prev_user_channel_id, forward_info: PendingHTLCInfo {
4384 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4385 routing: PendingHTLCRouting::Forward {
4386 onion_packet, blinded, ..
4387 }, skimmed_fee_msat, ..
4390 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);
4391 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4392 short_channel_id: prev_short_channel_id,
4393 user_channel_id: Some(prev_user_channel_id),
4394 channel_id: prev_channel_id,
4395 outpoint: prev_funding_outpoint,
4396 htlc_id: prev_htlc_id,
4397 incoming_packet_shared_secret: incoming_shared_secret,
4398 // Phantom payments are only PendingHTLCRouting::Receive.
4399 phantom_shared_secret: None,
4400 blinded_failure: blinded.map(|b| b.failure),
4402 let next_blinding_point = blinded.and_then(|b| {
4403 let encrypted_tlvs_ss = self.node_signer.ecdh(
4404 Recipient::Node, &b.inbound_blinding_point, None
4405 ).unwrap().secret_bytes();
4406 onion_utils::next_hop_pubkey(
4407 &self.secp_ctx, b.inbound_blinding_point, &encrypted_tlvs_ss
4410 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4411 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4412 onion_packet, skimmed_fee_msat, next_blinding_point, &self.fee_estimator,
4415 if let ChannelError::Ignore(msg) = e {
4416 log_trace!(logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4418 panic!("Stated return value requirements in send_htlc() were not met");
4420 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4421 failed_forwards.push((htlc_source, payment_hash,
4422 HTLCFailReason::reason(failure_code, data),
4423 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4429 HTLCForwardInfo::AddHTLC { .. } => {
4430 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4432 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4433 log_trace!(logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4434 Some((chan.queue_fail_htlc(htlc_id, err_packet, &&logger), htlc_id))
4436 HTLCForwardInfo::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
4437 log_trace!(logger, "Failing malformed HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4438 let res = chan.queue_fail_malformed_htlc(
4439 htlc_id, failure_code, sha256_of_onion, &&logger
4441 Some((res, htlc_id))
4444 if let Some((queue_fail_htlc_res, htlc_id)) = queue_fail_htlc_res {
4445 if let Err(e) = queue_fail_htlc_res {
4446 if let ChannelError::Ignore(msg) = e {
4447 log_trace!(logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4449 panic!("Stated return value requirements in queue_fail_{{malformed_}}htlc() were not met");
4451 // fail-backs are best-effort, we probably already have one
4452 // pending, and if not that's OK, if not, the channel is on
4453 // the chain and sending the HTLC-Timeout is their problem.
4459 forwarding_channel_not_found!();
4463 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4464 match forward_info {
4465 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4466 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4467 prev_user_channel_id, forward_info: PendingHTLCInfo {
4468 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4469 skimmed_fee_msat, ..
4472 let blinded_failure = routing.blinded_failure();
4473 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4474 PendingHTLCRouting::Receive {
4475 payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret,
4476 custom_tlvs, requires_blinded_error: _
4478 let _legacy_hop_data = Some(payment_data.clone());
4479 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4480 payment_metadata, custom_tlvs };
4481 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4482 Some(payment_data), phantom_shared_secret, onion_fields)
4484 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4485 let onion_fields = RecipientOnionFields {
4486 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4490 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4491 payment_data, None, onion_fields)
4494 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4497 let claimable_htlc = ClaimableHTLC {
4498 prev_hop: HTLCPreviousHopData {
4499 short_channel_id: prev_short_channel_id,
4500 user_channel_id: Some(prev_user_channel_id),
4501 channel_id: prev_channel_id,
4502 outpoint: prev_funding_outpoint,
4503 htlc_id: prev_htlc_id,
4504 incoming_packet_shared_secret: incoming_shared_secret,
4505 phantom_shared_secret,
4508 // We differentiate the received value from the sender intended value
4509 // if possible so that we don't prematurely mark MPP payments complete
4510 // if routing nodes overpay
4511 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4512 sender_intended_value: outgoing_amt_msat,
4514 total_value_received: None,
4515 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4518 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4521 let mut committed_to_claimable = false;
4523 macro_rules! fail_htlc {
4524 ($htlc: expr, $payment_hash: expr) => {
4525 debug_assert!(!committed_to_claimable);
4526 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4527 htlc_msat_height_data.extend_from_slice(
4528 &self.best_block.read().unwrap().height().to_be_bytes(),
4530 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4531 short_channel_id: $htlc.prev_hop.short_channel_id,
4532 user_channel_id: $htlc.prev_hop.user_channel_id,
4533 channel_id: prev_channel_id,
4534 outpoint: prev_funding_outpoint,
4535 htlc_id: $htlc.prev_hop.htlc_id,
4536 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4537 phantom_shared_secret,
4540 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4541 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4543 continue 'next_forwardable_htlc;
4546 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4547 let mut receiver_node_id = self.our_network_pubkey;
4548 if phantom_shared_secret.is_some() {
4549 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4550 .expect("Failed to get node_id for phantom node recipient");
4553 macro_rules! check_total_value {
4554 ($purpose: expr) => {{
4555 let mut payment_claimable_generated = false;
4556 let is_keysend = match $purpose {
4557 events::PaymentPurpose::SpontaneousPayment(_) => true,
4558 events::PaymentPurpose::InvoicePayment { .. } => false,
4560 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4561 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4562 fail_htlc!(claimable_htlc, payment_hash);
4564 let ref mut claimable_payment = claimable_payments.claimable_payments
4565 .entry(payment_hash)
4566 // Note that if we insert here we MUST NOT fail_htlc!()
4567 .or_insert_with(|| {
4568 committed_to_claimable = true;
4570 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4573 if $purpose != claimable_payment.purpose {
4574 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4575 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));
4576 fail_htlc!(claimable_htlc, payment_hash);
4578 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4579 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);
4580 fail_htlc!(claimable_htlc, payment_hash);
4582 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4583 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4584 fail_htlc!(claimable_htlc, payment_hash);
4587 claimable_payment.onion_fields = Some(onion_fields);
4589 let ref mut htlcs = &mut claimable_payment.htlcs;
4590 let mut total_value = claimable_htlc.sender_intended_value;
4591 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4592 for htlc in htlcs.iter() {
4593 total_value += htlc.sender_intended_value;
4594 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4595 if htlc.total_msat != claimable_htlc.total_msat {
4596 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4597 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4598 total_value = msgs::MAX_VALUE_MSAT;
4600 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4602 // The condition determining whether an MPP is complete must
4603 // match exactly the condition used in `timer_tick_occurred`
4604 if total_value >= msgs::MAX_VALUE_MSAT {
4605 fail_htlc!(claimable_htlc, payment_hash);
4606 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4607 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4609 fail_htlc!(claimable_htlc, payment_hash);
4610 } else if total_value >= claimable_htlc.total_msat {
4611 #[allow(unused_assignments)] {
4612 committed_to_claimable = true;
4614 htlcs.push(claimable_htlc);
4615 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4616 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4617 let counterparty_skimmed_fee_msat = htlcs.iter()
4618 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4619 debug_assert!(total_value.saturating_sub(amount_msat) <=
4620 counterparty_skimmed_fee_msat);
4621 new_events.push_back((events::Event::PaymentClaimable {
4622 receiver_node_id: Some(receiver_node_id),
4626 counterparty_skimmed_fee_msat,
4627 via_channel_id: Some(prev_channel_id),
4628 via_user_channel_id: Some(prev_user_channel_id),
4629 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4630 onion_fields: claimable_payment.onion_fields.clone(),
4632 payment_claimable_generated = true;
4634 // Nothing to do - we haven't reached the total
4635 // payment value yet, wait until we receive more
4637 htlcs.push(claimable_htlc);
4638 #[allow(unused_assignments)] {
4639 committed_to_claimable = true;
4642 payment_claimable_generated
4646 // Check that the payment hash and secret are known. Note that we
4647 // MUST take care to handle the "unknown payment hash" and
4648 // "incorrect payment secret" cases here identically or we'd expose
4649 // that we are the ultimate recipient of the given payment hash.
4650 // Further, we must not expose whether we have any other HTLCs
4651 // associated with the same payment_hash pending or not.
4652 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4653 match payment_secrets.entry(payment_hash) {
4654 hash_map::Entry::Vacant(_) => {
4655 match claimable_htlc.onion_payload {
4656 OnionPayload::Invoice { .. } => {
4657 let payment_data = payment_data.unwrap();
4658 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) {
4659 Ok(result) => result,
4661 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4662 fail_htlc!(claimable_htlc, payment_hash);
4665 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4666 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4667 if (cltv_expiry as u64) < expected_min_expiry_height {
4668 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4669 &payment_hash, cltv_expiry, expected_min_expiry_height);
4670 fail_htlc!(claimable_htlc, payment_hash);
4673 let purpose = events::PaymentPurpose::InvoicePayment {
4674 payment_preimage: payment_preimage.clone(),
4675 payment_secret: payment_data.payment_secret,
4677 check_total_value!(purpose);
4679 OnionPayload::Spontaneous(preimage) => {
4680 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4681 check_total_value!(purpose);
4685 hash_map::Entry::Occupied(inbound_payment) => {
4686 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4687 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);
4688 fail_htlc!(claimable_htlc, payment_hash);
4690 let payment_data = payment_data.unwrap();
4691 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4692 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4693 fail_htlc!(claimable_htlc, payment_hash);
4694 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4695 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4696 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4697 fail_htlc!(claimable_htlc, payment_hash);
4699 let purpose = events::PaymentPurpose::InvoicePayment {
4700 payment_preimage: inbound_payment.get().payment_preimage,
4701 payment_secret: payment_data.payment_secret,
4703 let payment_claimable_generated = check_total_value!(purpose);
4704 if payment_claimable_generated {
4705 inbound_payment.remove_entry();
4711 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4712 panic!("Got pending fail of our own HTLC");
4720 let best_block_height = self.best_block.read().unwrap().height();
4721 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4722 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4723 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4725 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4726 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4728 self.forward_htlcs(&mut phantom_receives);
4730 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4731 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4732 // nice to do the work now if we can rather than while we're trying to get messages in the
4734 self.check_free_holding_cells();
4736 if new_events.is_empty() { return }
4737 let mut events = self.pending_events.lock().unwrap();
4738 events.append(&mut new_events);
4741 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4743 /// Expects the caller to have a total_consistency_lock read lock.
4744 fn process_background_events(&self) -> NotifyOption {
4745 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4747 self.background_events_processed_since_startup.store(true, Ordering::Release);
4749 let mut background_events = Vec::new();
4750 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4751 if background_events.is_empty() {
4752 return NotifyOption::SkipPersistNoEvents;
4755 for event in background_events.drain(..) {
4757 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, _channel_id, update)) => {
4758 // The channel has already been closed, so no use bothering to care about the
4759 // monitor updating completing.
4760 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4762 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, channel_id, update } => {
4763 let mut updated_chan = false;
4765 let per_peer_state = self.per_peer_state.read().unwrap();
4766 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4767 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4768 let peer_state = &mut *peer_state_lock;
4769 match peer_state.channel_by_id.entry(channel_id) {
4770 hash_map::Entry::Occupied(mut chan_phase) => {
4771 if let ChannelPhase::Funded(chan) = chan_phase.get_mut() {
4772 updated_chan = true;
4773 handle_new_monitor_update!(self, funding_txo, channel_id, update.clone(),
4774 peer_state_lock, peer_state, per_peer_state, chan);
4776 debug_assert!(false, "We shouldn't have an update for a non-funded channel");
4779 hash_map::Entry::Vacant(_) => {},
4784 // TODO: Track this as in-flight even though the channel is closed.
4785 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4788 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4789 let per_peer_state = self.per_peer_state.read().unwrap();
4790 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4791 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4792 let peer_state = &mut *peer_state_lock;
4793 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4794 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4796 let update_actions = peer_state.monitor_update_blocked_actions
4797 .remove(&channel_id).unwrap_or(Vec::new());
4798 mem::drop(peer_state_lock);
4799 mem::drop(per_peer_state);
4800 self.handle_monitor_update_completion_actions(update_actions);
4806 NotifyOption::DoPersist
4809 #[cfg(any(test, feature = "_test_utils"))]
4810 /// Process background events, for functional testing
4811 pub fn test_process_background_events(&self) {
4812 let _lck = self.total_consistency_lock.read().unwrap();
4813 let _ = self.process_background_events();
4816 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4817 if !chan.context.is_outbound() { return NotifyOption::SkipPersistNoEvents; }
4819 let logger = WithChannelContext::from(&self.logger, &chan.context);
4821 // If the feerate has decreased by less than half, don't bother
4822 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4823 if new_feerate != chan.context.get_feerate_sat_per_1000_weight() {
4824 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4825 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4827 return NotifyOption::SkipPersistNoEvents;
4829 if !chan.context.is_live() {
4830 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {} as it cannot currently be updated (probably the peer is disconnected).",
4831 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4832 return NotifyOption::SkipPersistNoEvents;
4834 log_trace!(logger, "Channel {} qualifies for a feerate change from {} to {}.",
4835 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4837 chan.queue_update_fee(new_feerate, &self.fee_estimator, &&logger);
4838 NotifyOption::DoPersist
4842 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4843 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4844 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4845 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4846 pub fn maybe_update_chan_fees(&self) {
4847 PersistenceNotifierGuard::optionally_notify(self, || {
4848 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4850 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4851 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4853 let per_peer_state = self.per_peer_state.read().unwrap();
4854 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4855 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4856 let peer_state = &mut *peer_state_lock;
4857 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4858 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4860 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4865 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4866 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4874 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4876 /// This currently includes:
4877 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4878 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4879 /// than a minute, informing the network that they should no longer attempt to route over
4881 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4882 /// with the current [`ChannelConfig`].
4883 /// * Removing peers which have disconnected but and no longer have any channels.
4884 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4885 /// * Forgetting about stale outbound payments, either those that have already been fulfilled
4886 /// or those awaiting an invoice that hasn't been delivered in the necessary amount of time.
4887 /// The latter is determined using the system clock in `std` and the highest seen block time
4888 /// minus two hours in `no-std`.
4890 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4891 /// estimate fetches.
4893 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4894 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4895 pub fn timer_tick_occurred(&self) {
4896 PersistenceNotifierGuard::optionally_notify(self, || {
4897 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4899 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4900 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4902 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4903 let mut timed_out_mpp_htlcs = Vec::new();
4904 let mut pending_peers_awaiting_removal = Vec::new();
4905 let mut shutdown_channels = Vec::new();
4907 let mut process_unfunded_channel_tick = |
4908 chan_id: &ChannelId,
4909 context: &mut ChannelContext<SP>,
4910 unfunded_context: &mut UnfundedChannelContext,
4911 pending_msg_events: &mut Vec<MessageSendEvent>,
4912 counterparty_node_id: PublicKey,
4914 context.maybe_expire_prev_config();
4915 if unfunded_context.should_expire_unfunded_channel() {
4916 let logger = WithChannelContext::from(&self.logger, context);
4918 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4919 update_maps_on_chan_removal!(self, &context);
4920 shutdown_channels.push(context.force_shutdown(false, ClosureReason::HolderForceClosed));
4921 pending_msg_events.push(MessageSendEvent::HandleError {
4922 node_id: counterparty_node_id,
4923 action: msgs::ErrorAction::SendErrorMessage {
4924 msg: msgs::ErrorMessage {
4925 channel_id: *chan_id,
4926 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4937 let per_peer_state = self.per_peer_state.read().unwrap();
4938 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4939 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4940 let peer_state = &mut *peer_state_lock;
4941 let pending_msg_events = &mut peer_state.pending_msg_events;
4942 let counterparty_node_id = *counterparty_node_id;
4943 peer_state.channel_by_id.retain(|chan_id, phase| {
4945 ChannelPhase::Funded(chan) => {
4946 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4951 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4952 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4954 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4955 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4956 handle_errors.push((Err(err), counterparty_node_id));
4957 if needs_close { return false; }
4960 match chan.channel_update_status() {
4961 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4962 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4963 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4964 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4965 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4966 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4967 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4969 if n >= DISABLE_GOSSIP_TICKS {
4970 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4971 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4972 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4976 should_persist = NotifyOption::DoPersist;
4978 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4981 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4983 if n >= ENABLE_GOSSIP_TICKS {
4984 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4985 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4986 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4990 should_persist = NotifyOption::DoPersist;
4992 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4998 chan.context.maybe_expire_prev_config();
5000 if chan.should_disconnect_peer_awaiting_response() {
5001 let logger = WithChannelContext::from(&self.logger, &chan.context);
5002 log_debug!(logger, "Disconnecting peer {} due to not making any progress on channel {}",
5003 counterparty_node_id, chan_id);
5004 pending_msg_events.push(MessageSendEvent::HandleError {
5005 node_id: counterparty_node_id,
5006 action: msgs::ErrorAction::DisconnectPeerWithWarning {
5007 msg: msgs::WarningMessage {
5008 channel_id: *chan_id,
5009 data: "Disconnecting due to timeout awaiting response".to_owned(),
5017 ChannelPhase::UnfundedInboundV1(chan) => {
5018 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
5019 pending_msg_events, counterparty_node_id)
5021 ChannelPhase::UnfundedOutboundV1(chan) => {
5022 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
5023 pending_msg_events, counterparty_node_id)
5028 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
5029 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
5030 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(*chan_id));
5031 log_error!(logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
5032 peer_state.pending_msg_events.push(
5033 events::MessageSendEvent::HandleError {
5034 node_id: counterparty_node_id,
5035 action: msgs::ErrorAction::SendErrorMessage {
5036 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
5042 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
5044 if peer_state.ok_to_remove(true) {
5045 pending_peers_awaiting_removal.push(counterparty_node_id);
5050 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
5051 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
5052 // of to that peer is later closed while still being disconnected (i.e. force closed),
5053 // we therefore need to remove the peer from `peer_state` separately.
5054 // To avoid having to take the `per_peer_state` `write` lock once the channels are
5055 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
5056 // negative effects on parallelism as much as possible.
5057 if pending_peers_awaiting_removal.len() > 0 {
5058 let mut per_peer_state = self.per_peer_state.write().unwrap();
5059 for counterparty_node_id in pending_peers_awaiting_removal {
5060 match per_peer_state.entry(counterparty_node_id) {
5061 hash_map::Entry::Occupied(entry) => {
5062 // Remove the entry if the peer is still disconnected and we still
5063 // have no channels to the peer.
5064 let remove_entry = {
5065 let peer_state = entry.get().lock().unwrap();
5066 peer_state.ok_to_remove(true)
5069 entry.remove_entry();
5072 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
5077 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
5078 if payment.htlcs.is_empty() {
5079 // This should be unreachable
5080 debug_assert!(false);
5083 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
5084 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
5085 // In this case we're not going to handle any timeouts of the parts here.
5086 // This condition determining whether the MPP is complete here must match
5087 // exactly the condition used in `process_pending_htlc_forwards`.
5088 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
5089 .fold(0, |total, htlc| total + htlc.sender_intended_value)
5092 } else if payment.htlcs.iter_mut().any(|htlc| {
5093 htlc.timer_ticks += 1;
5094 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
5096 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
5097 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
5104 for htlc_source in timed_out_mpp_htlcs.drain(..) {
5105 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
5106 let reason = HTLCFailReason::from_failure_code(23);
5107 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
5108 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
5111 for (err, counterparty_node_id) in handle_errors.drain(..) {
5112 let _ = handle_error!(self, err, counterparty_node_id);
5115 for shutdown_res in shutdown_channels {
5116 self.finish_close_channel(shutdown_res);
5119 #[cfg(feature = "std")]
5120 let duration_since_epoch = std::time::SystemTime::now()
5121 .duration_since(std::time::SystemTime::UNIX_EPOCH)
5122 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
5123 #[cfg(not(feature = "std"))]
5124 let duration_since_epoch = Duration::from_secs(
5125 self.highest_seen_timestamp.load(Ordering::Acquire).saturating_sub(7200) as u64
5128 self.pending_outbound_payments.remove_stale_payments(
5129 duration_since_epoch, &self.pending_events
5132 // Technically we don't need to do this here, but if we have holding cell entries in a
5133 // channel that need freeing, it's better to do that here and block a background task
5134 // than block the message queueing pipeline.
5135 if self.check_free_holding_cells() {
5136 should_persist = NotifyOption::DoPersist;
5143 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
5144 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
5145 /// along the path (including in our own channel on which we received it).
5147 /// Note that in some cases around unclean shutdown, it is possible the payment may have
5148 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
5149 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
5150 /// may have already been failed automatically by LDK if it was nearing its expiration time.
5152 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
5153 /// [`ChannelManager::claim_funds`]), you should still monitor for
5154 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
5155 /// startup during which time claims that were in-progress at shutdown may be replayed.
5156 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
5157 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
5160 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
5161 /// reason for the failure.
5163 /// See [`FailureCode`] for valid failure codes.
5164 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
5165 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5167 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
5168 if let Some(payment) = removed_source {
5169 for htlc in payment.htlcs {
5170 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
5171 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5172 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
5173 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5178 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
5179 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
5180 match failure_code {
5181 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
5182 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
5183 FailureCode::IncorrectOrUnknownPaymentDetails => {
5184 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5185 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5186 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
5188 FailureCode::InvalidOnionPayload(data) => {
5189 let fail_data = match data {
5190 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
5193 HTLCFailReason::reason(failure_code.into(), fail_data)
5198 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5199 /// that we want to return and a channel.
5201 /// This is for failures on the channel on which the HTLC was *received*, not failures
5203 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5204 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
5205 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
5206 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
5207 // an inbound SCID alias before the real SCID.
5208 let scid_pref = if chan.context.should_announce() {
5209 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
5211 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
5213 if let Some(scid) = scid_pref {
5214 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
5216 (0x4000|10, Vec::new())
5221 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5222 /// that we want to return and a channel.
5223 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5224 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
5225 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
5226 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
5227 if desired_err_code == 0x1000 | 20 {
5228 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
5229 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
5230 0u16.write(&mut enc).expect("Writes cannot fail");
5232 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
5233 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
5234 upd.write(&mut enc).expect("Writes cannot fail");
5235 (desired_err_code, enc.0)
5237 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
5238 // which means we really shouldn't have gotten a payment to be forwarded over this
5239 // channel yet, or if we did it's from a route hint. Either way, returning an error of
5240 // PERM|no_such_channel should be fine.
5241 (0x4000|10, Vec::new())
5245 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
5246 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
5247 // be surfaced to the user.
5248 fn fail_holding_cell_htlcs(
5249 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
5250 counterparty_node_id: &PublicKey
5252 let (failure_code, onion_failure_data) = {
5253 let per_peer_state = self.per_peer_state.read().unwrap();
5254 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5255 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5256 let peer_state = &mut *peer_state_lock;
5257 match peer_state.channel_by_id.entry(channel_id) {
5258 hash_map::Entry::Occupied(chan_phase_entry) => {
5259 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
5260 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
5262 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
5263 debug_assert!(false);
5264 (0x4000|10, Vec::new())
5267 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
5269 } else { (0x4000|10, Vec::new()) }
5272 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
5273 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
5274 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
5275 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
5279 /// Fails an HTLC backwards to the sender of it to us.
5280 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
5281 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
5282 // Ensure that no peer state channel storage lock is held when calling this function.
5283 // This ensures that future code doesn't introduce a lock-order requirement for
5284 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
5285 // this function with any `per_peer_state` peer lock acquired would.
5286 #[cfg(debug_assertions)]
5287 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
5288 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
5291 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
5292 //identify whether we sent it or not based on the (I presume) very different runtime
5293 //between the branches here. We should make this async and move it into the forward HTLCs
5296 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5297 // from block_connected which may run during initialization prior to the chain_monitor
5298 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
5300 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
5301 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
5302 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
5303 &self.pending_events, &self.logger)
5304 { self.push_pending_forwards_ev(); }
5306 HTLCSource::PreviousHopData(HTLCPreviousHopData {
5307 ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret,
5308 ref phantom_shared_secret, outpoint: _, ref blinded_failure, ref channel_id, ..
5311 WithContext::from(&self.logger, None, Some(*channel_id)),
5312 "Failing {}HTLC with payment_hash {} backwards from us: {:?}",
5313 if blinded_failure.is_some() { "blinded " } else { "" }, &payment_hash, onion_error
5315 let failure = match blinded_failure {
5316 Some(BlindedFailure::FromIntroductionNode) => {
5317 let blinded_onion_error = HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32]);
5318 let err_packet = blinded_onion_error.get_encrypted_failure_packet(
5319 incoming_packet_shared_secret, phantom_shared_secret
5321 HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }
5323 Some(BlindedFailure::FromBlindedNode) => {
5324 HTLCForwardInfo::FailMalformedHTLC {
5326 failure_code: INVALID_ONION_BLINDING,
5327 sha256_of_onion: [0; 32]
5331 let err_packet = onion_error.get_encrypted_failure_packet(
5332 incoming_packet_shared_secret, phantom_shared_secret
5334 HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }
5338 let mut push_forward_ev = false;
5339 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5340 if forward_htlcs.is_empty() {
5341 push_forward_ev = true;
5343 match forward_htlcs.entry(*short_channel_id) {
5344 hash_map::Entry::Occupied(mut entry) => {
5345 entry.get_mut().push(failure);
5347 hash_map::Entry::Vacant(entry) => {
5348 entry.insert(vec!(failure));
5351 mem::drop(forward_htlcs);
5352 if push_forward_ev { self.push_pending_forwards_ev(); }
5353 let mut pending_events = self.pending_events.lock().unwrap();
5354 pending_events.push_back((events::Event::HTLCHandlingFailed {
5355 prev_channel_id: *channel_id,
5356 failed_next_destination: destination,
5362 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
5363 /// [`MessageSendEvent`]s needed to claim the payment.
5365 /// This method is guaranteed to ensure the payment has been claimed but only if the current
5366 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
5367 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
5368 /// successful. It will generally be available in the next [`process_pending_events`] call.
5370 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
5371 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
5372 /// event matches your expectation. If you fail to do so and call this method, you may provide
5373 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5375 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5376 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5377 /// [`claim_funds_with_known_custom_tlvs`].
5379 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5380 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5381 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5382 /// [`process_pending_events`]: EventsProvider::process_pending_events
5383 /// [`create_inbound_payment`]: Self::create_inbound_payment
5384 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5385 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5386 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5387 self.claim_payment_internal(payment_preimage, false);
5390 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5391 /// even type numbers.
5395 /// You MUST check you've understood all even TLVs before using this to
5396 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5398 /// [`claim_funds`]: Self::claim_funds
5399 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5400 self.claim_payment_internal(payment_preimage, true);
5403 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5404 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).to_byte_array());
5406 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5409 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5410 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5411 let mut receiver_node_id = self.our_network_pubkey;
5412 for htlc in payment.htlcs.iter() {
5413 if htlc.prev_hop.phantom_shared_secret.is_some() {
5414 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5415 .expect("Failed to get node_id for phantom node recipient");
5416 receiver_node_id = phantom_pubkey;
5421 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5422 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5423 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5424 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5425 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5427 if dup_purpose.is_some() {
5428 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5429 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5433 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5434 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5435 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5436 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5437 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5438 mem::drop(claimable_payments);
5439 for htlc in payment.htlcs {
5440 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5441 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5442 let receiver = HTLCDestination::FailedPayment { payment_hash };
5443 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5452 debug_assert!(!sources.is_empty());
5454 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5455 // and when we got here we need to check that the amount we're about to claim matches the
5456 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5457 // the MPP parts all have the same `total_msat`.
5458 let mut claimable_amt_msat = 0;
5459 let mut prev_total_msat = None;
5460 let mut expected_amt_msat = None;
5461 let mut valid_mpp = true;
5462 let mut errs = Vec::new();
5463 let per_peer_state = self.per_peer_state.read().unwrap();
5464 for htlc in sources.iter() {
5465 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5466 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5467 debug_assert!(false);
5471 prev_total_msat = Some(htlc.total_msat);
5473 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5474 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5475 debug_assert!(false);
5479 expected_amt_msat = htlc.total_value_received;
5480 claimable_amt_msat += htlc.value;
5482 mem::drop(per_peer_state);
5483 if sources.is_empty() || expected_amt_msat.is_none() {
5484 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5485 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5488 if claimable_amt_msat != expected_amt_msat.unwrap() {
5489 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5490 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5491 expected_amt_msat.unwrap(), claimable_amt_msat);
5495 for htlc in sources.drain(..) {
5496 let prev_hop_chan_id = htlc.prev_hop.channel_id;
5497 if let Err((pk, err)) = self.claim_funds_from_hop(
5498 htlc.prev_hop, payment_preimage,
5499 |_, definitely_duplicate| {
5500 debug_assert!(!definitely_duplicate, "We shouldn't claim duplicatively from a payment");
5501 Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash })
5504 if let msgs::ErrorAction::IgnoreError = err.err.action {
5505 // We got a temporary failure updating monitor, but will claim the
5506 // HTLC when the monitor updating is restored (or on chain).
5507 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
5508 log_error!(logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5509 } else { errs.push((pk, err)); }
5514 for htlc in sources.drain(..) {
5515 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5516 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5517 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5518 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5519 let receiver = HTLCDestination::FailedPayment { payment_hash };
5520 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5522 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5525 // Now we can handle any errors which were generated.
5526 for (counterparty_node_id, err) in errs.drain(..) {
5527 let res: Result<(), _> = Err(err);
5528 let _ = handle_error!(self, res, counterparty_node_id);
5532 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>, bool) -> Option<MonitorUpdateCompletionAction>>(&self,
5533 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5534 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5535 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5537 // If we haven't yet run background events assume we're still deserializing and shouldn't
5538 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5539 // `BackgroundEvent`s.
5540 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5542 // As we may call handle_monitor_update_completion_actions in rather rare cases, check that
5543 // the required mutexes are not held before we start.
5544 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5545 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5548 let per_peer_state = self.per_peer_state.read().unwrap();
5549 let chan_id = prev_hop.channel_id;
5550 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5551 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5555 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5556 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5557 .map(|peer_mutex| peer_mutex.lock().unwrap())
5560 if peer_state_opt.is_some() {
5561 let mut peer_state_lock = peer_state_opt.unwrap();
5562 let peer_state = &mut *peer_state_lock;
5563 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5564 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5565 let counterparty_node_id = chan.context.get_counterparty_node_id();
5566 let logger = WithChannelContext::from(&self.logger, &chan.context);
5567 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &&logger);
5570 UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } => {
5571 if let Some(action) = completion_action(Some(htlc_value_msat), false) {
5572 log_trace!(logger, "Tracking monitor update completion action for channel {}: {:?}",
5574 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5577 handle_new_monitor_update!(self, prev_hop.outpoint, prev_hop.channel_id, monitor_update, peer_state_lock,
5578 peer_state, per_peer_state, chan);
5580 // If we're running during init we cannot update a monitor directly -
5581 // they probably haven't actually been loaded yet. Instead, push the
5582 // monitor update as a background event.
5583 self.pending_background_events.lock().unwrap().push(
5584 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5585 counterparty_node_id,
5586 funding_txo: prev_hop.outpoint,
5587 channel_id: prev_hop.channel_id,
5588 update: monitor_update.clone(),
5592 UpdateFulfillCommitFetch::DuplicateClaim {} => {
5593 let action = if let Some(action) = completion_action(None, true) {
5598 mem::drop(peer_state_lock);
5600 log_trace!(logger, "Completing monitor update completion action for channel {} as claim was redundant: {:?}",
5602 let (node_id, _funding_outpoint, channel_id, blocker) =
5603 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5604 downstream_counterparty_node_id: node_id,
5605 downstream_funding_outpoint: funding_outpoint,
5606 blocking_action: blocker, downstream_channel_id: channel_id,
5608 (node_id, funding_outpoint, channel_id, blocker)
5610 debug_assert!(false,
5611 "Duplicate claims should always free another channel immediately");
5614 if let Some(peer_state_mtx) = per_peer_state.get(&node_id) {
5615 let mut peer_state = peer_state_mtx.lock().unwrap();
5616 if let Some(blockers) = peer_state
5617 .actions_blocking_raa_monitor_updates
5618 .get_mut(&channel_id)
5620 let mut found_blocker = false;
5621 blockers.retain(|iter| {
5622 // Note that we could actually be blocked, in
5623 // which case we need to only remove the one
5624 // blocker which was added duplicatively.
5625 let first_blocker = !found_blocker;
5626 if *iter == blocker { found_blocker = true; }
5627 *iter != blocker || !first_blocker
5629 debug_assert!(found_blocker);
5632 debug_assert!(false);
5641 let preimage_update = ChannelMonitorUpdate {
5642 update_id: CLOSED_CHANNEL_UPDATE_ID,
5643 counterparty_node_id: None,
5644 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5647 channel_id: Some(prev_hop.channel_id),
5651 // We update the ChannelMonitor on the backward link, after
5652 // receiving an `update_fulfill_htlc` from the forward link.
5653 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5654 if update_res != ChannelMonitorUpdateStatus::Completed {
5655 // TODO: This needs to be handled somehow - if we receive a monitor update
5656 // with a preimage we *must* somehow manage to propagate it to the upstream
5657 // channel, or we must have an ability to receive the same event and try
5658 // again on restart.
5659 log_error!(WithContext::from(&self.logger, None, Some(prev_hop.channel_id)),
5660 "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5661 payment_preimage, update_res);
5664 // If we're running during init we cannot update a monitor directly - they probably
5665 // haven't actually been loaded yet. Instead, push the monitor update as a background
5667 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5668 // channel is already closed) we need to ultimately handle the monitor update
5669 // completion action only after we've completed the monitor update. This is the only
5670 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5671 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5672 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5673 // complete the monitor update completion action from `completion_action`.
5674 self.pending_background_events.lock().unwrap().push(
5675 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5676 prev_hop.outpoint, prev_hop.channel_id, preimage_update,
5679 // Note that we do process the completion action here. This totally could be a
5680 // duplicate claim, but we have no way of knowing without interrogating the
5681 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5682 // generally always allowed to be duplicative (and it's specifically noted in
5683 // `PaymentForwarded`).
5684 self.handle_monitor_update_completion_actions(completion_action(None, false));
5688 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5689 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5692 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5693 forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, startup_replay: bool,
5694 next_channel_counterparty_node_id: Option<PublicKey>, next_channel_outpoint: OutPoint,
5695 next_channel_id: ChannelId,
5698 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5699 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5700 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5701 if let Some(pubkey) = next_channel_counterparty_node_id {
5702 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5704 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5705 channel_funding_outpoint: next_channel_outpoint, channel_id: next_channel_id,
5706 counterparty_node_id: path.hops[0].pubkey,
5708 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5709 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5712 HTLCSource::PreviousHopData(hop_data) => {
5713 let prev_channel_id = hop_data.channel_id;
5714 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5715 #[cfg(debug_assertions)]
5716 let claiming_chan_funding_outpoint = hop_data.outpoint;
5717 #[cfg(debug_assertions)]
5718 let claiming_channel_id = hop_data.channel_id;
5719 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5720 |htlc_claim_value_msat, definitely_duplicate| {
5721 let chan_to_release =
5722 if let Some(node_id) = next_channel_counterparty_node_id {
5723 Some((node_id, next_channel_outpoint, next_channel_id, completed_blocker))
5725 // We can only get `None` here if we are processing a
5726 // `ChannelMonitor`-originated event, in which case we
5727 // don't care about ensuring we wake the downstream
5728 // channel's monitor updating - the channel is already
5733 if definitely_duplicate && startup_replay {
5734 // On startup we may get redundant claims which are related to
5735 // monitor updates still in flight. In that case, we shouldn't
5736 // immediately free, but instead let that monitor update complete
5737 // in the background.
5738 #[cfg(debug_assertions)] {
5739 let background_events = self.pending_background_events.lock().unwrap();
5740 // There should be a `BackgroundEvent` pending...
5741 assert!(background_events.iter().any(|ev| {
5743 // to apply a monitor update that blocked the claiming channel,
5744 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5745 funding_txo, update, ..
5747 if *funding_txo == claiming_chan_funding_outpoint {
5748 assert!(update.updates.iter().any(|upd|
5749 if let ChannelMonitorUpdateStep::PaymentPreimage {
5750 payment_preimage: update_preimage
5752 payment_preimage == *update_preimage
5758 // or the channel we'd unblock is already closed,
5759 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup(
5760 (funding_txo, _channel_id, monitor_update)
5762 if *funding_txo == next_channel_outpoint {
5763 assert_eq!(monitor_update.updates.len(), 1);
5765 monitor_update.updates[0],
5766 ChannelMonitorUpdateStep::ChannelForceClosed { .. }
5771 // or the monitor update has completed and will unblock
5772 // immediately once we get going.
5773 BackgroundEvent::MonitorUpdatesComplete {
5776 *channel_id == claiming_channel_id,
5778 }), "{:?}", *background_events);
5781 } else if definitely_duplicate {
5782 if let Some(other_chan) = chan_to_release {
5783 Some(MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5784 downstream_counterparty_node_id: other_chan.0,
5785 downstream_funding_outpoint: other_chan.1,
5786 downstream_channel_id: other_chan.2,
5787 blocking_action: other_chan.3,
5791 let fee_earned_msat = if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5792 if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5793 Some(claimed_htlc_value - forwarded_htlc_value)
5796 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5797 event: events::Event::PaymentForwarded {
5799 claim_from_onchain_tx: from_onchain,
5800 prev_channel_id: Some(prev_channel_id),
5801 next_channel_id: Some(next_channel_id),
5802 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5804 downstream_counterparty_and_funding_outpoint: chan_to_release,
5808 if let Err((pk, err)) = res {
5809 let result: Result<(), _> = Err(err);
5810 let _ = handle_error!(self, result, pk);
5816 /// Gets the node_id held by this ChannelManager
5817 pub fn get_our_node_id(&self) -> PublicKey {
5818 self.our_network_pubkey.clone()
5821 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5822 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5823 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5824 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
5826 for action in actions.into_iter() {
5828 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5829 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5830 if let Some(ClaimingPayment {
5832 payment_purpose: purpose,
5835 sender_intended_value: sender_intended_total_msat,
5837 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5841 receiver_node_id: Some(receiver_node_id),
5843 sender_intended_total_msat,
5847 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5848 event, downstream_counterparty_and_funding_outpoint
5850 self.pending_events.lock().unwrap().push_back((event, None));
5851 if let Some((node_id, funding_outpoint, channel_id, blocker)) = downstream_counterparty_and_funding_outpoint {
5852 self.handle_monitor_update_release(node_id, funding_outpoint, channel_id, Some(blocker));
5855 MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5856 downstream_counterparty_node_id, downstream_funding_outpoint, downstream_channel_id, blocking_action,
5858 self.handle_monitor_update_release(
5859 downstream_counterparty_node_id,
5860 downstream_funding_outpoint,
5861 downstream_channel_id,
5862 Some(blocking_action),
5869 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5870 /// update completion.
5871 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5872 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5873 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5874 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5875 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5876 -> Option<(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)> {
5877 let logger = WithChannelContext::from(&self.logger, &channel.context);
5878 log_trace!(logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5879 &channel.context.channel_id(),
5880 if raa.is_some() { "an" } else { "no" },
5881 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5882 if funding_broadcastable.is_some() { "" } else { "not " },
5883 if channel_ready.is_some() { "sending" } else { "without" },
5884 if announcement_sigs.is_some() { "sending" } else { "without" });
5886 let mut htlc_forwards = None;
5888 let counterparty_node_id = channel.context.get_counterparty_node_id();
5889 if !pending_forwards.is_empty() {
5890 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5891 channel.context.get_funding_txo().unwrap(), channel.context.channel_id(), channel.context.get_user_id(), pending_forwards));
5894 if let Some(msg) = channel_ready {
5895 send_channel_ready!(self, pending_msg_events, channel, msg);
5897 if let Some(msg) = announcement_sigs {
5898 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5899 node_id: counterparty_node_id,
5904 macro_rules! handle_cs { () => {
5905 if let Some(update) = commitment_update {
5906 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5907 node_id: counterparty_node_id,
5912 macro_rules! handle_raa { () => {
5913 if let Some(revoke_and_ack) = raa {
5914 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5915 node_id: counterparty_node_id,
5916 msg: revoke_and_ack,
5921 RAACommitmentOrder::CommitmentFirst => {
5925 RAACommitmentOrder::RevokeAndACKFirst => {
5931 if let Some(tx) = funding_broadcastable {
5932 log_info!(logger, "Broadcasting funding transaction with txid {}", tx.txid());
5933 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5937 let mut pending_events = self.pending_events.lock().unwrap();
5938 emit_channel_pending_event!(pending_events, channel);
5939 emit_channel_ready_event!(pending_events, channel);
5945 fn channel_monitor_updated(&self, funding_txo: &OutPoint, channel_id: &ChannelId, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5946 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5948 let counterparty_node_id = match counterparty_node_id {
5949 Some(cp_id) => cp_id.clone(),
5951 // TODO: Once we can rely on the counterparty_node_id from the
5952 // monitor event, this and the outpoint_to_peer map should be removed.
5953 let outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
5954 match outpoint_to_peer.get(&funding_txo) {
5955 Some(cp_id) => cp_id.clone(),
5960 let per_peer_state = self.per_peer_state.read().unwrap();
5961 let mut peer_state_lock;
5962 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5963 if peer_state_mutex_opt.is_none() { return }
5964 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5965 let peer_state = &mut *peer_state_lock;
5967 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
5970 let update_actions = peer_state.monitor_update_blocked_actions
5971 .remove(&channel_id).unwrap_or(Vec::new());
5972 mem::drop(peer_state_lock);
5973 mem::drop(per_peer_state);
5974 self.handle_monitor_update_completion_actions(update_actions);
5977 let remaining_in_flight =
5978 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5979 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5982 let logger = WithChannelContext::from(&self.logger, &channel.context);
5983 log_trace!(logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5984 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5985 remaining_in_flight);
5986 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5989 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5992 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5994 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5995 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5998 /// The `user_channel_id` parameter will be provided back in
5999 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
6000 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
6002 /// Note that this method will return an error and reject the channel, if it requires support
6003 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
6004 /// used to accept such channels.
6006 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
6007 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
6008 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
6009 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
6012 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
6013 /// it as confirmed immediately.
6015 /// The `user_channel_id` parameter will be provided back in
6016 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
6017 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
6019 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
6020 /// and (if the counterparty agrees), enables forwarding of payments immediately.
6022 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
6023 /// transaction and blindly assumes that it will eventually confirm.
6025 /// If it does not confirm before we decide to close the channel, or if the funding transaction
6026 /// does not pay to the correct script the correct amount, *you will lose funds*.
6028 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
6029 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
6030 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
6031 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
6034 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
6036 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(*temporary_channel_id));
6037 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6039 let peers_without_funded_channels =
6040 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
6041 let per_peer_state = self.per_peer_state.read().unwrap();
6042 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6044 let err_str = format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id);
6045 log_error!(logger, "{}", err_str);
6047 APIError::ChannelUnavailable { err: err_str }
6049 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6050 let peer_state = &mut *peer_state_lock;
6051 let is_only_peer_channel = peer_state.total_channel_count() == 1;
6053 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
6054 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
6055 // that we can delay allocating the SCID until after we're sure that the checks below will
6057 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
6058 Some(unaccepted_channel) => {
6059 let best_block_height = self.best_block.read().unwrap().height();
6060 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6061 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
6062 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
6063 &self.logger, accept_0conf).map_err(|e| {
6064 let err_str = e.to_string();
6065 log_error!(logger, "{}", err_str);
6067 APIError::ChannelUnavailable { err: err_str }
6071 let err_str = "No such channel awaiting to be accepted.".to_owned();
6072 log_error!(logger, "{}", err_str);
6074 Err(APIError::APIMisuseError { err: err_str })
6079 // This should have been correctly configured by the call to InboundV1Channel::new.
6080 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
6081 } else if channel.context.get_channel_type().requires_zero_conf() {
6082 let send_msg_err_event = events::MessageSendEvent::HandleError {
6083 node_id: channel.context.get_counterparty_node_id(),
6084 action: msgs::ErrorAction::SendErrorMessage{
6085 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
6088 peer_state.pending_msg_events.push(send_msg_err_event);
6089 let err_str = "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned();
6090 log_error!(logger, "{}", err_str);
6092 return Err(APIError::APIMisuseError { err: err_str });
6094 // If this peer already has some channels, a new channel won't increase our number of peers
6095 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6096 // channels per-peer we can accept channels from a peer with existing ones.
6097 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
6098 let send_msg_err_event = events::MessageSendEvent::HandleError {
6099 node_id: channel.context.get_counterparty_node_id(),
6100 action: msgs::ErrorAction::SendErrorMessage{
6101 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
6104 peer_state.pending_msg_events.push(send_msg_err_event);
6105 let err_str = "Too many peers with unfunded channels, refusing to accept new ones".to_owned();
6106 log_error!(logger, "{}", err_str);
6108 return Err(APIError::APIMisuseError { err: err_str });
6112 // Now that we know we have a channel, assign an outbound SCID alias.
6113 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6114 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6116 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6117 node_id: channel.context.get_counterparty_node_id(),
6118 msg: channel.accept_inbound_channel(),
6121 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
6126 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
6127 /// or 0-conf channels.
6129 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
6130 /// non-0-conf channels we have with the peer.
6131 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
6132 where Filter: Fn(&PeerState<SP>) -> bool {
6133 let mut peers_without_funded_channels = 0;
6134 let best_block_height = self.best_block.read().unwrap().height();
6136 let peer_state_lock = self.per_peer_state.read().unwrap();
6137 for (_, peer_mtx) in peer_state_lock.iter() {
6138 let peer = peer_mtx.lock().unwrap();
6139 if !maybe_count_peer(&*peer) { continue; }
6140 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
6141 if num_unfunded_channels == peer.total_channel_count() {
6142 peers_without_funded_channels += 1;
6146 return peers_without_funded_channels;
6149 fn unfunded_channel_count(
6150 peer: &PeerState<SP>, best_block_height: u32
6152 let mut num_unfunded_channels = 0;
6153 for (_, phase) in peer.channel_by_id.iter() {
6155 ChannelPhase::Funded(chan) => {
6156 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
6157 // which have not yet had any confirmations on-chain.
6158 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
6159 chan.context.get_funding_tx_confirmations(best_block_height) == 0
6161 num_unfunded_channels += 1;
6164 ChannelPhase::UnfundedInboundV1(chan) => {
6165 if chan.context.minimum_depth().unwrap_or(1) != 0 {
6166 num_unfunded_channels += 1;
6169 ChannelPhase::UnfundedOutboundV1(_) => {
6170 // Outbound channels don't contribute to the unfunded count in the DoS context.
6175 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
6178 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
6179 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6180 // likely to be lost on restart!
6181 if msg.chain_hash != self.chain_hash {
6182 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
6185 if !self.default_configuration.accept_inbound_channels {
6186 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6189 // Get the number of peers with channels, but without funded ones. We don't care too much
6190 // about peers that never open a channel, so we filter by peers that have at least one
6191 // channel, and then limit the number of those with unfunded channels.
6192 let channeled_peers_without_funding =
6193 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
6195 let per_peer_state = self.per_peer_state.read().unwrap();
6196 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6198 debug_assert!(false);
6199 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())
6201 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6202 let peer_state = &mut *peer_state_lock;
6204 // If this peer already has some channels, a new channel won't increase our number of peers
6205 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6206 // channels per-peer we can accept channels from a peer with existing ones.
6207 if peer_state.total_channel_count() == 0 &&
6208 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
6209 !self.default_configuration.manually_accept_inbound_channels
6211 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6212 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
6213 msg.temporary_channel_id.clone()));
6216 let best_block_height = self.best_block.read().unwrap().height();
6217 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
6218 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6219 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
6220 msg.temporary_channel_id.clone()));
6223 let channel_id = msg.temporary_channel_id;
6224 let channel_exists = peer_state.has_channel(&channel_id);
6226 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
6229 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
6230 if self.default_configuration.manually_accept_inbound_channels {
6231 let channel_type = channel::channel_type_from_open_channel(
6232 &msg, &peer_state.latest_features, &self.channel_type_features()
6234 MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id)
6236 let mut pending_events = self.pending_events.lock().unwrap();
6237 pending_events.push_back((events::Event::OpenChannelRequest {
6238 temporary_channel_id: msg.temporary_channel_id.clone(),
6239 counterparty_node_id: counterparty_node_id.clone(),
6240 funding_satoshis: msg.funding_satoshis,
6241 push_msat: msg.push_msat,
6244 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
6245 open_channel_msg: msg.clone(),
6246 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
6251 // Otherwise create the channel right now.
6252 let mut random_bytes = [0u8; 16];
6253 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
6254 let user_channel_id = u128::from_be_bytes(random_bytes);
6255 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6256 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
6257 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
6260 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
6265 let channel_type = channel.context.get_channel_type();
6266 if channel_type.requires_zero_conf() {
6267 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6269 if channel_type.requires_anchors_zero_fee_htlc_tx() {
6270 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
6273 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6274 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6276 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6277 node_id: counterparty_node_id.clone(),
6278 msg: channel.accept_inbound_channel(),
6280 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
6284 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
6285 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6286 // likely to be lost on restart!
6287 let (value, output_script, user_id) = {
6288 let per_peer_state = self.per_peer_state.read().unwrap();
6289 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6291 debug_assert!(false);
6292 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)
6294 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6295 let peer_state = &mut *peer_state_lock;
6296 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
6297 hash_map::Entry::Occupied(mut phase) => {
6298 match phase.get_mut() {
6299 ChannelPhase::UnfundedOutboundV1(chan) => {
6300 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
6301 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
6304 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));
6308 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))
6311 let mut pending_events = self.pending_events.lock().unwrap();
6312 pending_events.push_back((events::Event::FundingGenerationReady {
6313 temporary_channel_id: msg.temporary_channel_id,
6314 counterparty_node_id: *counterparty_node_id,
6315 channel_value_satoshis: value,
6317 user_channel_id: user_id,
6322 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
6323 let best_block = *self.best_block.read().unwrap();
6325 let per_peer_state = self.per_peer_state.read().unwrap();
6326 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6328 debug_assert!(false);
6329 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)
6332 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6333 let peer_state = &mut *peer_state_lock;
6334 let (mut chan, funding_msg_opt, monitor) =
6335 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
6336 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
6337 let logger = WithChannelContext::from(&self.logger, &inbound_chan.context);
6338 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &&logger) {
6340 Err((inbound_chan, err)) => {
6341 // We've already removed this inbound channel from the map in `PeerState`
6342 // above so at this point we just need to clean up any lingering entries
6343 // concerning this channel as it is safe to do so.
6344 debug_assert!(matches!(err, ChannelError::Close(_)));
6345 // Really we should be returning the channel_id the peer expects based
6346 // on their funding info here, but they're horribly confused anyway, so
6347 // there's not a lot we can do to save them.
6348 return Err(convert_chan_phase_err!(self, err, &mut ChannelPhase::UnfundedInboundV1(inbound_chan), &msg.temporary_channel_id).1);
6352 Some(mut phase) => {
6353 let err_msg = format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id);
6354 let err = ChannelError::Close(err_msg);
6355 return Err(convert_chan_phase_err!(self, err, &mut phase, &msg.temporary_channel_id).1);
6357 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))
6360 let funded_channel_id = chan.context.channel_id();
6362 macro_rules! fail_chan { ($err: expr) => { {
6363 // Note that at this point we've filled in the funding outpoint on our
6364 // channel, but its actually in conflict with another channel. Thus, if
6365 // we call `convert_chan_phase_err` immediately (thus calling
6366 // `update_maps_on_chan_removal`), we'll remove the existing channel
6367 // from `outpoint_to_peer`. Thus, we must first unset the funding outpoint
6369 let err = ChannelError::Close($err.to_owned());
6370 chan.unset_funding_info(msg.temporary_channel_id);
6371 return Err(convert_chan_phase_err!(self, err, chan, &funded_channel_id, UNFUNDED_CHANNEL).1);
6374 match peer_state.channel_by_id.entry(funded_channel_id) {
6375 hash_map::Entry::Occupied(_) => {
6376 fail_chan!("Already had channel with the new channel_id");
6378 hash_map::Entry::Vacant(e) => {
6379 let mut outpoint_to_peer_lock = self.outpoint_to_peer.lock().unwrap();
6380 match outpoint_to_peer_lock.entry(monitor.get_funding_txo().0) {
6381 hash_map::Entry::Occupied(_) => {
6382 fail_chan!("The funding_created message had the same funding_txid as an existing channel - funding is not possible");
6384 hash_map::Entry::Vacant(i_e) => {
6385 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
6386 if let Ok(persist_state) = monitor_res {
6387 i_e.insert(chan.context.get_counterparty_node_id());
6388 mem::drop(outpoint_to_peer_lock);
6390 // There's no problem signing a counterparty's funding transaction if our monitor
6391 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
6392 // accepted payment from yet. We do, however, need to wait to send our channel_ready
6393 // until we have persisted our monitor.
6394 if let Some(msg) = funding_msg_opt {
6395 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6396 node_id: counterparty_node_id.clone(),
6401 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
6402 handle_new_monitor_update!(self, persist_state, peer_state_lock, peer_state,
6403 per_peer_state, chan, INITIAL_MONITOR);
6405 unreachable!("This must be a funded channel as we just inserted it.");
6409 let logger = WithChannelContext::from(&self.logger, &chan.context);
6410 log_error!(logger, "Persisting initial ChannelMonitor failed, implying the funding outpoint was duplicated");
6411 fail_chan!("Duplicate funding outpoint");
6419 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
6420 let best_block = *self.best_block.read().unwrap();
6421 let per_peer_state = self.per_peer_state.read().unwrap();
6422 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6424 debug_assert!(false);
6425 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6428 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6429 let peer_state = &mut *peer_state_lock;
6430 match peer_state.channel_by_id.entry(msg.channel_id) {
6431 hash_map::Entry::Occupied(chan_phase_entry) => {
6432 if matches!(chan_phase_entry.get(), ChannelPhase::UnfundedOutboundV1(_)) {
6433 let chan = if let ChannelPhase::UnfundedOutboundV1(chan) = chan_phase_entry.remove() { chan } else { unreachable!() };
6434 let logger = WithContext::from(
6436 Some(chan.context.get_counterparty_node_id()),
6437 Some(chan.context.channel_id())
6440 chan.funding_signed(&msg, best_block, &self.signer_provider, &&logger);
6442 Ok((mut chan, monitor)) => {
6443 if let Ok(persist_status) = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor) {
6444 // We really should be able to insert here without doing a second
6445 // lookup, but sadly rust stdlib doesn't currently allow keeping
6446 // the original Entry around with the value removed.
6447 let mut chan = peer_state.channel_by_id.entry(msg.channel_id).or_insert(ChannelPhase::Funded(chan));
6448 if let ChannelPhase::Funded(ref mut chan) = &mut chan {
6449 handle_new_monitor_update!(self, persist_status, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
6450 } else { unreachable!(); }
6453 let e = ChannelError::Close("Channel funding outpoint was a duplicate".to_owned());
6454 // We weren't able to watch the channel to begin with, so no
6455 // updates should be made on it. Previously, full_stack_target
6456 // found an (unreachable) panic when the monitor update contained
6457 // within `shutdown_finish` was applied.
6458 chan.unset_funding_info(msg.channel_id);
6459 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::Funded(chan), &msg.channel_id).1);
6463 debug_assert!(matches!(e, ChannelError::Close(_)),
6464 "We don't have a channel anymore, so the error better have expected close");
6465 // We've already removed this outbound channel from the map in
6466 // `PeerState` above so at this point we just need to clean up any
6467 // lingering entries concerning this channel as it is safe to do so.
6468 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::UnfundedOutboundV1(chan), &msg.channel_id).1);
6472 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
6475 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
6479 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
6480 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6481 // closing a channel), so any changes are likely to be lost on restart!
6482 let per_peer_state = self.per_peer_state.read().unwrap();
6483 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6485 debug_assert!(false);
6486 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6488 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6489 let peer_state = &mut *peer_state_lock;
6490 match peer_state.channel_by_id.entry(msg.channel_id) {
6491 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6492 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6493 let logger = WithChannelContext::from(&self.logger, &chan.context);
6494 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
6495 self.chain_hash, &self.default_configuration, &self.best_block.read().unwrap(), &&logger), chan_phase_entry);
6496 if let Some(announcement_sigs) = announcement_sigs_opt {
6497 log_trace!(logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
6498 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6499 node_id: counterparty_node_id.clone(),
6500 msg: announcement_sigs,
6502 } else if chan.context.is_usable() {
6503 // If we're sending an announcement_signatures, we'll send the (public)
6504 // channel_update after sending a channel_announcement when we receive our
6505 // counterparty's announcement_signatures. Thus, we only bother to send a
6506 // channel_update here if the channel is not public, i.e. we're not sending an
6507 // announcement_signatures.
6508 log_trace!(logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
6509 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6510 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6511 node_id: counterparty_node_id.clone(),
6518 let mut pending_events = self.pending_events.lock().unwrap();
6519 emit_channel_ready_event!(pending_events, chan);
6524 try_chan_phase_entry!(self, Err(ChannelError::Close(
6525 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
6528 hash_map::Entry::Vacant(_) => {
6529 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))
6534 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
6535 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
6536 let mut finish_shutdown = None;
6538 let per_peer_state = self.per_peer_state.read().unwrap();
6539 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6541 debug_assert!(false);
6542 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6544 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6545 let peer_state = &mut *peer_state_lock;
6546 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6547 let phase = chan_phase_entry.get_mut();
6549 ChannelPhase::Funded(chan) => {
6550 if !chan.received_shutdown() {
6551 let logger = WithChannelContext::from(&self.logger, &chan.context);
6552 log_info!(logger, "Received a shutdown message from our counterparty for channel {}{}.",
6554 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
6557 let funding_txo_opt = chan.context.get_funding_txo();
6558 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
6559 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
6560 dropped_htlcs = htlcs;
6562 if let Some(msg) = shutdown {
6563 // We can send the `shutdown` message before updating the `ChannelMonitor`
6564 // here as we don't need the monitor update to complete until we send a
6565 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
6566 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6567 node_id: *counterparty_node_id,
6571 // Update the monitor with the shutdown script if necessary.
6572 if let Some(monitor_update) = monitor_update_opt {
6573 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), chan.context.channel_id(), monitor_update,
6574 peer_state_lock, peer_state, per_peer_state, chan);
6577 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6578 let context = phase.context_mut();
6579 let logger = WithChannelContext::from(&self.logger, context);
6580 log_error!(logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6581 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6582 finish_shutdown = Some(chan.context_mut().force_shutdown(false, ClosureReason::CounterpartyCoopClosedUnfundedChannel));
6586 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))
6589 for htlc_source in dropped_htlcs.drain(..) {
6590 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6591 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6592 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6594 if let Some(shutdown_res) = finish_shutdown {
6595 self.finish_close_channel(shutdown_res);
6601 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6602 let per_peer_state = self.per_peer_state.read().unwrap();
6603 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6605 debug_assert!(false);
6606 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6608 let (tx, chan_option, shutdown_result) = {
6609 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6610 let peer_state = &mut *peer_state_lock;
6611 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6612 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6613 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6614 let (closing_signed, tx, shutdown_result) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6615 debug_assert_eq!(shutdown_result.is_some(), chan.is_shutdown());
6616 if let Some(msg) = closing_signed {
6617 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6618 node_id: counterparty_node_id.clone(),
6623 // We're done with this channel, we've got a signed closing transaction and
6624 // will send the closing_signed back to the remote peer upon return. This
6625 // also implies there are no pending HTLCs left on the channel, so we can
6626 // fully delete it from tracking (the channel monitor is still around to
6627 // watch for old state broadcasts)!
6628 (tx, Some(remove_channel_phase!(self, chan_phase_entry)), shutdown_result)
6629 } else { (tx, None, shutdown_result) }
6631 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6632 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6635 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))
6638 if let Some(broadcast_tx) = tx {
6639 let channel_id = chan_option.as_ref().map(|channel| channel.context().channel_id());
6640 log_info!(WithContext::from(&self.logger, Some(*counterparty_node_id), channel_id), "Broadcasting {}", log_tx!(broadcast_tx));
6641 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6643 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6644 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6645 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6646 let peer_state = &mut *peer_state_lock;
6647 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6652 mem::drop(per_peer_state);
6653 if let Some(shutdown_result) = shutdown_result {
6654 self.finish_close_channel(shutdown_result);
6659 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6660 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6661 //determine the state of the payment based on our response/if we forward anything/the time
6662 //we take to respond. We should take care to avoid allowing such an attack.
6664 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6665 //us repeatedly garbled in different ways, and compare our error messages, which are
6666 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6667 //but we should prevent it anyway.
6669 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6670 // closing a channel), so any changes are likely to be lost on restart!
6672 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
6673 let per_peer_state = self.per_peer_state.read().unwrap();
6674 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6676 debug_assert!(false);
6677 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6679 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6680 let peer_state = &mut *peer_state_lock;
6681 match peer_state.channel_by_id.entry(msg.channel_id) {
6682 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6683 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6684 let pending_forward_info = match decoded_hop_res {
6685 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6686 self.construct_pending_htlc_status(
6687 msg, counterparty_node_id, shared_secret, next_hop,
6688 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
6690 Err(e) => PendingHTLCStatus::Fail(e)
6692 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6693 if msg.blinding_point.is_some() {
6694 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(
6695 msgs::UpdateFailMalformedHTLC {
6696 channel_id: msg.channel_id,
6697 htlc_id: msg.htlc_id,
6698 sha256_of_onion: [0; 32],
6699 failure_code: INVALID_ONION_BLINDING,
6703 // If the update_add is completely bogus, the call will Err and we will close,
6704 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6705 // want to reject the new HTLC and fail it backwards instead of forwarding.
6706 match pending_forward_info {
6707 PendingHTLCStatus::Forward(PendingHTLCInfo {
6708 ref incoming_shared_secret, ref routing, ..
6710 let reason = if routing.blinded_failure().is_some() {
6711 HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32])
6712 } else if (error_code & 0x1000) != 0 {
6713 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6714 HTLCFailReason::reason(real_code, error_data)
6716 HTLCFailReason::from_failure_code(error_code)
6717 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6718 let msg = msgs::UpdateFailHTLC {
6719 channel_id: msg.channel_id,
6720 htlc_id: msg.htlc_id,
6723 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6725 _ => pending_forward_info
6728 let logger = WithChannelContext::from(&self.logger, &chan.context);
6729 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &&logger), chan_phase_entry);
6731 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6732 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6735 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
6740 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6742 let (htlc_source, forwarded_htlc_value) = {
6743 let per_peer_state = self.per_peer_state.read().unwrap();
6744 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6746 debug_assert!(false);
6747 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6749 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6750 let peer_state = &mut *peer_state_lock;
6751 match peer_state.channel_by_id.entry(msg.channel_id) {
6752 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6753 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6754 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6755 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6756 let logger = WithChannelContext::from(&self.logger, &chan.context);
6758 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
6760 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6761 .or_insert_with(Vec::new)
6762 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6764 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6765 // entry here, even though we *do* need to block the next RAA monitor update.
6766 // We do this instead in the `claim_funds_internal` by attaching a
6767 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6768 // outbound HTLC is claimed. This is guaranteed to all complete before we
6769 // process the RAA as messages are processed from single peers serially.
6770 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6773 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6774 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6777 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 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value),
6781 false, false, Some(*counterparty_node_id), funding_txo, msg.channel_id);
6785 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6786 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6787 // closing a channel), so any changes are likely to be lost on restart!
6788 let per_peer_state = self.per_peer_state.read().unwrap();
6789 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6791 debug_assert!(false);
6792 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6794 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6795 let peer_state = &mut *peer_state_lock;
6796 match peer_state.channel_by_id.entry(msg.channel_id) {
6797 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6798 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6799 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6801 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6802 "Got an update_fail_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))
6810 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6811 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6812 // closing a channel), so any changes are likely to be lost on restart!
6813 let per_peer_state = self.per_peer_state.read().unwrap();
6814 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6816 debug_assert!(false);
6817 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6819 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6820 let peer_state = &mut *peer_state_lock;
6821 match peer_state.channel_by_id.entry(msg.channel_id) {
6822 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6823 if (msg.failure_code & 0x8000) == 0 {
6824 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6825 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6827 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6828 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);
6830 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6831 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6835 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 internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6840 let per_peer_state = self.per_peer_state.read().unwrap();
6841 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6843 debug_assert!(false);
6844 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6846 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6847 let peer_state = &mut *peer_state_lock;
6848 match peer_state.channel_by_id.entry(msg.channel_id) {
6849 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6850 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6851 let logger = WithChannelContext::from(&self.logger, &chan.context);
6852 let funding_txo = chan.context.get_funding_txo();
6853 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &&logger), chan_phase_entry);
6854 if let Some(monitor_update) = monitor_update_opt {
6855 handle_new_monitor_update!(self, funding_txo.unwrap(), chan.context.channel_id(), monitor_update, peer_state_lock,
6856 peer_state, per_peer_state, chan);
6860 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6861 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6864 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))
6869 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6870 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6871 let mut push_forward_event = false;
6872 let mut new_intercept_events = VecDeque::new();
6873 let mut failed_intercept_forwards = Vec::new();
6874 if !pending_forwards.is_empty() {
6875 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6876 let scid = match forward_info.routing {
6877 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6878 PendingHTLCRouting::Receive { .. } => 0,
6879 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6881 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6882 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6884 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6885 let forward_htlcs_empty = forward_htlcs.is_empty();
6886 match forward_htlcs.entry(scid) {
6887 hash_map::Entry::Occupied(mut entry) => {
6888 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6889 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info }));
6891 hash_map::Entry::Vacant(entry) => {
6892 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6893 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.chain_hash)
6895 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).to_byte_array());
6896 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6897 match pending_intercepts.entry(intercept_id) {
6898 hash_map::Entry::Vacant(entry) => {
6899 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6900 requested_next_hop_scid: scid,
6901 payment_hash: forward_info.payment_hash,
6902 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6903 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6906 entry.insert(PendingAddHTLCInfo {
6907 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info });
6909 hash_map::Entry::Occupied(_) => {
6910 let logger = WithContext::from(&self.logger, None, Some(prev_channel_id));
6911 log_info!(logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6912 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6913 short_channel_id: prev_short_channel_id,
6914 user_channel_id: Some(prev_user_channel_id),
6915 outpoint: prev_funding_outpoint,
6916 channel_id: prev_channel_id,
6917 htlc_id: prev_htlc_id,
6918 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6919 phantom_shared_secret: None,
6920 blinded_failure: forward_info.routing.blinded_failure(),
6923 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6924 HTLCFailReason::from_failure_code(0x4000 | 10),
6925 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6930 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6931 // payments are being processed.
6932 if forward_htlcs_empty {
6933 push_forward_event = true;
6935 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6936 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info })));
6943 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6944 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6947 if !new_intercept_events.is_empty() {
6948 let mut events = self.pending_events.lock().unwrap();
6949 events.append(&mut new_intercept_events);
6951 if push_forward_event { self.push_pending_forwards_ev() }
6955 fn push_pending_forwards_ev(&self) {
6956 let mut pending_events = self.pending_events.lock().unwrap();
6957 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6958 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6959 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6961 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6962 // events is done in batches and they are not removed until we're done processing each
6963 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6964 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6965 // payments will need an additional forwarding event before being claimed to make them look
6966 // real by taking more time.
6967 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6968 pending_events.push_back((Event::PendingHTLCsForwardable {
6969 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6974 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6975 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6976 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6977 /// the [`ChannelMonitorUpdate`] in question.
6978 fn raa_monitor_updates_held(&self,
6979 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6980 channel_funding_outpoint: OutPoint, channel_id: ChannelId, counterparty_node_id: PublicKey
6982 actions_blocking_raa_monitor_updates
6983 .get(&channel_id).map(|v| !v.is_empty()).unwrap_or(false)
6984 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6985 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6986 channel_funding_outpoint,
6988 counterparty_node_id,
6993 #[cfg(any(test, feature = "_test_utils"))]
6994 pub(crate) fn test_raa_monitor_updates_held(&self,
6995 counterparty_node_id: PublicKey, channel_id: ChannelId
6997 let per_peer_state = self.per_peer_state.read().unwrap();
6998 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6999 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
7000 let peer_state = &mut *peer_state_lck;
7002 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
7003 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
7004 chan.context().get_funding_txo().unwrap(), channel_id, counterparty_node_id);
7010 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
7011 let htlcs_to_fail = {
7012 let per_peer_state = self.per_peer_state.read().unwrap();
7013 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
7015 debug_assert!(false);
7016 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7017 }).map(|mtx| mtx.lock().unwrap())?;
7018 let peer_state = &mut *peer_state_lock;
7019 match peer_state.channel_by_id.entry(msg.channel_id) {
7020 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7021 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7022 let logger = WithChannelContext::from(&self.logger, &chan.context);
7023 let funding_txo_opt = chan.context.get_funding_txo();
7024 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
7025 self.raa_monitor_updates_held(
7026 &peer_state.actions_blocking_raa_monitor_updates, funding_txo, msg.channel_id,
7027 *counterparty_node_id)
7029 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
7030 chan.revoke_and_ack(&msg, &self.fee_estimator, &&logger, mon_update_blocked), chan_phase_entry);
7031 if let Some(monitor_update) = monitor_update_opt {
7032 let funding_txo = funding_txo_opt
7033 .expect("Funding outpoint must have been set for RAA handling to succeed");
7034 handle_new_monitor_update!(self, funding_txo, chan.context.channel_id(), monitor_update,
7035 peer_state_lock, peer_state, per_peer_state, chan);
7039 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7040 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
7043 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))
7046 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
7050 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
7051 let per_peer_state = self.per_peer_state.read().unwrap();
7052 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7054 debug_assert!(false);
7055 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7057 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7058 let peer_state = &mut *peer_state_lock;
7059 match peer_state.channel_by_id.entry(msg.channel_id) {
7060 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7061 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7062 let logger = WithChannelContext::from(&self.logger, &chan.context);
7063 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &&logger), chan_phase_entry);
7065 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7066 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
7069 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))
7074 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
7075 let per_peer_state = self.per_peer_state.read().unwrap();
7076 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7078 debug_assert!(false);
7079 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7081 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7082 let peer_state = &mut *peer_state_lock;
7083 match peer_state.channel_by_id.entry(msg.channel_id) {
7084 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7085 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7086 if !chan.context.is_usable() {
7087 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
7090 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7091 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
7092 &self.node_signer, self.chain_hash, self.best_block.read().unwrap().height(),
7093 msg, &self.default_configuration
7094 ), chan_phase_entry),
7095 // Note that announcement_signatures fails if the channel cannot be announced,
7096 // so get_channel_update_for_broadcast will never fail by the time we get here.
7097 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
7100 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7101 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
7104 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))
7109 /// Returns DoPersist if anything changed, otherwise either SkipPersistNoEvents or an Err.
7110 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
7111 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
7112 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
7114 // It's not a local channel
7115 return Ok(NotifyOption::SkipPersistNoEvents)
7118 let per_peer_state = self.per_peer_state.read().unwrap();
7119 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
7120 if peer_state_mutex_opt.is_none() {
7121 return Ok(NotifyOption::SkipPersistNoEvents)
7123 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7124 let peer_state = &mut *peer_state_lock;
7125 match peer_state.channel_by_id.entry(chan_id) {
7126 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7127 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7128 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
7129 if chan.context.should_announce() {
7130 // If the announcement is about a channel of ours which is public, some
7131 // other peer may simply be forwarding all its gossip to us. Don't provide
7132 // a scary-looking error message and return Ok instead.
7133 return Ok(NotifyOption::SkipPersistNoEvents);
7135 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));
7137 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
7138 let msg_from_node_one = msg.contents.flags & 1 == 0;
7139 if were_node_one == msg_from_node_one {
7140 return Ok(NotifyOption::SkipPersistNoEvents);
7142 let logger = WithChannelContext::from(&self.logger, &chan.context);
7143 log_debug!(logger, "Received channel_update {:?} for channel {}.", msg, chan_id);
7144 let did_change = try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
7145 // If nothing changed after applying their update, we don't need to bother
7148 return Ok(NotifyOption::SkipPersistNoEvents);
7152 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7153 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
7156 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersistNoEvents)
7158 Ok(NotifyOption::DoPersist)
7161 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<NotifyOption, MsgHandleErrInternal> {
7163 let need_lnd_workaround = {
7164 let per_peer_state = self.per_peer_state.read().unwrap();
7166 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7168 debug_assert!(false);
7169 MsgHandleErrInternal::send_err_msg_no_close(
7170 format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id),
7174 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
7175 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7176 let peer_state = &mut *peer_state_lock;
7177 match peer_state.channel_by_id.entry(msg.channel_id) {
7178 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7179 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7180 // Currently, we expect all holding cell update_adds to be dropped on peer
7181 // disconnect, so Channel's reestablish will never hand us any holding cell
7182 // freed HTLCs to fail backwards. If in the future we no longer drop pending
7183 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
7184 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
7185 msg, &&logger, &self.node_signer, self.chain_hash,
7186 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
7187 let mut channel_update = None;
7188 if let Some(msg) = responses.shutdown_msg {
7189 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7190 node_id: counterparty_node_id.clone(),
7193 } else if chan.context.is_usable() {
7194 // If the channel is in a usable state (ie the channel is not being shut
7195 // down), send a unicast channel_update to our counterparty to make sure
7196 // they have the latest channel parameters.
7197 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
7198 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
7199 node_id: chan.context.get_counterparty_node_id(),
7204 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
7205 htlc_forwards = self.handle_channel_resumption(
7206 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
7207 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
7208 if let Some(upd) = channel_update {
7209 peer_state.pending_msg_events.push(upd);
7213 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7214 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
7217 hash_map::Entry::Vacant(_) => {
7218 log_debug!(logger, "Sending bogus ChannelReestablish for unknown channel {} to force channel closure",
7220 // Unfortunately, lnd doesn't force close on errors
7221 // (https://github.com/lightningnetwork/lnd/blob/abb1e3463f3a83bbb843d5c399869dbe930ad94f/htlcswitch/link.go#L2119).
7222 // One of the few ways to get an lnd counterparty to force close is by
7223 // replicating what they do when restoring static channel backups (SCBs). They
7224 // send an invalid `ChannelReestablish` with `0` commitment numbers and an
7225 // invalid `your_last_per_commitment_secret`.
7227 // Since we received a `ChannelReestablish` for a channel that doesn't exist, we
7228 // can assume it's likely the channel closed from our point of view, but it
7229 // remains open on the counterparty's side. By sending this bogus
7230 // `ChannelReestablish` message now as a response to theirs, we trigger them to
7231 // force close broadcasting their latest state. If the closing transaction from
7232 // our point of view remains unconfirmed, it'll enter a race with the
7233 // counterparty's to-be-broadcast latest commitment transaction.
7234 peer_state.pending_msg_events.push(MessageSendEvent::SendChannelReestablish {
7235 node_id: *counterparty_node_id,
7236 msg: msgs::ChannelReestablish {
7237 channel_id: msg.channel_id,
7238 next_local_commitment_number: 0,
7239 next_remote_commitment_number: 0,
7240 your_last_per_commitment_secret: [1u8; 32],
7241 my_current_per_commitment_point: PublicKey::from_slice(&[2u8; 33]).unwrap(),
7242 next_funding_txid: None,
7245 return Err(MsgHandleErrInternal::send_err_msg_no_close(
7246 format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
7247 counterparty_node_id), msg.channel_id)
7253 let mut persist = NotifyOption::SkipPersistHandleEvents;
7254 if let Some(forwards) = htlc_forwards {
7255 self.forward_htlcs(&mut [forwards][..]);
7256 persist = NotifyOption::DoPersist;
7259 if let Some(channel_ready_msg) = need_lnd_workaround {
7260 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
7265 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
7266 fn process_pending_monitor_events(&self) -> bool {
7267 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
7269 let mut failed_channels = Vec::new();
7270 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
7271 let has_pending_monitor_events = !pending_monitor_events.is_empty();
7272 for (funding_outpoint, channel_id, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
7273 for monitor_event in monitor_events.drain(..) {
7274 match monitor_event {
7275 MonitorEvent::HTLCEvent(htlc_update) => {
7276 let logger = WithContext::from(&self.logger, counterparty_node_id, Some(channel_id));
7277 if let Some(preimage) = htlc_update.payment_preimage {
7278 log_trace!(logger, "Claiming HTLC with preimage {} from our monitor", preimage);
7279 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, false, counterparty_node_id, funding_outpoint, channel_id);
7281 log_trace!(logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
7282 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id };
7283 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7284 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
7287 MonitorEvent::HolderForceClosed(_funding_outpoint) => {
7288 let counterparty_node_id_opt = match counterparty_node_id {
7289 Some(cp_id) => Some(cp_id),
7291 // TODO: Once we can rely on the counterparty_node_id from the
7292 // monitor event, this and the outpoint_to_peer map should be removed.
7293 let outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
7294 outpoint_to_peer.get(&funding_outpoint).cloned()
7297 if let Some(counterparty_node_id) = counterparty_node_id_opt {
7298 let per_peer_state = self.per_peer_state.read().unwrap();
7299 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7300 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7301 let peer_state = &mut *peer_state_lock;
7302 let pending_msg_events = &mut peer_state.pending_msg_events;
7303 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id) {
7304 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
7305 failed_channels.push(chan.context.force_shutdown(false, ClosureReason::HolderForceClosed));
7306 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7307 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7311 pending_msg_events.push(events::MessageSendEvent::HandleError {
7312 node_id: chan.context.get_counterparty_node_id(),
7313 action: msgs::ErrorAction::DisconnectPeer {
7314 msg: Some(msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() })
7322 MonitorEvent::Completed { funding_txo, channel_id, monitor_update_id } => {
7323 self.channel_monitor_updated(&funding_txo, &channel_id, monitor_update_id, counterparty_node_id.as_ref());
7329 for failure in failed_channels.drain(..) {
7330 self.finish_close_channel(failure);
7333 has_pending_monitor_events
7336 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
7337 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
7338 /// update events as a separate process method here.
7340 pub fn process_monitor_events(&self) {
7341 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7342 self.process_pending_monitor_events();
7345 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
7346 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
7347 /// update was applied.
7348 fn check_free_holding_cells(&self) -> bool {
7349 let mut has_monitor_update = false;
7350 let mut failed_htlcs = Vec::new();
7352 // Walk our list of channels and find any that need to update. Note that when we do find an
7353 // update, if it includes actions that must be taken afterwards, we have to drop the
7354 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
7355 // manage to go through all our peers without finding a single channel to update.
7357 let per_peer_state = self.per_peer_state.read().unwrap();
7358 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7360 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7361 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
7362 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
7363 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
7365 let counterparty_node_id = chan.context.get_counterparty_node_id();
7366 let funding_txo = chan.context.get_funding_txo();
7367 let (monitor_opt, holding_cell_failed_htlcs) =
7368 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &&WithChannelContext::from(&self.logger, &chan.context));
7369 if !holding_cell_failed_htlcs.is_empty() {
7370 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
7372 if let Some(monitor_update) = monitor_opt {
7373 has_monitor_update = true;
7375 handle_new_monitor_update!(self, funding_txo.unwrap(), chan.context.channel_id(), monitor_update,
7376 peer_state_lock, peer_state, per_peer_state, chan);
7377 continue 'peer_loop;
7386 let has_update = has_monitor_update || !failed_htlcs.is_empty();
7387 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
7388 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
7394 /// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
7395 /// is (temporarily) unavailable, and the operation should be retried later.
7397 /// This method allows for that retry - either checking for any signer-pending messages to be
7398 /// attempted in every channel, or in the specifically provided channel.
7400 /// [`ChannelSigner`]: crate::sign::ChannelSigner
7401 #[cfg(async_signing)]
7402 pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
7403 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7405 let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
7406 let node_id = phase.context().get_counterparty_node_id();
7408 ChannelPhase::Funded(chan) => {
7409 let msgs = chan.signer_maybe_unblocked(&self.logger);
7410 if let Some(updates) = msgs.commitment_update {
7411 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
7416 if let Some(msg) = msgs.funding_signed {
7417 pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
7422 if let Some(msg) = msgs.channel_ready {
7423 send_channel_ready!(self, pending_msg_events, chan, msg);
7426 ChannelPhase::UnfundedOutboundV1(chan) => {
7427 if let Some(msg) = chan.signer_maybe_unblocked(&self.logger) {
7428 pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
7434 ChannelPhase::UnfundedInboundV1(_) => {},
7438 let per_peer_state = self.per_peer_state.read().unwrap();
7439 if let Some((counterparty_node_id, channel_id)) = channel_opt {
7440 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7441 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7442 let peer_state = &mut *peer_state_lock;
7443 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
7444 unblock_chan(chan, &mut peer_state.pending_msg_events);
7448 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7449 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7450 let peer_state = &mut *peer_state_lock;
7451 for (_, chan) in peer_state.channel_by_id.iter_mut() {
7452 unblock_chan(chan, &mut peer_state.pending_msg_events);
7458 /// Check whether any channels have finished removing all pending updates after a shutdown
7459 /// exchange and can now send a closing_signed.
7460 /// Returns whether any closing_signed messages were generated.
7461 fn maybe_generate_initial_closing_signed(&self) -> bool {
7462 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
7463 let mut has_update = false;
7464 let mut shutdown_results = Vec::new();
7466 let per_peer_state = self.per_peer_state.read().unwrap();
7468 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7469 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7470 let peer_state = &mut *peer_state_lock;
7471 let pending_msg_events = &mut peer_state.pending_msg_events;
7472 peer_state.channel_by_id.retain(|channel_id, phase| {
7474 ChannelPhase::Funded(chan) => {
7475 let logger = WithChannelContext::from(&self.logger, &chan.context);
7476 match chan.maybe_propose_closing_signed(&self.fee_estimator, &&logger) {
7477 Ok((msg_opt, tx_opt, shutdown_result_opt)) => {
7478 if let Some(msg) = msg_opt {
7480 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
7481 node_id: chan.context.get_counterparty_node_id(), msg,
7484 debug_assert_eq!(shutdown_result_opt.is_some(), chan.is_shutdown());
7485 if let Some(shutdown_result) = shutdown_result_opt {
7486 shutdown_results.push(shutdown_result);
7488 if let Some(tx) = tx_opt {
7489 // We're done with this channel. We got a closing_signed and sent back
7490 // a closing_signed with a closing transaction to broadcast.
7491 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7492 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7497 log_info!(logger, "Broadcasting {}", log_tx!(tx));
7498 self.tx_broadcaster.broadcast_transactions(&[&tx]);
7499 update_maps_on_chan_removal!(self, &chan.context);
7505 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
7506 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
7511 _ => true, // Retain unfunded channels if present.
7517 for (counterparty_node_id, err) in handle_errors.drain(..) {
7518 let _ = handle_error!(self, err, counterparty_node_id);
7521 for shutdown_result in shutdown_results.drain(..) {
7522 self.finish_close_channel(shutdown_result);
7528 /// Handle a list of channel failures during a block_connected or block_disconnected call,
7529 /// pushing the channel monitor update (if any) to the background events queue and removing the
7531 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
7532 for mut failure in failed_channels.drain(..) {
7533 // Either a commitment transactions has been confirmed on-chain or
7534 // Channel::block_disconnected detected that the funding transaction has been
7535 // reorganized out of the main chain.
7536 // We cannot broadcast our latest local state via monitor update (as
7537 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
7538 // so we track the update internally and handle it when the user next calls
7539 // timer_tick_occurred, guaranteeing we're running normally.
7540 if let Some((counterparty_node_id, funding_txo, channel_id, update)) = failure.monitor_update.take() {
7541 assert_eq!(update.updates.len(), 1);
7542 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
7543 assert!(should_broadcast);
7544 } else { unreachable!(); }
7545 self.pending_background_events.lock().unwrap().push(
7546 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
7547 counterparty_node_id, funding_txo, update, channel_id,
7550 self.finish_close_channel(failure);
7554 /// Creates an [`OfferBuilder`] such that the [`Offer`] it builds is recognized by the
7555 /// [`ChannelManager`] when handling [`InvoiceRequest`] messages for the offer. The offer will
7556 /// not have an expiration unless otherwise set on the builder.
7560 /// Uses [`MessageRouter::create_blinded_paths`] to construct a [`BlindedPath`] for the offer.
7561 /// However, if one is not found, uses a one-hop [`BlindedPath`] with
7562 /// [`ChannelManager::get_our_node_id`] as the introduction node instead. In the latter case,
7563 /// the node must be announced, otherwise, there is no way to find a path to the introduction in
7564 /// order to send the [`InvoiceRequest`].
7566 /// Also, uses a derived signing pubkey in the offer for recipient privacy.
7570 /// Requires a direct connection to the introduction node in the responding [`InvoiceRequest`]'s
7575 /// Errors if the parameterized [`Router`] is unable to create a blinded path for the offer.
7577 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7579 /// [`Offer`]: crate::offers::offer::Offer
7580 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7581 pub fn create_offer_builder(
7582 &self, description: String
7583 ) -> Result<OfferBuilder<DerivedMetadata, secp256k1::All>, Bolt12SemanticError> {
7584 let node_id = self.get_our_node_id();
7585 let expanded_key = &self.inbound_payment_key;
7586 let entropy = &*self.entropy_source;
7587 let secp_ctx = &self.secp_ctx;
7589 let path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7590 let builder = OfferBuilder::deriving_signing_pubkey(
7591 description, node_id, expanded_key, entropy, secp_ctx
7593 .chain_hash(self.chain_hash)
7599 /// Creates a [`RefundBuilder`] such that the [`Refund`] it builds is recognized by the
7600 /// [`ChannelManager`] when handling [`Bolt12Invoice`] messages for the refund.
7604 /// The provided `payment_id` is used to ensure that only one invoice is paid for the refund.
7605 /// See [Avoiding Duplicate Payments] for other requirements once the payment has been sent.
7607 /// The builder will have the provided expiration set. Any changes to the expiration on the
7608 /// returned builder will not be honored by [`ChannelManager`]. For `no-std`, the highest seen
7609 /// block time minus two hours is used for the current time when determining if the refund has
7612 /// To revoke the refund, use [`ChannelManager::abandon_payment`] prior to receiving the
7613 /// invoice. If abandoned, or an invoice isn't received before expiration, the payment will fail
7614 /// with an [`Event::InvoiceRequestFailed`].
7616 /// If `max_total_routing_fee_msat` is not specified, The default from
7617 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7621 /// Uses [`MessageRouter::create_blinded_paths`] to construct a [`BlindedPath`] for the refund.
7622 /// However, if one is not found, uses a one-hop [`BlindedPath`] with
7623 /// [`ChannelManager::get_our_node_id`] as the introduction node instead. In the latter case,
7624 /// the node must be announced, otherwise, there is no way to find a path to the introduction in
7625 /// order to send the [`Bolt12Invoice`].
7627 /// Also, uses a derived payer id in the refund for payer privacy.
7631 /// Requires a direct connection to an introduction node in the responding
7632 /// [`Bolt12Invoice::payment_paths`].
7637 /// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
7638 /// - `amount_msats` is invalid, or
7639 /// - the parameterized [`Router`] is unable to create a blinded path for the refund.
7641 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7643 /// [`Refund`]: crate::offers::refund::Refund
7644 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7645 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7646 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7647 pub fn create_refund_builder(
7648 &self, description: String, amount_msats: u64, absolute_expiry: Duration,
7649 payment_id: PaymentId, retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
7650 ) -> Result<RefundBuilder<secp256k1::All>, Bolt12SemanticError> {
7651 let node_id = self.get_our_node_id();
7652 let expanded_key = &self.inbound_payment_key;
7653 let entropy = &*self.entropy_source;
7654 let secp_ctx = &self.secp_ctx;
7656 let path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7657 let builder = RefundBuilder::deriving_payer_id(
7658 description, node_id, expanded_key, entropy, secp_ctx, amount_msats, payment_id
7660 .chain_hash(self.chain_hash)
7661 .absolute_expiry(absolute_expiry)
7664 let expiration = StaleExpiration::AbsoluteTimeout(absolute_expiry);
7665 self.pending_outbound_payments
7666 .add_new_awaiting_invoice(
7667 payment_id, expiration, retry_strategy, max_total_routing_fee_msat,
7669 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7674 /// Pays for an [`Offer`] using the given parameters by creating an [`InvoiceRequest`] and
7675 /// enqueuing it to be sent via an onion message. [`ChannelManager`] will pay the actual
7676 /// [`Bolt12Invoice`] once it is received.
7678 /// Uses [`InvoiceRequestBuilder`] such that the [`InvoiceRequest`] it builds is recognized by
7679 /// the [`ChannelManager`] when handling a [`Bolt12Invoice`] message in response to the request.
7680 /// The optional parameters are used in the builder, if `Some`:
7681 /// - `quantity` for [`InvoiceRequest::quantity`] which must be set if
7682 /// [`Offer::expects_quantity`] is `true`.
7683 /// - `amount_msats` if overpaying what is required for the given `quantity` is desired, and
7684 /// - `payer_note` for [`InvoiceRequest::payer_note`].
7686 /// If `max_total_routing_fee_msat` is not specified, The default from
7687 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7691 /// The provided `payment_id` is used to ensure that only one invoice is paid for the request
7692 /// when received. See [Avoiding Duplicate Payments] for other requirements once the payment has
7695 /// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
7696 /// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
7697 /// payment will fail with an [`Event::InvoiceRequestFailed`].
7701 /// Uses a one-hop [`BlindedPath`] for the reply path with [`ChannelManager::get_our_node_id`]
7702 /// as the introduction node and a derived payer id for payer privacy. As such, currently, the
7703 /// node must be announced. Otherwise, there is no way to find a path to the introduction node
7704 /// in order to send the [`Bolt12Invoice`].
7708 /// Requires a direct connection to an introduction node in [`Offer::paths`] or to
7709 /// [`Offer::signing_pubkey`], if empty. A similar restriction applies to the responding
7710 /// [`Bolt12Invoice::payment_paths`].
7715 /// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
7716 /// - the provided parameters are invalid for the offer,
7717 /// - the parameterized [`Router`] is unable to create a blinded reply path for the invoice
7720 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7721 /// [`InvoiceRequest::quantity`]: crate::offers::invoice_request::InvoiceRequest::quantity
7722 /// [`InvoiceRequest::payer_note`]: crate::offers::invoice_request::InvoiceRequest::payer_note
7723 /// [`InvoiceRequestBuilder`]: crate::offers::invoice_request::InvoiceRequestBuilder
7724 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7725 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7726 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7727 pub fn pay_for_offer(
7728 &self, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>,
7729 payer_note: Option<String>, payment_id: PaymentId, retry_strategy: Retry,
7730 max_total_routing_fee_msat: Option<u64>
7731 ) -> Result<(), Bolt12SemanticError> {
7732 let expanded_key = &self.inbound_payment_key;
7733 let entropy = &*self.entropy_source;
7734 let secp_ctx = &self.secp_ctx;
7737 .request_invoice_deriving_payer_id(expanded_key, entropy, secp_ctx, payment_id)?
7738 .chain_hash(self.chain_hash)?;
7739 let builder = match quantity {
7741 Some(quantity) => builder.quantity(quantity)?,
7743 let builder = match amount_msats {
7745 Some(amount_msats) => builder.amount_msats(amount_msats)?,
7747 let builder = match payer_note {
7749 Some(payer_note) => builder.payer_note(payer_note),
7751 let invoice_request = builder.build_and_sign()?;
7752 let reply_path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7754 let expiration = StaleExpiration::TimerTicks(1);
7755 self.pending_outbound_payments
7756 .add_new_awaiting_invoice(
7757 payment_id, expiration, retry_strategy, max_total_routing_fee_msat
7759 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7761 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7762 if offer.paths().is_empty() {
7763 let message = new_pending_onion_message(
7764 OffersMessage::InvoiceRequest(invoice_request),
7765 Destination::Node(offer.signing_pubkey()),
7768 pending_offers_messages.push(message);
7770 // Send as many invoice requests as there are paths in the offer (with an upper bound).
7771 // Using only one path could result in a failure if the path no longer exists. But only
7772 // one invoice for a given payment id will be paid, even if more than one is received.
7773 const REQUEST_LIMIT: usize = 10;
7774 for path in offer.paths().into_iter().take(REQUEST_LIMIT) {
7775 let message = new_pending_onion_message(
7776 OffersMessage::InvoiceRequest(invoice_request.clone()),
7777 Destination::BlindedPath(path.clone()),
7778 Some(reply_path.clone()),
7780 pending_offers_messages.push(message);
7787 /// Creates a [`Bolt12Invoice`] for a [`Refund`] and enqueues it to be sent via an onion
7790 /// The resulting invoice uses a [`PaymentHash`] recognized by the [`ChannelManager`] and a
7791 /// [`BlindedPath`] containing the [`PaymentSecret`] needed to reconstruct the corresponding
7792 /// [`PaymentPreimage`].
7796 /// Requires a direct connection to an introduction node in [`Refund::paths`] or to
7797 /// [`Refund::payer_id`], if empty. This request is best effort; an invoice will be sent to each
7798 /// node meeting the aforementioned criteria, but there's no guarantee that they will be
7799 /// received and no retries will be made.
7803 /// Errors if the parameterized [`Router`] is unable to create a blinded payment path or reply
7804 /// path for the invoice.
7806 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7807 pub fn request_refund_payment(&self, refund: &Refund) -> Result<(), Bolt12SemanticError> {
7808 let expanded_key = &self.inbound_payment_key;
7809 let entropy = &*self.entropy_source;
7810 let secp_ctx = &self.secp_ctx;
7812 let amount_msats = refund.amount_msats();
7813 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
7815 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
7816 Ok((payment_hash, payment_secret)) => {
7817 let payment_paths = self.create_blinded_payment_paths(amount_msats, payment_secret)
7818 .map_err(|_| Bolt12SemanticError::MissingPaths)?;
7820 #[cfg(feature = "std")]
7821 let builder = refund.respond_using_derived_keys(
7822 payment_paths, payment_hash, expanded_key, entropy
7824 #[cfg(not(feature = "std"))]
7825 let created_at = Duration::from_secs(
7826 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
7828 #[cfg(not(feature = "std"))]
7829 let builder = refund.respond_using_derived_keys_no_std(
7830 payment_paths, payment_hash, created_at, expanded_key, entropy
7832 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
7833 let reply_path = self.create_blinded_path()
7834 .map_err(|_| Bolt12SemanticError::MissingPaths)?;
7836 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7837 if refund.paths().is_empty() {
7838 let message = new_pending_onion_message(
7839 OffersMessage::Invoice(invoice),
7840 Destination::Node(refund.payer_id()),
7843 pending_offers_messages.push(message);
7845 for path in refund.paths() {
7846 let message = new_pending_onion_message(
7847 OffersMessage::Invoice(invoice.clone()),
7848 Destination::BlindedPath(path.clone()),
7849 Some(reply_path.clone()),
7851 pending_offers_messages.push(message);
7857 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
7861 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
7864 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
7865 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
7867 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
7868 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
7869 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
7870 /// passed directly to [`claim_funds`].
7872 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
7874 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7875 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7879 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7880 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7882 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7884 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7885 /// on versions of LDK prior to 0.0.114.
7887 /// [`claim_funds`]: Self::claim_funds
7888 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7889 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
7890 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
7891 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
7892 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
7893 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
7894 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
7895 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
7896 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7897 min_final_cltv_expiry_delta)
7900 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
7901 /// stored external to LDK.
7903 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
7904 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
7905 /// the `min_value_msat` provided here, if one is provided.
7907 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
7908 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
7911 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
7912 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
7913 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
7914 /// sender "proof-of-payment" unless they have paid the required amount.
7916 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
7917 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
7918 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
7919 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
7920 /// invoices when no timeout is set.
7922 /// Note that we use block header time to time-out pending inbound payments (with some margin
7923 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
7924 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
7925 /// If you need exact expiry semantics, you should enforce them upon receipt of
7926 /// [`PaymentClaimable`].
7928 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
7929 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
7931 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7932 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7936 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7937 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7939 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7941 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7942 /// on versions of LDK prior to 0.0.114.
7944 /// [`create_inbound_payment`]: Self::create_inbound_payment
7945 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7946 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
7947 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
7948 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
7949 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7950 min_final_cltv_expiry)
7953 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
7954 /// previously returned from [`create_inbound_payment`].
7956 /// [`create_inbound_payment`]: Self::create_inbound_payment
7957 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
7958 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
7961 /// Creates a blinded path by delegating to [`MessageRouter::create_blinded_paths`].
7963 /// Errors if the `MessageRouter` errors or returns an empty `Vec`.
7964 fn create_blinded_path(&self) -> Result<BlindedPath, ()> {
7965 let recipient = self.get_our_node_id();
7966 let entropy_source = self.entropy_source.deref();
7967 let secp_ctx = &self.secp_ctx;
7969 let peers = self.per_peer_state.read().unwrap()
7971 .filter(|(_, peer)| peer.lock().unwrap().latest_features.supports_onion_messages())
7972 .map(|(node_id, _)| *node_id)
7973 .collect::<Vec<_>>();
7976 .create_blinded_paths(recipient, peers, entropy_source, secp_ctx)
7977 .and_then(|paths| paths.into_iter().next().ok_or(()))
7980 /// Creates multi-hop blinded payment paths for the given `amount_msats` by delegating to
7981 /// [`Router::create_blinded_payment_paths`].
7982 fn create_blinded_payment_paths(
7983 &self, amount_msats: u64, payment_secret: PaymentSecret
7984 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
7985 let entropy_source = self.entropy_source.deref();
7986 let secp_ctx = &self.secp_ctx;
7988 let first_hops = self.list_usable_channels();
7989 let payee_node_id = self.get_our_node_id();
7990 let max_cltv_expiry = self.best_block.read().unwrap().height() + CLTV_FAR_FAR_AWAY
7991 + LATENCY_GRACE_PERIOD_BLOCKS;
7992 let payee_tlvs = ReceiveTlvs {
7994 payment_constraints: PaymentConstraints {
7996 htlc_minimum_msat: 1,
7999 self.router.create_blinded_payment_paths(
8000 payee_node_id, first_hops, payee_tlvs, amount_msats, entropy_source, secp_ctx
8004 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
8005 /// are used when constructing the phantom invoice's route hints.
8007 /// [phantom node payments]: crate::sign::PhantomKeysManager
8008 pub fn get_phantom_scid(&self) -> u64 {
8009 let best_block_height = self.best_block.read().unwrap().height();
8010 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
8012 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
8013 // Ensure the generated scid doesn't conflict with a real channel.
8014 match short_to_chan_info.get(&scid_candidate) {
8015 Some(_) => continue,
8016 None => return scid_candidate
8021 /// Gets route hints for use in receiving [phantom node payments].
8023 /// [phantom node payments]: crate::sign::PhantomKeysManager
8024 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
8026 channels: self.list_usable_channels(),
8027 phantom_scid: self.get_phantom_scid(),
8028 real_node_pubkey: self.get_our_node_id(),
8032 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
8033 /// used when constructing the route hints for HTLCs intended to be intercepted. See
8034 /// [`ChannelManager::forward_intercepted_htlc`].
8036 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
8037 /// times to get a unique scid.
8038 pub fn get_intercept_scid(&self) -> u64 {
8039 let best_block_height = self.best_block.read().unwrap().height();
8040 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
8042 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
8043 // Ensure the generated scid doesn't conflict with a real channel.
8044 if short_to_chan_info.contains_key(&scid_candidate) { continue }
8045 return scid_candidate
8049 /// Gets inflight HTLC information by processing pending outbound payments that are in
8050 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
8051 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
8052 let mut inflight_htlcs = InFlightHtlcs::new();
8054 let per_peer_state = self.per_peer_state.read().unwrap();
8055 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8056 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8057 let peer_state = &mut *peer_state_lock;
8058 for chan in peer_state.channel_by_id.values().filter_map(
8059 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
8061 for (htlc_source, _) in chan.inflight_htlc_sources() {
8062 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
8063 inflight_htlcs.process_path(path, self.get_our_node_id());
8072 #[cfg(any(test, feature = "_test_utils"))]
8073 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
8074 let events = core::cell::RefCell::new(Vec::new());
8075 let event_handler = |event: events::Event| events.borrow_mut().push(event);
8076 self.process_pending_events(&event_handler);
8080 #[cfg(feature = "_test_utils")]
8081 pub fn push_pending_event(&self, event: events::Event) {
8082 let mut events = self.pending_events.lock().unwrap();
8083 events.push_back((event, None));
8087 pub fn pop_pending_event(&self) -> Option<events::Event> {
8088 let mut events = self.pending_events.lock().unwrap();
8089 events.pop_front().map(|(e, _)| e)
8093 pub fn has_pending_payments(&self) -> bool {
8094 self.pending_outbound_payments.has_pending_payments()
8098 pub fn clear_pending_payments(&self) {
8099 self.pending_outbound_payments.clear_pending_payments()
8102 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
8103 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
8104 /// operation. It will double-check that nothing *else* is also blocking the same channel from
8105 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
8106 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey,
8107 channel_funding_outpoint: OutPoint, channel_id: ChannelId,
8108 mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
8110 let logger = WithContext::from(
8111 &self.logger, Some(counterparty_node_id), Some(channel_id),
8114 let per_peer_state = self.per_peer_state.read().unwrap();
8115 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
8116 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
8117 let peer_state = &mut *peer_state_lck;
8118 if let Some(blocker) = completed_blocker.take() {
8119 // Only do this on the first iteration of the loop.
8120 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
8121 .get_mut(&channel_id)
8123 blockers.retain(|iter| iter != &blocker);
8127 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
8128 channel_funding_outpoint, channel_id, counterparty_node_id) {
8129 // Check that, while holding the peer lock, we don't have anything else
8130 // blocking monitor updates for this channel. If we do, release the monitor
8131 // update(s) when those blockers complete.
8132 log_trace!(logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
8137 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(
8139 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
8140 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
8141 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
8142 log_debug!(logger, "Unlocking monitor updating for channel {} and updating monitor",
8144 handle_new_monitor_update!(self, channel_funding_outpoint, channel_id, monitor_update,
8145 peer_state_lck, peer_state, per_peer_state, chan);
8146 if further_update_exists {
8147 // If there are more `ChannelMonitorUpdate`s to process, restart at the
8152 log_trace!(logger, "Unlocked monitor updating for channel {} without monitors to update",
8159 "Got a release post-RAA monitor update for peer {} but the channel is gone",
8160 log_pubkey!(counterparty_node_id));
8166 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
8167 for action in actions {
8169 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
8170 channel_funding_outpoint, channel_id, counterparty_node_id
8172 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, channel_id, None);
8178 /// Processes any events asynchronously in the order they were generated since the last call
8179 /// using the given event handler.
8181 /// See the trait-level documentation of [`EventsProvider`] for requirements.
8182 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
8186 process_events_body!(self, ev, { handler(ev).await });
8190 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>
8192 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8193 T::Target: BroadcasterInterface,
8194 ES::Target: EntropySource,
8195 NS::Target: NodeSigner,
8196 SP::Target: SignerProvider,
8197 F::Target: FeeEstimator,
8201 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
8202 /// The returned array will contain `MessageSendEvent`s for different peers if
8203 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
8204 /// is always placed next to each other.
8206 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
8207 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
8208 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
8209 /// will randomly be placed first or last in the returned array.
8211 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
8212 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
8213 /// the `MessageSendEvent`s to the specific peer they were generated under.
8214 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
8215 let events = RefCell::new(Vec::new());
8216 PersistenceNotifierGuard::optionally_notify(self, || {
8217 let mut result = NotifyOption::SkipPersistNoEvents;
8219 // TODO: This behavior should be documented. It's unintuitive that we query
8220 // ChannelMonitors when clearing other events.
8221 if self.process_pending_monitor_events() {
8222 result = NotifyOption::DoPersist;
8225 if self.check_free_holding_cells() {
8226 result = NotifyOption::DoPersist;
8228 if self.maybe_generate_initial_closing_signed() {
8229 result = NotifyOption::DoPersist;
8232 let mut pending_events = Vec::new();
8233 let per_peer_state = self.per_peer_state.read().unwrap();
8234 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8235 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8236 let peer_state = &mut *peer_state_lock;
8237 if peer_state.pending_msg_events.len() > 0 {
8238 pending_events.append(&mut peer_state.pending_msg_events);
8242 if !pending_events.is_empty() {
8243 events.replace(pending_events);
8252 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>
8254 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8255 T::Target: BroadcasterInterface,
8256 ES::Target: EntropySource,
8257 NS::Target: NodeSigner,
8258 SP::Target: SignerProvider,
8259 F::Target: FeeEstimator,
8263 /// Processes events that must be periodically handled.
8265 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
8266 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
8267 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
8269 process_events_body!(self, ev, handler.handle_event(ev));
8273 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>
8275 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8276 T::Target: BroadcasterInterface,
8277 ES::Target: EntropySource,
8278 NS::Target: NodeSigner,
8279 SP::Target: SignerProvider,
8280 F::Target: FeeEstimator,
8284 fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
8286 let best_block = self.best_block.read().unwrap();
8287 assert_eq!(best_block.block_hash(), header.prev_blockhash,
8288 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
8289 assert_eq!(best_block.height(), height - 1,
8290 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
8293 self.transactions_confirmed(header, txdata, height);
8294 self.best_block_updated(header, height);
8297 fn block_disconnected(&self, header: &Header, height: u32) {
8298 let _persistence_guard =
8299 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8300 self, || -> NotifyOption { NotifyOption::DoPersist });
8301 let new_height = height - 1;
8303 let mut best_block = self.best_block.write().unwrap();
8304 assert_eq!(best_block.block_hash(), header.block_hash(),
8305 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
8306 assert_eq!(best_block.height(), height,
8307 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
8308 *best_block = BestBlock::new(header.prev_blockhash, new_height)
8311 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)));
8315 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>
8317 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8318 T::Target: BroadcasterInterface,
8319 ES::Target: EntropySource,
8320 NS::Target: NodeSigner,
8321 SP::Target: SignerProvider,
8322 F::Target: FeeEstimator,
8326 fn transactions_confirmed(&self, header: &Header, txdata: &TransactionData, height: u32) {
8327 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8328 // during initialization prior to the chain_monitor being fully configured in some cases.
8329 // See the docs for `ChannelManagerReadArgs` for more.
8331 let block_hash = header.block_hash();
8332 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
8334 let _persistence_guard =
8335 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8336 self, || -> NotifyOption { NotifyOption::DoPersist });
8337 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))
8338 .map(|(a, b)| (a, Vec::new(), b)));
8340 let last_best_block_height = self.best_block.read().unwrap().height();
8341 if height < last_best_block_height {
8342 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
8343 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)));
8347 fn best_block_updated(&self, header: &Header, height: u32) {
8348 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8349 // during initialization prior to the chain_monitor being fully configured in some cases.
8350 // See the docs for `ChannelManagerReadArgs` for more.
8352 let block_hash = header.block_hash();
8353 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
8355 let _persistence_guard =
8356 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8357 self, || -> NotifyOption { NotifyOption::DoPersist });
8358 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
8360 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)));
8362 macro_rules! max_time {
8363 ($timestamp: expr) => {
8365 // Update $timestamp to be the max of its current value and the block
8366 // timestamp. This should keep us close to the current time without relying on
8367 // having an explicit local time source.
8368 // Just in case we end up in a race, we loop until we either successfully
8369 // update $timestamp or decide we don't need to.
8370 let old_serial = $timestamp.load(Ordering::Acquire);
8371 if old_serial >= header.time as usize { break; }
8372 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
8378 max_time!(self.highest_seen_timestamp);
8379 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
8380 payment_secrets.retain(|_, inbound_payment| {
8381 inbound_payment.expiry_time > header.time as u64
8385 fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
8386 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
8387 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
8388 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8389 let peer_state = &mut *peer_state_lock;
8390 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
8391 let txid_opt = chan.context.get_funding_txo();
8392 let height_opt = chan.context.get_funding_tx_confirmation_height();
8393 let hash_opt = chan.context.get_funding_tx_confirmed_in();
8394 if let (Some(funding_txo), Some(conf_height), Some(block_hash)) = (txid_opt, height_opt, hash_opt) {
8395 res.push((funding_txo.txid, conf_height, Some(block_hash)));
8402 fn transaction_unconfirmed(&self, txid: &Txid) {
8403 let _persistence_guard =
8404 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8405 self, || -> NotifyOption { NotifyOption::DoPersist });
8406 self.do_chain_event(None, |channel| {
8407 if let Some(funding_txo) = channel.context.get_funding_txo() {
8408 if funding_txo.txid == *txid {
8409 channel.funding_transaction_unconfirmed(&&WithChannelContext::from(&self.logger, &channel.context)).map(|()| (None, Vec::new(), None))
8410 } else { Ok((None, Vec::new(), None)) }
8411 } else { Ok((None, Vec::new(), None)) }
8416 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>
8418 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8419 T::Target: BroadcasterInterface,
8420 ES::Target: EntropySource,
8421 NS::Target: NodeSigner,
8422 SP::Target: SignerProvider,
8423 F::Target: FeeEstimator,
8427 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
8428 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
8430 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
8431 (&self, height_opt: Option<u32>, f: FN) {
8432 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8433 // during initialization prior to the chain_monitor being fully configured in some cases.
8434 // See the docs for `ChannelManagerReadArgs` for more.
8436 let mut failed_channels = Vec::new();
8437 let mut timed_out_htlcs = Vec::new();
8439 let per_peer_state = self.per_peer_state.read().unwrap();
8440 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8441 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8442 let peer_state = &mut *peer_state_lock;
8443 let pending_msg_events = &mut peer_state.pending_msg_events;
8444 peer_state.channel_by_id.retain(|_, phase| {
8446 // Retain unfunded channels.
8447 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
8448 ChannelPhase::Funded(channel) => {
8449 let res = f(channel);
8450 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
8451 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
8452 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
8453 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
8454 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
8456 let logger = WithChannelContext::from(&self.logger, &channel.context);
8457 if let Some(channel_ready) = channel_ready_opt {
8458 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
8459 if channel.context.is_usable() {
8460 log_trace!(logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
8461 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
8462 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
8463 node_id: channel.context.get_counterparty_node_id(),
8468 log_trace!(logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
8473 let mut pending_events = self.pending_events.lock().unwrap();
8474 emit_channel_ready_event!(pending_events, channel);
8477 if let Some(announcement_sigs) = announcement_sigs {
8478 log_trace!(logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
8479 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
8480 node_id: channel.context.get_counterparty_node_id(),
8481 msg: announcement_sigs,
8483 if let Some(height) = height_opt {
8484 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.chain_hash, height, &self.default_configuration) {
8485 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
8487 // Note that announcement_signatures fails if the channel cannot be announced,
8488 // so get_channel_update_for_broadcast will never fail by the time we get here.
8489 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
8494 if channel.is_our_channel_ready() {
8495 if let Some(real_scid) = channel.context.get_short_channel_id() {
8496 // If we sent a 0conf channel_ready, and now have an SCID, we add it
8497 // to the short_to_chan_info map here. Note that we check whether we
8498 // can relay using the real SCID at relay-time (i.e.
8499 // enforce option_scid_alias then), and if the funding tx is ever
8500 // un-confirmed we force-close the channel, ensuring short_to_chan_info
8501 // is always consistent.
8502 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
8503 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8504 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
8505 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
8506 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
8509 } else if let Err(reason) = res {
8510 update_maps_on_chan_removal!(self, &channel.context);
8511 // It looks like our counterparty went on-chain or funding transaction was
8512 // reorged out of the main chain. Close the channel.
8513 let reason_message = format!("{}", reason);
8514 failed_channels.push(channel.context.force_shutdown(true, reason));
8515 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
8516 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
8520 pending_msg_events.push(events::MessageSendEvent::HandleError {
8521 node_id: channel.context.get_counterparty_node_id(),
8522 action: msgs::ErrorAction::DisconnectPeer {
8523 msg: Some(msgs::ErrorMessage {
8524 channel_id: channel.context.channel_id(),
8525 data: reason_message,
8538 if let Some(height) = height_opt {
8539 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
8540 payment.htlcs.retain(|htlc| {
8541 // If height is approaching the number of blocks we think it takes us to get
8542 // our commitment transaction confirmed before the HTLC expires, plus the
8543 // number of blocks we generally consider it to take to do a commitment update,
8544 // just give up on it and fail the HTLC.
8545 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
8546 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
8547 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
8549 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
8550 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
8551 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
8555 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
8558 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
8559 intercepted_htlcs.retain(|_, htlc| {
8560 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
8561 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
8562 short_channel_id: htlc.prev_short_channel_id,
8563 user_channel_id: Some(htlc.prev_user_channel_id),
8564 htlc_id: htlc.prev_htlc_id,
8565 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
8566 phantom_shared_secret: None,
8567 outpoint: htlc.prev_funding_outpoint,
8568 channel_id: htlc.prev_channel_id,
8569 blinded_failure: htlc.forward_info.routing.blinded_failure(),
8572 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
8573 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
8574 _ => unreachable!(),
8576 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
8577 HTLCFailReason::from_failure_code(0x2000 | 2),
8578 HTLCDestination::InvalidForward { requested_forward_scid }));
8579 let logger = WithContext::from(
8580 &self.logger, None, Some(htlc.prev_channel_id)
8582 log_trace!(logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
8588 self.handle_init_event_channel_failures(failed_channels);
8590 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
8591 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
8595 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
8596 /// may have events that need processing.
8598 /// In order to check if this [`ChannelManager`] needs persisting, call
8599 /// [`Self::get_and_clear_needs_persistence`].
8601 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
8602 /// [`ChannelManager`] and should instead register actions to be taken later.
8603 pub fn get_event_or_persistence_needed_future(&self) -> Future {
8604 self.event_persist_notifier.get_future()
8607 /// Returns true if this [`ChannelManager`] needs to be persisted.
8608 pub fn get_and_clear_needs_persistence(&self) -> bool {
8609 self.needs_persist_flag.swap(false, Ordering::AcqRel)
8612 #[cfg(any(test, feature = "_test_utils"))]
8613 pub fn get_event_or_persist_condvar_value(&self) -> bool {
8614 self.event_persist_notifier.notify_pending()
8617 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
8618 /// [`chain::Confirm`] interfaces.
8619 pub fn current_best_block(&self) -> BestBlock {
8620 self.best_block.read().unwrap().clone()
8623 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
8624 /// [`ChannelManager`].
8625 pub fn node_features(&self) -> NodeFeatures {
8626 provided_node_features(&self.default_configuration)
8629 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
8630 /// [`ChannelManager`].
8632 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8633 /// or not. Thus, this method is not public.
8634 #[cfg(any(feature = "_test_utils", test))]
8635 pub fn bolt11_invoice_features(&self) -> Bolt11InvoiceFeatures {
8636 provided_bolt11_invoice_features(&self.default_configuration)
8639 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
8640 /// [`ChannelManager`].
8641 fn bolt12_invoice_features(&self) -> Bolt12InvoiceFeatures {
8642 provided_bolt12_invoice_features(&self.default_configuration)
8645 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
8646 /// [`ChannelManager`].
8647 pub fn channel_features(&self) -> ChannelFeatures {
8648 provided_channel_features(&self.default_configuration)
8651 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
8652 /// [`ChannelManager`].
8653 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
8654 provided_channel_type_features(&self.default_configuration)
8657 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
8658 /// [`ChannelManager`].
8659 pub fn init_features(&self) -> InitFeatures {
8660 provided_init_features(&self.default_configuration)
8664 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8665 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
8667 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8668 T::Target: BroadcasterInterface,
8669 ES::Target: EntropySource,
8670 NS::Target: NodeSigner,
8671 SP::Target: SignerProvider,
8672 F::Target: FeeEstimator,
8676 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
8677 // Note that we never need to persist the updated ChannelManager for an inbound
8678 // open_channel message - pre-funded channels are never written so there should be no
8679 // change to the contents.
8680 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8681 let res = self.internal_open_channel(counterparty_node_id, msg);
8682 let persist = match &res {
8683 Err(e) if e.closes_channel() => {
8684 debug_assert!(false, "We shouldn't close a new channel");
8685 NotifyOption::DoPersist
8687 _ => NotifyOption::SkipPersistHandleEvents,
8689 let _ = handle_error!(self, res, *counterparty_node_id);
8694 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
8695 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8696 "Dual-funded channels not supported".to_owned(),
8697 msg.temporary_channel_id.clone())), *counterparty_node_id);
8700 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
8701 // Note that we never need to persist the updated ChannelManager for an inbound
8702 // accept_channel message - pre-funded channels are never written so there should be no
8703 // change to the contents.
8704 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8705 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
8706 NotifyOption::SkipPersistHandleEvents
8710 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
8711 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8712 "Dual-funded channels not supported".to_owned(),
8713 msg.temporary_channel_id.clone())), *counterparty_node_id);
8716 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
8717 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8718 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
8721 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
8722 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8723 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
8726 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
8727 // Note that we never need to persist the updated ChannelManager for an inbound
8728 // channel_ready message - while the channel's state will change, any channel_ready message
8729 // will ultimately be re-sent on startup and the `ChannelMonitor` won't be updated so we
8730 // will not force-close the channel on startup.
8731 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8732 let res = self.internal_channel_ready(counterparty_node_id, msg);
8733 let persist = match &res {
8734 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8735 _ => NotifyOption::SkipPersistHandleEvents,
8737 let _ = handle_error!(self, res, *counterparty_node_id);
8742 fn handle_stfu(&self, counterparty_node_id: &PublicKey, msg: &msgs::Stfu) {
8743 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8744 "Quiescence not supported".to_owned(),
8745 msg.channel_id.clone())), *counterparty_node_id);
8748 fn handle_splice(&self, counterparty_node_id: &PublicKey, msg: &msgs::Splice) {
8749 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8750 "Splicing not supported".to_owned(),
8751 msg.channel_id.clone())), *counterparty_node_id);
8754 fn handle_splice_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceAck) {
8755 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8756 "Splicing not supported (splice_ack)".to_owned(),
8757 msg.channel_id.clone())), *counterparty_node_id);
8760 fn handle_splice_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
8761 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8762 "Splicing not supported (splice_locked)".to_owned(),
8763 msg.channel_id.clone())), *counterparty_node_id);
8766 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
8767 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8768 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
8771 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
8772 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8773 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
8776 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
8777 // Note that we never need to persist the updated ChannelManager for an inbound
8778 // update_add_htlc message - the message itself doesn't change our channel state only the
8779 // `commitment_signed` message afterwards will.
8780 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8781 let res = self.internal_update_add_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_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
8793 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8794 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
8797 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
8798 // Note that we never need to persist the updated ChannelManager for an inbound
8799 // update_fail_htlc message - the message itself doesn't change our channel state only the
8800 // `commitment_signed` message afterwards will.
8801 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8802 let res = self.internal_update_fail_htlc(counterparty_node_id, msg);
8803 let persist = match &res {
8804 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8805 Err(_) => NotifyOption::SkipPersistHandleEvents,
8806 Ok(()) => NotifyOption::SkipPersistNoEvents,
8808 let _ = handle_error!(self, res, *counterparty_node_id);
8813 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
8814 // Note that we never need to persist the updated ChannelManager for an inbound
8815 // update_fail_malformed_htlc message - the message itself doesn't change our channel state
8816 // only the `commitment_signed` message afterwards will.
8817 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8818 let res = self.internal_update_fail_malformed_htlc(counterparty_node_id, msg);
8819 let persist = match &res {
8820 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8821 Err(_) => NotifyOption::SkipPersistHandleEvents,
8822 Ok(()) => NotifyOption::SkipPersistNoEvents,
8824 let _ = handle_error!(self, res, *counterparty_node_id);
8829 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
8830 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8831 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
8834 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
8835 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8836 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
8839 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
8840 // Note that we never need to persist the updated ChannelManager for an inbound
8841 // update_fee message - the message itself doesn't change our channel state only the
8842 // `commitment_signed` message afterwards will.
8843 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8844 let res = self.internal_update_fee(counterparty_node_id, msg);
8845 let persist = match &res {
8846 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8847 Err(_) => NotifyOption::SkipPersistHandleEvents,
8848 Ok(()) => NotifyOption::SkipPersistNoEvents,
8850 let _ = handle_error!(self, res, *counterparty_node_id);
8855 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
8856 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8857 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
8860 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
8861 PersistenceNotifierGuard::optionally_notify(self, || {
8862 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
8865 NotifyOption::DoPersist
8870 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
8871 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8872 let res = self.internal_channel_reestablish(counterparty_node_id, msg);
8873 let persist = match &res {
8874 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8875 Err(_) => NotifyOption::SkipPersistHandleEvents,
8876 Ok(persist) => *persist,
8878 let _ = handle_error!(self, res, *counterparty_node_id);
8883 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
8884 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(
8885 self, || NotifyOption::SkipPersistHandleEvents);
8886 let mut failed_channels = Vec::new();
8887 let mut per_peer_state = self.per_peer_state.write().unwrap();
8890 WithContext::from(&self.logger, Some(*counterparty_node_id), None),
8891 "Marking channels with {} disconnected and generating channel_updates.",
8892 log_pubkey!(counterparty_node_id)
8894 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8895 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8896 let peer_state = &mut *peer_state_lock;
8897 let pending_msg_events = &mut peer_state.pending_msg_events;
8898 peer_state.channel_by_id.retain(|_, phase| {
8899 let context = match phase {
8900 ChannelPhase::Funded(chan) => {
8901 let logger = WithChannelContext::from(&self.logger, &chan.context);
8902 if chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok() {
8903 // We only retain funded channels that are not shutdown.
8908 // Unfunded channels will always be removed.
8909 ChannelPhase::UnfundedOutboundV1(chan) => {
8912 ChannelPhase::UnfundedInboundV1(chan) => {
8916 // Clean up for removal.
8917 update_maps_on_chan_removal!(self, &context);
8918 failed_channels.push(context.force_shutdown(false, ClosureReason::DisconnectedPeer));
8921 // Note that we don't bother generating any events for pre-accept channels -
8922 // they're not considered "channels" yet from the PoV of our events interface.
8923 peer_state.inbound_channel_request_by_id.clear();
8924 pending_msg_events.retain(|msg| {
8926 // V1 Channel Establishment
8927 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
8928 &events::MessageSendEvent::SendOpenChannel { .. } => false,
8929 &events::MessageSendEvent::SendFundingCreated { .. } => false,
8930 &events::MessageSendEvent::SendFundingSigned { .. } => false,
8931 // V2 Channel Establishment
8932 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
8933 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
8934 // Common Channel Establishment
8935 &events::MessageSendEvent::SendChannelReady { .. } => false,
8936 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
8938 &events::MessageSendEvent::SendStfu { .. } => false,
8940 &events::MessageSendEvent::SendSplice { .. } => false,
8941 &events::MessageSendEvent::SendSpliceAck { .. } => false,
8942 &events::MessageSendEvent::SendSpliceLocked { .. } => false,
8943 // Interactive Transaction Construction
8944 &events::MessageSendEvent::SendTxAddInput { .. } => false,
8945 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
8946 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
8947 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
8948 &events::MessageSendEvent::SendTxComplete { .. } => false,
8949 &events::MessageSendEvent::SendTxSignatures { .. } => false,
8950 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
8951 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
8952 &events::MessageSendEvent::SendTxAbort { .. } => false,
8953 // Channel Operations
8954 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
8955 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
8956 &events::MessageSendEvent::SendClosingSigned { .. } => false,
8957 &events::MessageSendEvent::SendShutdown { .. } => false,
8958 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
8959 &events::MessageSendEvent::HandleError { .. } => false,
8961 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
8962 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
8963 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
8964 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
8965 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
8966 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
8967 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
8968 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
8969 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
8972 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
8973 peer_state.is_connected = false;
8974 peer_state.ok_to_remove(true)
8975 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
8978 per_peer_state.remove(counterparty_node_id);
8980 mem::drop(per_peer_state);
8982 for failure in failed_channels.drain(..) {
8983 self.finish_close_channel(failure);
8987 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
8988 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), None);
8989 if !init_msg.features.supports_static_remote_key() {
8990 log_debug!(logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
8994 let mut res = Ok(());
8996 PersistenceNotifierGuard::optionally_notify(self, || {
8997 // If we have too many peers connected which don't have funded channels, disconnect the
8998 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
8999 // unfunded channels taking up space in memory for disconnected peers, we still let new
9000 // peers connect, but we'll reject new channels from them.
9001 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
9002 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
9005 let mut peer_state_lock = self.per_peer_state.write().unwrap();
9006 match peer_state_lock.entry(counterparty_node_id.clone()) {
9007 hash_map::Entry::Vacant(e) => {
9008 if inbound_peer_limited {
9010 return NotifyOption::SkipPersistNoEvents;
9012 e.insert(Mutex::new(PeerState {
9013 channel_by_id: HashMap::new(),
9014 inbound_channel_request_by_id: HashMap::new(),
9015 latest_features: init_msg.features.clone(),
9016 pending_msg_events: Vec::new(),
9017 in_flight_monitor_updates: BTreeMap::new(),
9018 monitor_update_blocked_actions: BTreeMap::new(),
9019 actions_blocking_raa_monitor_updates: BTreeMap::new(),
9023 hash_map::Entry::Occupied(e) => {
9024 let mut peer_state = e.get().lock().unwrap();
9025 peer_state.latest_features = init_msg.features.clone();
9027 let best_block_height = self.best_block.read().unwrap().height();
9028 if inbound_peer_limited &&
9029 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
9030 peer_state.channel_by_id.len()
9033 return NotifyOption::SkipPersistNoEvents;
9036 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
9037 peer_state.is_connected = true;
9042 log_debug!(logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
9044 let per_peer_state = self.per_peer_state.read().unwrap();
9045 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
9046 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9047 let peer_state = &mut *peer_state_lock;
9048 let pending_msg_events = &mut peer_state.pending_msg_events;
9050 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
9051 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
9053 let logger = WithChannelContext::from(&self.logger, &chan.context);
9054 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
9055 node_id: chan.context.get_counterparty_node_id(),
9056 msg: chan.get_channel_reestablish(&&logger),
9061 return NotifyOption::SkipPersistHandleEvents;
9062 //TODO: Also re-broadcast announcement_signatures
9067 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
9068 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
9070 match &msg.data as &str {
9071 "cannot co-op close channel w/ active htlcs"|
9072 "link failed to shutdown" =>
9074 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
9075 // send one while HTLCs are still present. The issue is tracked at
9076 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
9077 // to fix it but none so far have managed to land upstream. The issue appears to be
9078 // very low priority for the LND team despite being marked "P1".
9079 // We're not going to bother handling this in a sensible way, instead simply
9080 // repeating the Shutdown message on repeat until morale improves.
9081 if !msg.channel_id.is_zero() {
9082 let per_peer_state = self.per_peer_state.read().unwrap();
9083 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9084 if peer_state_mutex_opt.is_none() { return; }
9085 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
9086 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
9087 if let Some(msg) = chan.get_outbound_shutdown() {
9088 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
9089 node_id: *counterparty_node_id,
9093 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
9094 node_id: *counterparty_node_id,
9095 action: msgs::ErrorAction::SendWarningMessage {
9096 msg: msgs::WarningMessage {
9097 channel_id: msg.channel_id,
9098 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
9100 log_level: Level::Trace,
9110 if msg.channel_id.is_zero() {
9111 let channel_ids: Vec<ChannelId> = {
9112 let per_peer_state = self.per_peer_state.read().unwrap();
9113 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9114 if peer_state_mutex_opt.is_none() { return; }
9115 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
9116 let peer_state = &mut *peer_state_lock;
9117 // Note that we don't bother generating any events for pre-accept channels -
9118 // they're not considered "channels" yet from the PoV of our events interface.
9119 peer_state.inbound_channel_request_by_id.clear();
9120 peer_state.channel_by_id.keys().cloned().collect()
9122 for channel_id in channel_ids {
9123 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
9124 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
9128 // First check if we can advance the channel type and try again.
9129 let per_peer_state = self.per_peer_state.read().unwrap();
9130 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9131 if peer_state_mutex_opt.is_none() { return; }
9132 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
9133 let peer_state = &mut *peer_state_lock;
9134 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
9135 if let Ok(msg) = chan.maybe_handle_error_without_close(self.chain_hash, &self.fee_estimator) {
9136 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
9137 node_id: *counterparty_node_id,
9145 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
9146 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
9150 fn provided_node_features(&self) -> NodeFeatures {
9151 provided_node_features(&self.default_configuration)
9154 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
9155 provided_init_features(&self.default_configuration)
9158 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
9159 Some(vec![self.chain_hash])
9162 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
9163 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9164 "Dual-funded channels not supported".to_owned(),
9165 msg.channel_id.clone())), *counterparty_node_id);
9168 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
9169 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9170 "Dual-funded channels not supported".to_owned(),
9171 msg.channel_id.clone())), *counterparty_node_id);
9174 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
9175 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9176 "Dual-funded channels not supported".to_owned(),
9177 msg.channel_id.clone())), *counterparty_node_id);
9180 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
9181 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9182 "Dual-funded channels not supported".to_owned(),
9183 msg.channel_id.clone())), *counterparty_node_id);
9186 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
9187 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9188 "Dual-funded channels not supported".to_owned(),
9189 msg.channel_id.clone())), *counterparty_node_id);
9192 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
9193 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9194 "Dual-funded channels not supported".to_owned(),
9195 msg.channel_id.clone())), *counterparty_node_id);
9198 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
9199 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9200 "Dual-funded channels not supported".to_owned(),
9201 msg.channel_id.clone())), *counterparty_node_id);
9204 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
9205 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9206 "Dual-funded channels not supported".to_owned(),
9207 msg.channel_id.clone())), *counterparty_node_id);
9210 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
9211 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9212 "Dual-funded channels not supported".to_owned(),
9213 msg.channel_id.clone())), *counterparty_node_id);
9217 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9218 OffersMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
9220 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9221 T::Target: BroadcasterInterface,
9222 ES::Target: EntropySource,
9223 NS::Target: NodeSigner,
9224 SP::Target: SignerProvider,
9225 F::Target: FeeEstimator,
9229 fn handle_message(&self, message: OffersMessage) -> Option<OffersMessage> {
9230 let secp_ctx = &self.secp_ctx;
9231 let expanded_key = &self.inbound_payment_key;
9234 OffersMessage::InvoiceRequest(invoice_request) => {
9235 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
9238 Ok(amount_msats) => amount_msats,
9239 Err(error) => return Some(OffersMessage::InvoiceError(error.into())),
9241 let invoice_request = match invoice_request.verify(expanded_key, secp_ctx) {
9242 Ok(invoice_request) => invoice_request,
9244 let error = Bolt12SemanticError::InvalidMetadata;
9245 return Some(OffersMessage::InvoiceError(error.into()));
9249 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
9250 let (payment_hash, payment_secret) = match self.create_inbound_payment(
9251 Some(amount_msats), relative_expiry, None
9253 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
9255 let error = Bolt12SemanticError::InvalidAmount;
9256 return Some(OffersMessage::InvoiceError(error.into()));
9260 let payment_paths = match self.create_blinded_payment_paths(
9261 amount_msats, payment_secret
9263 Ok(payment_paths) => payment_paths,
9265 let error = Bolt12SemanticError::MissingPaths;
9266 return Some(OffersMessage::InvoiceError(error.into()));
9270 #[cfg(not(feature = "std"))]
9271 let created_at = Duration::from_secs(
9272 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9275 if invoice_request.keys.is_some() {
9276 #[cfg(feature = "std")]
9277 let builder = invoice_request.respond_using_derived_keys(
9278 payment_paths, payment_hash
9280 #[cfg(not(feature = "std"))]
9281 let builder = invoice_request.respond_using_derived_keys_no_std(
9282 payment_paths, payment_hash, created_at
9284 match builder.and_then(|b| b.allow_mpp().build_and_sign(secp_ctx)) {
9285 Ok(invoice) => Some(OffersMessage::Invoice(invoice)),
9286 Err(error) => Some(OffersMessage::InvoiceError(error.into())),
9289 #[cfg(feature = "std")]
9290 let builder = invoice_request.respond_with(payment_paths, payment_hash);
9291 #[cfg(not(feature = "std"))]
9292 let builder = invoice_request.respond_with_no_std(
9293 payment_paths, payment_hash, created_at
9295 let response = builder.and_then(|builder| builder.allow_mpp().build())
9296 .map_err(|e| OffersMessage::InvoiceError(e.into()))
9298 match invoice.sign(|invoice| self.node_signer.sign_bolt12_invoice(invoice)) {
9299 Ok(invoice) => Ok(OffersMessage::Invoice(invoice)),
9300 Err(SignError::Signing(())) => Err(OffersMessage::InvoiceError(
9301 InvoiceError::from_string("Failed signing invoice".to_string())
9303 Err(SignError::Verification(_)) => Err(OffersMessage::InvoiceError(
9304 InvoiceError::from_string("Failed invoice signature verification".to_string())
9308 Ok(invoice) => Some(invoice),
9309 Err(error) => Some(error),
9313 OffersMessage::Invoice(invoice) => {
9314 match invoice.verify(expanded_key, secp_ctx) {
9316 Some(OffersMessage::InvoiceError(InvoiceError::from_string("Unrecognized invoice".to_owned())))
9318 Ok(_) if invoice.invoice_features().requires_unknown_bits_from(&self.bolt12_invoice_features()) => {
9319 Some(OffersMessage::InvoiceError(Bolt12SemanticError::UnknownRequiredFeatures.into()))
9322 if let Err(e) = self.send_payment_for_bolt12_invoice(&invoice, payment_id) {
9323 log_trace!(self.logger, "Failed paying invoice: {:?}", e);
9324 Some(OffersMessage::InvoiceError(InvoiceError::from_string(format!("{:?}", e))))
9331 OffersMessage::InvoiceError(invoice_error) => {
9332 log_trace!(self.logger, "Received invoice_error: {}", invoice_error);
9338 fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> {
9339 core::mem::take(&mut self.pending_offers_messages.lock().unwrap())
9343 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
9344 /// [`ChannelManager`].
9345 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
9346 let mut node_features = provided_init_features(config).to_context();
9347 node_features.set_keysend_optional();
9351 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
9352 /// [`ChannelManager`].
9354 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
9355 /// or not. Thus, this method is not public.
9356 #[cfg(any(feature = "_test_utils", test))]
9357 pub(crate) fn provided_bolt11_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
9358 provided_init_features(config).to_context()
9361 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
9362 /// [`ChannelManager`].
9363 pub(crate) fn provided_bolt12_invoice_features(config: &UserConfig) -> Bolt12InvoiceFeatures {
9364 provided_init_features(config).to_context()
9367 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
9368 /// [`ChannelManager`].
9369 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
9370 provided_init_features(config).to_context()
9373 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
9374 /// [`ChannelManager`].
9375 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
9376 ChannelTypeFeatures::from_init(&provided_init_features(config))
9379 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
9380 /// [`ChannelManager`].
9381 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
9382 // Note that if new features are added here which other peers may (eventually) require, we
9383 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
9384 // [`ErroringMessageHandler`].
9385 let mut features = InitFeatures::empty();
9386 features.set_data_loss_protect_required();
9387 features.set_upfront_shutdown_script_optional();
9388 features.set_variable_length_onion_required();
9389 features.set_static_remote_key_required();
9390 features.set_payment_secret_required();
9391 features.set_basic_mpp_optional();
9392 features.set_wumbo_optional();
9393 features.set_shutdown_any_segwit_optional();
9394 features.set_channel_type_optional();
9395 features.set_scid_privacy_optional();
9396 features.set_zero_conf_optional();
9397 features.set_route_blinding_optional();
9398 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
9399 features.set_anchors_zero_fee_htlc_tx_optional();
9404 const SERIALIZATION_VERSION: u8 = 1;
9405 const MIN_SERIALIZATION_VERSION: u8 = 1;
9407 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
9408 (2, fee_base_msat, required),
9409 (4, fee_proportional_millionths, required),
9410 (6, cltv_expiry_delta, required),
9413 impl_writeable_tlv_based!(ChannelCounterparty, {
9414 (2, node_id, required),
9415 (4, features, required),
9416 (6, unspendable_punishment_reserve, required),
9417 (8, forwarding_info, option),
9418 (9, outbound_htlc_minimum_msat, option),
9419 (11, outbound_htlc_maximum_msat, option),
9422 impl Writeable for ChannelDetails {
9423 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9424 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9425 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9426 let user_channel_id_low = self.user_channel_id as u64;
9427 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
9428 write_tlv_fields!(writer, {
9429 (1, self.inbound_scid_alias, option),
9430 (2, self.channel_id, required),
9431 (3, self.channel_type, option),
9432 (4, self.counterparty, required),
9433 (5, self.outbound_scid_alias, option),
9434 (6, self.funding_txo, option),
9435 (7, self.config, option),
9436 (8, self.short_channel_id, option),
9437 (9, self.confirmations, option),
9438 (10, self.channel_value_satoshis, required),
9439 (12, self.unspendable_punishment_reserve, option),
9440 (14, user_channel_id_low, required),
9441 (16, self.balance_msat, required),
9442 (18, self.outbound_capacity_msat, required),
9443 (19, self.next_outbound_htlc_limit_msat, required),
9444 (20, self.inbound_capacity_msat, required),
9445 (21, self.next_outbound_htlc_minimum_msat, required),
9446 (22, self.confirmations_required, option),
9447 (24, self.force_close_spend_delay, option),
9448 (26, self.is_outbound, required),
9449 (28, self.is_channel_ready, required),
9450 (30, self.is_usable, required),
9451 (32, self.is_public, required),
9452 (33, self.inbound_htlc_minimum_msat, option),
9453 (35, self.inbound_htlc_maximum_msat, option),
9454 (37, user_channel_id_high_opt, option),
9455 (39, self.feerate_sat_per_1000_weight, option),
9456 (41, self.channel_shutdown_state, option),
9462 impl Readable for ChannelDetails {
9463 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9464 _init_and_read_len_prefixed_tlv_fields!(reader, {
9465 (1, inbound_scid_alias, option),
9466 (2, channel_id, required),
9467 (3, channel_type, option),
9468 (4, counterparty, required),
9469 (5, outbound_scid_alias, option),
9470 (6, funding_txo, option),
9471 (7, config, option),
9472 (8, short_channel_id, option),
9473 (9, confirmations, option),
9474 (10, channel_value_satoshis, required),
9475 (12, unspendable_punishment_reserve, option),
9476 (14, user_channel_id_low, required),
9477 (16, balance_msat, required),
9478 (18, outbound_capacity_msat, required),
9479 // Note that by the time we get past the required read above, outbound_capacity_msat will be
9480 // filled in, so we can safely unwrap it here.
9481 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
9482 (20, inbound_capacity_msat, required),
9483 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
9484 (22, confirmations_required, option),
9485 (24, force_close_spend_delay, option),
9486 (26, is_outbound, required),
9487 (28, is_channel_ready, required),
9488 (30, is_usable, required),
9489 (32, is_public, required),
9490 (33, inbound_htlc_minimum_msat, option),
9491 (35, inbound_htlc_maximum_msat, option),
9492 (37, user_channel_id_high_opt, option),
9493 (39, feerate_sat_per_1000_weight, option),
9494 (41, channel_shutdown_state, option),
9497 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9498 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9499 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
9500 let user_channel_id = user_channel_id_low as u128 +
9501 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
9505 channel_id: channel_id.0.unwrap(),
9507 counterparty: counterparty.0.unwrap(),
9508 outbound_scid_alias,
9512 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
9513 unspendable_punishment_reserve,
9515 balance_msat: balance_msat.0.unwrap(),
9516 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
9517 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
9518 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
9519 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
9520 confirmations_required,
9522 force_close_spend_delay,
9523 is_outbound: is_outbound.0.unwrap(),
9524 is_channel_ready: is_channel_ready.0.unwrap(),
9525 is_usable: is_usable.0.unwrap(),
9526 is_public: is_public.0.unwrap(),
9527 inbound_htlc_minimum_msat,
9528 inbound_htlc_maximum_msat,
9529 feerate_sat_per_1000_weight,
9530 channel_shutdown_state,
9535 impl_writeable_tlv_based!(PhantomRouteHints, {
9536 (2, channels, required_vec),
9537 (4, phantom_scid, required),
9538 (6, real_node_pubkey, required),
9541 impl_writeable_tlv_based!(BlindedForward, {
9542 (0, inbound_blinding_point, required),
9543 (1, failure, (default_value, BlindedFailure::FromIntroductionNode)),
9546 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
9548 (0, onion_packet, required),
9549 (1, blinded, option),
9550 (2, short_channel_id, required),
9553 (0, payment_data, required),
9554 (1, phantom_shared_secret, option),
9555 (2, incoming_cltv_expiry, required),
9556 (3, payment_metadata, option),
9557 (5, custom_tlvs, optional_vec),
9558 (7, requires_blinded_error, (default_value, false)),
9560 (2, ReceiveKeysend) => {
9561 (0, payment_preimage, required),
9562 (2, incoming_cltv_expiry, required),
9563 (3, payment_metadata, option),
9564 (4, payment_data, option), // Added in 0.0.116
9565 (5, custom_tlvs, optional_vec),
9569 impl_writeable_tlv_based!(PendingHTLCInfo, {
9570 (0, routing, required),
9571 (2, incoming_shared_secret, required),
9572 (4, payment_hash, required),
9573 (6, outgoing_amt_msat, required),
9574 (8, outgoing_cltv_value, required),
9575 (9, incoming_amt_msat, option),
9576 (10, skimmed_fee_msat, option),
9580 impl Writeable for HTLCFailureMsg {
9581 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9583 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
9585 channel_id.write(writer)?;
9586 htlc_id.write(writer)?;
9587 reason.write(writer)?;
9589 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9590 channel_id, htlc_id, sha256_of_onion, failure_code
9593 channel_id.write(writer)?;
9594 htlc_id.write(writer)?;
9595 sha256_of_onion.write(writer)?;
9596 failure_code.write(writer)?;
9603 impl Readable for HTLCFailureMsg {
9604 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9605 let id: u8 = Readable::read(reader)?;
9608 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
9609 channel_id: Readable::read(reader)?,
9610 htlc_id: Readable::read(reader)?,
9611 reason: Readable::read(reader)?,
9615 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9616 channel_id: Readable::read(reader)?,
9617 htlc_id: Readable::read(reader)?,
9618 sha256_of_onion: Readable::read(reader)?,
9619 failure_code: Readable::read(reader)?,
9622 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
9623 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
9624 // messages contained in the variants.
9625 // In version 0.0.101, support for reading the variants with these types was added, and
9626 // we should migrate to writing these variants when UpdateFailHTLC or
9627 // UpdateFailMalformedHTLC get TLV fields.
9629 let length: BigSize = Readable::read(reader)?;
9630 let mut s = FixedLengthReader::new(reader, length.0);
9631 let res = Readable::read(&mut s)?;
9632 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9633 Ok(HTLCFailureMsg::Relay(res))
9636 let length: BigSize = Readable::read(reader)?;
9637 let mut s = FixedLengthReader::new(reader, length.0);
9638 let res = Readable::read(&mut s)?;
9639 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9640 Ok(HTLCFailureMsg::Malformed(res))
9642 _ => Err(DecodeError::UnknownRequiredFeature),
9647 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
9652 impl_writeable_tlv_based_enum!(BlindedFailure,
9653 (0, FromIntroductionNode) => {},
9654 (2, FromBlindedNode) => {}, ;
9657 impl_writeable_tlv_based!(HTLCPreviousHopData, {
9658 (0, short_channel_id, required),
9659 (1, phantom_shared_secret, option),
9660 (2, outpoint, required),
9661 (3, blinded_failure, option),
9662 (4, htlc_id, required),
9663 (6, incoming_packet_shared_secret, required),
9664 (7, user_channel_id, option),
9665 // Note that by the time we get past the required read for type 2 above, outpoint will be
9666 // filled in, so we can safely unwrap it here.
9667 (9, channel_id, (default_value, ChannelId::v1_from_funding_outpoint(outpoint.0.unwrap()))),
9670 impl Writeable for ClaimableHTLC {
9671 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9672 let (payment_data, keysend_preimage) = match &self.onion_payload {
9673 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
9674 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
9676 write_tlv_fields!(writer, {
9677 (0, self.prev_hop, required),
9678 (1, self.total_msat, required),
9679 (2, self.value, required),
9680 (3, self.sender_intended_value, required),
9681 (4, payment_data, option),
9682 (5, self.total_value_received, option),
9683 (6, self.cltv_expiry, required),
9684 (8, keysend_preimage, option),
9685 (10, self.counterparty_skimmed_fee_msat, option),
9691 impl Readable for ClaimableHTLC {
9692 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9693 _init_and_read_len_prefixed_tlv_fields!(reader, {
9694 (0, prev_hop, required),
9695 (1, total_msat, option),
9696 (2, value_ser, required),
9697 (3, sender_intended_value, option),
9698 (4, payment_data_opt, option),
9699 (5, total_value_received, option),
9700 (6, cltv_expiry, required),
9701 (8, keysend_preimage, option),
9702 (10, counterparty_skimmed_fee_msat, option),
9704 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
9705 let value = value_ser.0.unwrap();
9706 let onion_payload = match keysend_preimage {
9708 if payment_data.is_some() {
9709 return Err(DecodeError::InvalidValue)
9711 if total_msat.is_none() {
9712 total_msat = Some(value);
9714 OnionPayload::Spontaneous(p)
9717 if total_msat.is_none() {
9718 if payment_data.is_none() {
9719 return Err(DecodeError::InvalidValue)
9721 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
9723 OnionPayload::Invoice { _legacy_hop_data: payment_data }
9727 prev_hop: prev_hop.0.unwrap(),
9730 sender_intended_value: sender_intended_value.unwrap_or(value),
9731 total_value_received,
9732 total_msat: total_msat.unwrap(),
9734 cltv_expiry: cltv_expiry.0.unwrap(),
9735 counterparty_skimmed_fee_msat,
9740 impl Readable for HTLCSource {
9741 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9742 let id: u8 = Readable::read(reader)?;
9745 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
9746 let mut first_hop_htlc_msat: u64 = 0;
9747 let mut path_hops = Vec::new();
9748 let mut payment_id = None;
9749 let mut payment_params: Option<PaymentParameters> = None;
9750 let mut blinded_tail: Option<BlindedTail> = None;
9751 read_tlv_fields!(reader, {
9752 (0, session_priv, required),
9753 (1, payment_id, option),
9754 (2, first_hop_htlc_msat, required),
9755 (4, path_hops, required_vec),
9756 (5, payment_params, (option: ReadableArgs, 0)),
9757 (6, blinded_tail, option),
9759 if payment_id.is_none() {
9760 // For backwards compat, if there was no payment_id written, use the session_priv bytes
9762 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
9764 let path = Path { hops: path_hops, blinded_tail };
9765 if path.hops.len() == 0 {
9766 return Err(DecodeError::InvalidValue);
9768 if let Some(params) = payment_params.as_mut() {
9769 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
9770 if final_cltv_expiry_delta == &0 {
9771 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
9775 Ok(HTLCSource::OutboundRoute {
9776 session_priv: session_priv.0.unwrap(),
9777 first_hop_htlc_msat,
9779 payment_id: payment_id.unwrap(),
9782 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
9783 _ => Err(DecodeError::UnknownRequiredFeature),
9788 impl Writeable for HTLCSource {
9789 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
9791 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
9793 let payment_id_opt = Some(payment_id);
9794 write_tlv_fields!(writer, {
9795 (0, session_priv, required),
9796 (1, payment_id_opt, option),
9797 (2, first_hop_htlc_msat, required),
9798 // 3 was previously used to write a PaymentSecret for the payment.
9799 (4, path.hops, required_vec),
9800 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
9801 (6, path.blinded_tail, option),
9804 HTLCSource::PreviousHopData(ref field) => {
9806 field.write(writer)?;
9813 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
9814 (0, forward_info, required),
9815 (1, prev_user_channel_id, (default_value, 0)),
9816 (2, prev_short_channel_id, required),
9817 (4, prev_htlc_id, required),
9818 (6, prev_funding_outpoint, required),
9819 // Note that by the time we get past the required read for type 2 above, prev_funding_outpoint will be
9820 // filled in, so we can safely unwrap it here.
9821 (7, prev_channel_id, (default_value, ChannelId::v1_from_funding_outpoint(prev_funding_outpoint.0.unwrap()))),
9824 impl Writeable for HTLCForwardInfo {
9825 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9826 const FAIL_HTLC_VARIANT_ID: u8 = 1;
9828 Self::AddHTLC(info) => {
9832 Self::FailHTLC { htlc_id, err_packet } => {
9833 FAIL_HTLC_VARIANT_ID.write(w)?;
9834 write_tlv_fields!(w, {
9835 (0, htlc_id, required),
9836 (2, err_packet, required),
9839 Self::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
9840 // Since this variant was added in 0.0.119, write this as `::FailHTLC` with an empty error
9841 // packet so older versions have something to fail back with, but serialize the real data as
9842 // optional TLVs for the benefit of newer versions.
9843 FAIL_HTLC_VARIANT_ID.write(w)?;
9844 let dummy_err_packet = msgs::OnionErrorPacket { data: Vec::new() };
9845 write_tlv_fields!(w, {
9846 (0, htlc_id, required),
9847 (1, failure_code, required),
9848 (2, dummy_err_packet, required),
9849 (3, sha256_of_onion, required),
9857 impl Readable for HTLCForwardInfo {
9858 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
9859 let id: u8 = Readable::read(r)?;
9861 0 => Self::AddHTLC(Readable::read(r)?),
9863 _init_and_read_len_prefixed_tlv_fields!(r, {
9864 (0, htlc_id, required),
9865 (1, malformed_htlc_failure_code, option),
9866 (2, err_packet, required),
9867 (3, sha256_of_onion, option),
9869 if let Some(failure_code) = malformed_htlc_failure_code {
9870 Self::FailMalformedHTLC {
9871 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9873 sha256_of_onion: sha256_of_onion.ok_or(DecodeError::InvalidValue)?,
9877 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9878 err_packet: _init_tlv_based_struct_field!(err_packet, required),
9882 _ => return Err(DecodeError::InvalidValue),
9887 impl_writeable_tlv_based!(PendingInboundPayment, {
9888 (0, payment_secret, required),
9889 (2, expiry_time, required),
9890 (4, user_payment_id, required),
9891 (6, payment_preimage, required),
9892 (8, min_value_msat, required),
9895 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>
9897 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9898 T::Target: BroadcasterInterface,
9899 ES::Target: EntropySource,
9900 NS::Target: NodeSigner,
9901 SP::Target: SignerProvider,
9902 F::Target: FeeEstimator,
9906 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9907 let _consistency_lock = self.total_consistency_lock.write().unwrap();
9909 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
9911 self.chain_hash.write(writer)?;
9913 let best_block = self.best_block.read().unwrap();
9914 best_block.height().write(writer)?;
9915 best_block.block_hash().write(writer)?;
9918 let mut serializable_peer_count: u64 = 0;
9920 let per_peer_state = self.per_peer_state.read().unwrap();
9921 let mut number_of_funded_channels = 0;
9922 for (_, peer_state_mutex) in per_peer_state.iter() {
9923 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9924 let peer_state = &mut *peer_state_lock;
9925 if !peer_state.ok_to_remove(false) {
9926 serializable_peer_count += 1;
9929 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
9930 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_broadcast() } else { false }
9934 (number_of_funded_channels as u64).write(writer)?;
9936 for (_, peer_state_mutex) in per_peer_state.iter() {
9937 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9938 let peer_state = &mut *peer_state_lock;
9939 for channel in peer_state.channel_by_id.iter().filter_map(
9940 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
9941 if channel.context.is_funding_broadcast() { Some(channel) } else { None }
9944 channel.write(writer)?;
9950 let forward_htlcs = self.forward_htlcs.lock().unwrap();
9951 (forward_htlcs.len() as u64).write(writer)?;
9952 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
9953 short_channel_id.write(writer)?;
9954 (pending_forwards.len() as u64).write(writer)?;
9955 for forward in pending_forwards {
9956 forward.write(writer)?;
9961 let per_peer_state = self.per_peer_state.write().unwrap();
9963 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
9964 let claimable_payments = self.claimable_payments.lock().unwrap();
9965 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
9967 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
9968 let mut htlc_onion_fields: Vec<&_> = Vec::new();
9969 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
9970 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
9971 payment_hash.write(writer)?;
9972 (payment.htlcs.len() as u64).write(writer)?;
9973 for htlc in payment.htlcs.iter() {
9974 htlc.write(writer)?;
9976 htlc_purposes.push(&payment.purpose);
9977 htlc_onion_fields.push(&payment.onion_fields);
9980 let mut monitor_update_blocked_actions_per_peer = None;
9981 let mut peer_states = Vec::new();
9982 for (_, peer_state_mutex) in per_peer_state.iter() {
9983 // Because we're holding the owning `per_peer_state` write lock here there's no chance
9984 // of a lockorder violation deadlock - no other thread can be holding any
9985 // per_peer_state lock at all.
9986 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
9989 (serializable_peer_count).write(writer)?;
9990 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9991 // Peers which we have no channels to should be dropped once disconnected. As we
9992 // disconnect all peers when shutting down and serializing the ChannelManager, we
9993 // consider all peers as disconnected here. There's therefore no need write peers with
9995 if !peer_state.ok_to_remove(false) {
9996 peer_pubkey.write(writer)?;
9997 peer_state.latest_features.write(writer)?;
9998 if !peer_state.monitor_update_blocked_actions.is_empty() {
9999 monitor_update_blocked_actions_per_peer
10000 .get_or_insert_with(Vec::new)
10001 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
10006 let events = self.pending_events.lock().unwrap();
10007 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
10008 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
10009 // refuse to read the new ChannelManager.
10010 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
10011 if events_not_backwards_compatible {
10012 // If we're gonna write a even TLV that will overwrite our events anyway we might as
10013 // well save the space and not write any events here.
10014 0u64.write(writer)?;
10016 (events.len() as u64).write(writer)?;
10017 for (event, _) in events.iter() {
10018 event.write(writer)?;
10022 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
10023 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
10024 // the closing monitor updates were always effectively replayed on startup (either directly
10025 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
10026 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
10027 0u64.write(writer)?;
10029 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
10030 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
10031 // likely to be identical.
10032 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
10033 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
10035 (pending_inbound_payments.len() as u64).write(writer)?;
10036 for (hash, pending_payment) in pending_inbound_payments.iter() {
10037 hash.write(writer)?;
10038 pending_payment.write(writer)?;
10041 // For backwards compat, write the session privs and their total length.
10042 let mut num_pending_outbounds_compat: u64 = 0;
10043 for (_, outbound) in pending_outbound_payments.iter() {
10044 if !outbound.is_fulfilled() && !outbound.abandoned() {
10045 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
10048 num_pending_outbounds_compat.write(writer)?;
10049 for (_, outbound) in pending_outbound_payments.iter() {
10051 PendingOutboundPayment::Legacy { session_privs } |
10052 PendingOutboundPayment::Retryable { session_privs, .. } => {
10053 for session_priv in session_privs.iter() {
10054 session_priv.write(writer)?;
10057 PendingOutboundPayment::AwaitingInvoice { .. } => {},
10058 PendingOutboundPayment::InvoiceReceived { .. } => {},
10059 PendingOutboundPayment::Fulfilled { .. } => {},
10060 PendingOutboundPayment::Abandoned { .. } => {},
10064 // Encode without retry info for 0.0.101 compatibility.
10065 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
10066 for (id, outbound) in pending_outbound_payments.iter() {
10068 PendingOutboundPayment::Legacy { session_privs } |
10069 PendingOutboundPayment::Retryable { session_privs, .. } => {
10070 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
10076 let mut pending_intercepted_htlcs = None;
10077 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
10078 if our_pending_intercepts.len() != 0 {
10079 pending_intercepted_htlcs = Some(our_pending_intercepts);
10082 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
10083 if pending_claiming_payments.as_ref().unwrap().is_empty() {
10084 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
10085 // map. Thus, if there are no entries we skip writing a TLV for it.
10086 pending_claiming_payments = None;
10089 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
10090 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
10091 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
10092 if !updates.is_empty() {
10093 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
10094 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
10099 write_tlv_fields!(writer, {
10100 (1, pending_outbound_payments_no_retry, required),
10101 (2, pending_intercepted_htlcs, option),
10102 (3, pending_outbound_payments, required),
10103 (4, pending_claiming_payments, option),
10104 (5, self.our_network_pubkey, required),
10105 (6, monitor_update_blocked_actions_per_peer, option),
10106 (7, self.fake_scid_rand_bytes, required),
10107 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
10108 (9, htlc_purposes, required_vec),
10109 (10, in_flight_monitor_updates, option),
10110 (11, self.probing_cookie_secret, required),
10111 (13, htlc_onion_fields, optional_vec),
10118 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
10119 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
10120 (self.len() as u64).write(w)?;
10121 for (event, action) in self.iter() {
10124 #[cfg(debug_assertions)] {
10125 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
10126 // be persisted and are regenerated on restart. However, if such an event has a
10127 // post-event-handling action we'll write nothing for the event and would have to
10128 // either forget the action or fail on deserialization (which we do below). Thus,
10129 // check that the event is sane here.
10130 let event_encoded = event.encode();
10131 let event_read: Option<Event> =
10132 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
10133 if action.is_some() { assert!(event_read.is_some()); }
10139 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
10140 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
10141 let len: u64 = Readable::read(reader)?;
10142 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
10143 let mut events: Self = VecDeque::with_capacity(cmp::min(
10144 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
10147 let ev_opt = MaybeReadable::read(reader)?;
10148 let action = Readable::read(reader)?;
10149 if let Some(ev) = ev_opt {
10150 events.push_back((ev, action));
10151 } else if action.is_some() {
10152 return Err(DecodeError::InvalidValue);
10159 impl_writeable_tlv_based_enum!(ChannelShutdownState,
10160 (0, NotShuttingDown) => {},
10161 (2, ShutdownInitiated) => {},
10162 (4, ResolvingHTLCs) => {},
10163 (6, NegotiatingClosingFee) => {},
10164 (8, ShutdownComplete) => {}, ;
10167 /// Arguments for the creation of a ChannelManager that are not deserialized.
10169 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
10171 /// 1) Deserialize all stored [`ChannelMonitor`]s.
10172 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
10173 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
10174 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
10175 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
10176 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
10177 /// same way you would handle a [`chain::Filter`] call using
10178 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
10179 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
10180 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
10181 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
10182 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
10183 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
10185 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
10186 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
10188 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
10189 /// call any other methods on the newly-deserialized [`ChannelManager`].
10191 /// Note that because some channels may be closed during deserialization, it is critical that you
10192 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
10193 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
10194 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
10195 /// not force-close the same channels but consider them live), you may end up revoking a state for
10196 /// which you've already broadcasted the transaction.
10198 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
10199 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10201 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10202 T::Target: BroadcasterInterface,
10203 ES::Target: EntropySource,
10204 NS::Target: NodeSigner,
10205 SP::Target: SignerProvider,
10206 F::Target: FeeEstimator,
10210 /// A cryptographically secure source of entropy.
10211 pub entropy_source: ES,
10213 /// A signer that is able to perform node-scoped cryptographic operations.
10214 pub node_signer: NS,
10216 /// The keys provider which will give us relevant keys. Some keys will be loaded during
10217 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
10219 pub signer_provider: SP,
10221 /// The fee_estimator for use in the ChannelManager in the future.
10223 /// No calls to the FeeEstimator will be made during deserialization.
10224 pub fee_estimator: F,
10225 /// The chain::Watch for use in the ChannelManager in the future.
10227 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
10228 /// you have deserialized ChannelMonitors separately and will add them to your
10229 /// chain::Watch after deserializing this ChannelManager.
10230 pub chain_monitor: M,
10232 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
10233 /// used to broadcast the latest local commitment transactions of channels which must be
10234 /// force-closed during deserialization.
10235 pub tx_broadcaster: T,
10236 /// The router which will be used in the ChannelManager in the future for finding routes
10237 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
10239 /// No calls to the router will be made during deserialization.
10241 /// The Logger for use in the ChannelManager and which may be used to log information during
10242 /// deserialization.
10244 /// Default settings used for new channels. Any existing channels will continue to use the
10245 /// runtime settings which were stored when the ChannelManager was serialized.
10246 pub default_config: UserConfig,
10248 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
10249 /// value.context.get_funding_txo() should be the key).
10251 /// If a monitor is inconsistent with the channel state during deserialization the channel will
10252 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
10253 /// is true for missing channels as well. If there is a monitor missing for which we find
10254 /// channel data Err(DecodeError::InvalidValue) will be returned.
10256 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
10259 /// This is not exported to bindings users because we have no HashMap bindings
10260 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>,
10263 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10264 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
10266 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10267 T::Target: BroadcasterInterface,
10268 ES::Target: EntropySource,
10269 NS::Target: NodeSigner,
10270 SP::Target: SignerProvider,
10271 F::Target: FeeEstimator,
10275 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
10276 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
10277 /// populate a HashMap directly from C.
10278 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,
10279 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>) -> Self {
10281 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
10282 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
10287 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
10288 // SipmleArcChannelManager type:
10289 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10290 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
10292 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10293 T::Target: BroadcasterInterface,
10294 ES::Target: EntropySource,
10295 NS::Target: NodeSigner,
10296 SP::Target: SignerProvider,
10297 F::Target: FeeEstimator,
10301 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10302 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
10303 Ok((blockhash, Arc::new(chan_manager)))
10307 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10308 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
10310 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10311 T::Target: BroadcasterInterface,
10312 ES::Target: EntropySource,
10313 NS::Target: NodeSigner,
10314 SP::Target: SignerProvider,
10315 F::Target: FeeEstimator,
10319 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10320 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
10322 let chain_hash: ChainHash = Readable::read(reader)?;
10323 let best_block_height: u32 = Readable::read(reader)?;
10324 let best_block_hash: BlockHash = Readable::read(reader)?;
10326 let mut failed_htlcs = Vec::new();
10328 let channel_count: u64 = Readable::read(reader)?;
10329 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
10330 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10331 let mut outpoint_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10332 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10333 let mut channel_closures = VecDeque::new();
10334 let mut close_background_events = Vec::new();
10335 let mut funding_txo_to_channel_id = HashMap::with_capacity(channel_count as usize);
10336 for _ in 0..channel_count {
10337 let mut channel: Channel<SP> = Channel::read(reader, (
10338 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
10340 let logger = WithChannelContext::from(&args.logger, &channel.context);
10341 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10342 funding_txo_to_channel_id.insert(funding_txo, channel.context.channel_id());
10343 funding_txo_set.insert(funding_txo.clone());
10344 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
10345 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
10346 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
10347 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
10348 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10349 // But if the channel is behind of the monitor, close the channel:
10350 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
10351 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
10352 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10353 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
10354 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
10356 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
10357 log_error!(logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
10358 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
10360 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
10361 log_error!(logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
10362 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
10364 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
10365 log_error!(logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
10366 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
10368 let mut shutdown_result = channel.context.force_shutdown(true, ClosureReason::OutdatedChannelManager);
10369 if shutdown_result.unbroadcasted_batch_funding_txid.is_some() {
10370 return Err(DecodeError::InvalidValue);
10372 if let Some((counterparty_node_id, funding_txo, channel_id, update)) = shutdown_result.monitor_update {
10373 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10374 counterparty_node_id, funding_txo, channel_id, update
10377 failed_htlcs.append(&mut shutdown_result.dropped_outbound_htlcs);
10378 channel_closures.push_back((events::Event::ChannelClosed {
10379 channel_id: channel.context.channel_id(),
10380 user_channel_id: channel.context.get_user_id(),
10381 reason: ClosureReason::OutdatedChannelManager,
10382 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10383 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10384 channel_funding_txo: channel.context.get_funding_txo(),
10386 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
10387 let mut found_htlc = false;
10388 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
10389 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
10392 // If we have some HTLCs in the channel which are not present in the newer
10393 // ChannelMonitor, they have been removed and should be failed back to
10394 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
10395 // were actually claimed we'd have generated and ensured the previous-hop
10396 // claim update ChannelMonitor updates were persisted prior to persising
10397 // the ChannelMonitor update for the forward leg, so attempting to fail the
10398 // backwards leg of the HTLC will simply be rejected.
10400 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
10401 &channel.context.channel_id(), &payment_hash);
10402 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10406 log_info!(logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
10407 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
10408 monitor.get_latest_update_id());
10409 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
10410 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10412 if let Some(funding_txo) = channel.context.get_funding_txo() {
10413 outpoint_to_peer.insert(funding_txo, channel.context.get_counterparty_node_id());
10415 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
10416 hash_map::Entry::Occupied(mut entry) => {
10417 let by_id_map = entry.get_mut();
10418 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10420 hash_map::Entry::Vacant(entry) => {
10421 let mut by_id_map = HashMap::new();
10422 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10423 entry.insert(by_id_map);
10427 } else if channel.is_awaiting_initial_mon_persist() {
10428 // If we were persisted and shut down while the initial ChannelMonitor persistence
10429 // was in-progress, we never broadcasted the funding transaction and can still
10430 // safely discard the channel.
10431 let _ = channel.context.force_shutdown(false, ClosureReason::DisconnectedPeer);
10432 channel_closures.push_back((events::Event::ChannelClosed {
10433 channel_id: channel.context.channel_id(),
10434 user_channel_id: channel.context.get_user_id(),
10435 reason: ClosureReason::DisconnectedPeer,
10436 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10437 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10438 channel_funding_txo: channel.context.get_funding_txo(),
10441 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
10442 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10443 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10444 log_error!(logger, " Without the ChannelMonitor we cannot continue without risking funds.");
10445 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10446 return Err(DecodeError::InvalidValue);
10450 for (funding_txo, monitor) in args.channel_monitors.iter() {
10451 if !funding_txo_set.contains(funding_txo) {
10452 let logger = WithChannelMonitor::from(&args.logger, monitor);
10453 let channel_id = monitor.channel_id();
10454 log_info!(logger, "Queueing monitor update to ensure missing channel {} is force closed",
10456 let monitor_update = ChannelMonitorUpdate {
10457 update_id: CLOSED_CHANNEL_UPDATE_ID,
10458 counterparty_node_id: None,
10459 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
10460 channel_id: Some(monitor.channel_id()),
10462 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, channel_id, monitor_update)));
10466 const MAX_ALLOC_SIZE: usize = 1024 * 64;
10467 let forward_htlcs_count: u64 = Readable::read(reader)?;
10468 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
10469 for _ in 0..forward_htlcs_count {
10470 let short_channel_id = Readable::read(reader)?;
10471 let pending_forwards_count: u64 = Readable::read(reader)?;
10472 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
10473 for _ in 0..pending_forwards_count {
10474 pending_forwards.push(Readable::read(reader)?);
10476 forward_htlcs.insert(short_channel_id, pending_forwards);
10479 let claimable_htlcs_count: u64 = Readable::read(reader)?;
10480 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
10481 for _ in 0..claimable_htlcs_count {
10482 let payment_hash = Readable::read(reader)?;
10483 let previous_hops_len: u64 = Readable::read(reader)?;
10484 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
10485 for _ in 0..previous_hops_len {
10486 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
10488 claimable_htlcs_list.push((payment_hash, previous_hops));
10491 let peer_state_from_chans = |channel_by_id| {
10494 inbound_channel_request_by_id: HashMap::new(),
10495 latest_features: InitFeatures::empty(),
10496 pending_msg_events: Vec::new(),
10497 in_flight_monitor_updates: BTreeMap::new(),
10498 monitor_update_blocked_actions: BTreeMap::new(),
10499 actions_blocking_raa_monitor_updates: BTreeMap::new(),
10500 is_connected: false,
10504 let peer_count: u64 = Readable::read(reader)?;
10505 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
10506 for _ in 0..peer_count {
10507 let peer_pubkey = Readable::read(reader)?;
10508 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
10509 let mut peer_state = peer_state_from_chans(peer_chans);
10510 peer_state.latest_features = Readable::read(reader)?;
10511 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
10514 let event_count: u64 = Readable::read(reader)?;
10515 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
10516 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
10517 for _ in 0..event_count {
10518 match MaybeReadable::read(reader)? {
10519 Some(event) => pending_events_read.push_back((event, None)),
10524 let background_event_count: u64 = Readable::read(reader)?;
10525 for _ in 0..background_event_count {
10526 match <u8 as Readable>::read(reader)? {
10528 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
10529 // however we really don't (and never did) need them - we regenerate all
10530 // on-startup monitor updates.
10531 let _: OutPoint = Readable::read(reader)?;
10532 let _: ChannelMonitorUpdate = Readable::read(reader)?;
10534 _ => return Err(DecodeError::InvalidValue),
10538 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
10539 let highest_seen_timestamp: u32 = Readable::read(reader)?;
10541 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
10542 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
10543 for _ in 0..pending_inbound_payment_count {
10544 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
10545 return Err(DecodeError::InvalidValue);
10549 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
10550 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
10551 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
10552 for _ in 0..pending_outbound_payments_count_compat {
10553 let session_priv = Readable::read(reader)?;
10554 let payment = PendingOutboundPayment::Legacy {
10555 session_privs: [session_priv].iter().cloned().collect()
10557 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
10558 return Err(DecodeError::InvalidValue)
10562 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
10563 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
10564 let mut pending_outbound_payments = None;
10565 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
10566 let mut received_network_pubkey: Option<PublicKey> = None;
10567 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
10568 let mut probing_cookie_secret: Option<[u8; 32]> = None;
10569 let mut claimable_htlc_purposes = None;
10570 let mut claimable_htlc_onion_fields = None;
10571 let mut pending_claiming_payments = Some(HashMap::new());
10572 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
10573 let mut events_override = None;
10574 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
10575 read_tlv_fields!(reader, {
10576 (1, pending_outbound_payments_no_retry, option),
10577 (2, pending_intercepted_htlcs, option),
10578 (3, pending_outbound_payments, option),
10579 (4, pending_claiming_payments, option),
10580 (5, received_network_pubkey, option),
10581 (6, monitor_update_blocked_actions_per_peer, option),
10582 (7, fake_scid_rand_bytes, option),
10583 (8, events_override, option),
10584 (9, claimable_htlc_purposes, optional_vec),
10585 (10, in_flight_monitor_updates, option),
10586 (11, probing_cookie_secret, option),
10587 (13, claimable_htlc_onion_fields, optional_vec),
10589 if fake_scid_rand_bytes.is_none() {
10590 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
10593 if probing_cookie_secret.is_none() {
10594 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
10597 if let Some(events) = events_override {
10598 pending_events_read = events;
10601 if !channel_closures.is_empty() {
10602 pending_events_read.append(&mut channel_closures);
10605 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
10606 pending_outbound_payments = Some(pending_outbound_payments_compat);
10607 } else if pending_outbound_payments.is_none() {
10608 let mut outbounds = HashMap::new();
10609 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
10610 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
10612 pending_outbound_payments = Some(outbounds);
10614 let pending_outbounds = OutboundPayments {
10615 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
10616 retry_lock: Mutex::new(())
10619 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
10620 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
10621 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
10622 // replayed, and for each monitor update we have to replay we have to ensure there's a
10623 // `ChannelMonitor` for it.
10625 // In order to do so we first walk all of our live channels (so that we can check their
10626 // state immediately after doing the update replays, when we have the `update_id`s
10627 // available) and then walk any remaining in-flight updates.
10629 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
10630 let mut pending_background_events = Vec::new();
10631 macro_rules! handle_in_flight_updates {
10632 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
10633 $monitor: expr, $peer_state: expr, $logger: expr, $channel_info_log: expr
10635 let mut max_in_flight_update_id = 0;
10636 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
10637 for update in $chan_in_flight_upds.iter() {
10638 log_trace!($logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
10639 update.update_id, $channel_info_log, &$monitor.channel_id());
10640 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
10641 pending_background_events.push(
10642 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10643 counterparty_node_id: $counterparty_node_id,
10644 funding_txo: $funding_txo,
10645 channel_id: $monitor.channel_id(),
10646 update: update.clone(),
10649 if $chan_in_flight_upds.is_empty() {
10650 // We had some updates to apply, but it turns out they had completed before we
10651 // were serialized, we just weren't notified of that. Thus, we may have to run
10652 // the completion actions for any monitor updates, but otherwise are done.
10653 pending_background_events.push(
10654 BackgroundEvent::MonitorUpdatesComplete {
10655 counterparty_node_id: $counterparty_node_id,
10656 channel_id: $monitor.channel_id(),
10659 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
10660 log_error!($logger, "Duplicate in-flight monitor update set for the same channel!");
10661 return Err(DecodeError::InvalidValue);
10663 max_in_flight_update_id
10667 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
10668 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
10669 let peer_state = &mut *peer_state_lock;
10670 for phase in peer_state.channel_by_id.values() {
10671 if let ChannelPhase::Funded(chan) = phase {
10672 let logger = WithChannelContext::from(&args.logger, &chan.context);
10674 // Channels that were persisted have to be funded, otherwise they should have been
10676 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10677 let monitor = args.channel_monitors.get(&funding_txo)
10678 .expect("We already checked for monitor presence when loading channels");
10679 let mut max_in_flight_update_id = monitor.get_latest_update_id();
10680 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
10681 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
10682 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
10683 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
10684 funding_txo, monitor, peer_state, logger, ""));
10687 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
10688 // If the channel is ahead of the monitor, return InvalidValue:
10689 log_error!(logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
10690 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
10691 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
10692 log_error!(logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
10693 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10694 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10695 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10696 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10697 return Err(DecodeError::InvalidValue);
10700 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10701 // created in this `channel_by_id` map.
10702 debug_assert!(false);
10703 return Err(DecodeError::InvalidValue);
10708 if let Some(in_flight_upds) = in_flight_monitor_updates {
10709 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
10710 let channel_id = funding_txo_to_channel_id.get(&funding_txo).copied();
10711 let logger = WithContext::from(&args.logger, Some(counterparty_id), channel_id);
10712 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
10713 // Now that we've removed all the in-flight monitor updates for channels that are
10714 // still open, we need to replay any monitor updates that are for closed channels,
10715 // creating the neccessary peer_state entries as we go.
10716 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
10717 Mutex::new(peer_state_from_chans(HashMap::new()))
10719 let mut peer_state = peer_state_mutex.lock().unwrap();
10720 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
10721 funding_txo, monitor, peer_state, logger, "closed ");
10723 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!");
10724 log_error!(logger, " The ChannelMonitor for channel {} is missing.", if let Some(channel_id) =
10725 channel_id { channel_id.to_string() } else { format!("with outpoint {}", funding_txo) } );
10726 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10727 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10728 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10729 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10730 return Err(DecodeError::InvalidValue);
10735 // Note that we have to do the above replays before we push new monitor updates.
10736 pending_background_events.append(&mut close_background_events);
10738 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
10739 // should ensure we try them again on the inbound edge. We put them here and do so after we
10740 // have a fully-constructed `ChannelManager` at the end.
10741 let mut pending_claims_to_replay = Vec::new();
10744 // If we're tracking pending payments, ensure we haven't lost any by looking at the
10745 // ChannelMonitor data for any channels for which we do not have authorative state
10746 // (i.e. those for which we just force-closed above or we otherwise don't have a
10747 // corresponding `Channel` at all).
10748 // This avoids several edge-cases where we would otherwise "forget" about pending
10749 // payments which are still in-flight via their on-chain state.
10750 // We only rebuild the pending payments map if we were most recently serialized by
10752 for (_, monitor) in args.channel_monitors.iter() {
10753 let counterparty_opt = outpoint_to_peer.get(&monitor.get_funding_txo().0);
10754 if counterparty_opt.is_none() {
10755 let logger = WithChannelMonitor::from(&args.logger, monitor);
10756 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
10757 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
10758 if path.hops.is_empty() {
10759 log_error!(logger, "Got an empty path for a pending payment");
10760 return Err(DecodeError::InvalidValue);
10763 let path_amt = path.final_value_msat();
10764 let mut session_priv_bytes = [0; 32];
10765 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
10766 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
10767 hash_map::Entry::Occupied(mut entry) => {
10768 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
10769 log_info!(logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
10770 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), htlc.payment_hash);
10772 hash_map::Entry::Vacant(entry) => {
10773 let path_fee = path.fee_msat();
10774 entry.insert(PendingOutboundPayment::Retryable {
10775 retry_strategy: None,
10776 attempts: PaymentAttempts::new(),
10777 payment_params: None,
10778 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
10779 payment_hash: htlc.payment_hash,
10780 payment_secret: None, // only used for retries, and we'll never retry on startup
10781 payment_metadata: None, // only used for retries, and we'll never retry on startup
10782 keysend_preimage: None, // only used for retries, and we'll never retry on startup
10783 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
10784 pending_amt_msat: path_amt,
10785 pending_fee_msat: Some(path_fee),
10786 total_msat: path_amt,
10787 starting_block_height: best_block_height,
10788 remaining_max_total_routing_fee_msat: None, // only used for retries, and we'll never retry on startup
10790 log_info!(logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
10791 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
10796 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
10797 match htlc_source {
10798 HTLCSource::PreviousHopData(prev_hop_data) => {
10799 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
10800 info.prev_funding_outpoint == prev_hop_data.outpoint &&
10801 info.prev_htlc_id == prev_hop_data.htlc_id
10803 // The ChannelMonitor is now responsible for this HTLC's
10804 // failure/success and will let us know what its outcome is. If we
10805 // still have an entry for this HTLC in `forward_htlcs` or
10806 // `pending_intercepted_htlcs`, we were apparently not persisted after
10807 // the monitor was when forwarding the payment.
10808 forward_htlcs.retain(|_, forwards| {
10809 forwards.retain(|forward| {
10810 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
10811 if pending_forward_matches_htlc(&htlc_info) {
10812 log_info!(logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
10813 &htlc.payment_hash, &monitor.channel_id());
10818 !forwards.is_empty()
10820 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
10821 if pending_forward_matches_htlc(&htlc_info) {
10822 log_info!(logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
10823 &htlc.payment_hash, &monitor.channel_id());
10824 pending_events_read.retain(|(event, _)| {
10825 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
10826 intercepted_id != ev_id
10833 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
10834 if let Some(preimage) = preimage_opt {
10835 let pending_events = Mutex::new(pending_events_read);
10836 // Note that we set `from_onchain` to "false" here,
10837 // deliberately keeping the pending payment around forever.
10838 // Given it should only occur when we have a channel we're
10839 // force-closing for being stale that's okay.
10840 // The alternative would be to wipe the state when claiming,
10841 // generating a `PaymentPathSuccessful` event but regenerating
10842 // it and the `PaymentSent` on every restart until the
10843 // `ChannelMonitor` is removed.
10845 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
10846 channel_funding_outpoint: monitor.get_funding_txo().0,
10847 channel_id: monitor.channel_id(),
10848 counterparty_node_id: path.hops[0].pubkey,
10850 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
10851 path, false, compl_action, &pending_events, &&logger);
10852 pending_events_read = pending_events.into_inner().unwrap();
10859 // Whether the downstream channel was closed or not, try to re-apply any payment
10860 // preimages from it which may be needed in upstream channels for forwarded
10862 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
10864 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
10865 if let HTLCSource::PreviousHopData(_) = htlc_source {
10866 if let Some(payment_preimage) = preimage_opt {
10867 Some((htlc_source, payment_preimage, htlc.amount_msat,
10868 // Check if `counterparty_opt.is_none()` to see if the
10869 // downstream chan is closed (because we don't have a
10870 // channel_id -> peer map entry).
10871 counterparty_opt.is_none(),
10872 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
10873 monitor.get_funding_txo().0, monitor.channel_id()))
10876 // If it was an outbound payment, we've handled it above - if a preimage
10877 // came in and we persisted the `ChannelManager` we either handled it and
10878 // are good to go or the channel force-closed - we don't have to handle the
10879 // channel still live case here.
10883 for tuple in outbound_claimed_htlcs_iter {
10884 pending_claims_to_replay.push(tuple);
10889 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
10890 // If we have pending HTLCs to forward, assume we either dropped a
10891 // `PendingHTLCsForwardable` or the user received it but never processed it as they
10892 // shut down before the timer hit. Either way, set the time_forwardable to a small
10893 // constant as enough time has likely passed that we should simply handle the forwards
10894 // now, or at least after the user gets a chance to reconnect to our peers.
10895 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
10896 time_forwardable: Duration::from_secs(2),
10900 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
10901 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
10903 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
10904 if let Some(purposes) = claimable_htlc_purposes {
10905 if purposes.len() != claimable_htlcs_list.len() {
10906 return Err(DecodeError::InvalidValue);
10908 if let Some(onion_fields) = claimable_htlc_onion_fields {
10909 if onion_fields.len() != claimable_htlcs_list.len() {
10910 return Err(DecodeError::InvalidValue);
10912 for (purpose, (onion, (payment_hash, htlcs))) in
10913 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
10915 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10916 purpose, htlcs, onion_fields: onion,
10918 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10921 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
10922 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10923 purpose, htlcs, onion_fields: None,
10925 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10929 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
10930 // include a `_legacy_hop_data` in the `OnionPayload`.
10931 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
10932 if htlcs.is_empty() {
10933 return Err(DecodeError::InvalidValue);
10935 let purpose = match &htlcs[0].onion_payload {
10936 OnionPayload::Invoice { _legacy_hop_data } => {
10937 if let Some(hop_data) = _legacy_hop_data {
10938 events::PaymentPurpose::InvoicePayment {
10939 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
10940 Some(inbound_payment) => inbound_payment.payment_preimage,
10941 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
10942 Ok((payment_preimage, _)) => payment_preimage,
10944 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);
10945 return Err(DecodeError::InvalidValue);
10949 payment_secret: hop_data.payment_secret,
10951 } else { return Err(DecodeError::InvalidValue); }
10953 OnionPayload::Spontaneous(payment_preimage) =>
10954 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
10956 claimable_payments.insert(payment_hash, ClaimablePayment {
10957 purpose, htlcs, onion_fields: None,
10962 let mut secp_ctx = Secp256k1::new();
10963 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
10965 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
10967 Err(()) => return Err(DecodeError::InvalidValue)
10969 if let Some(network_pubkey) = received_network_pubkey {
10970 if network_pubkey != our_network_pubkey {
10971 log_error!(args.logger, "Key that was generated does not match the existing key.");
10972 return Err(DecodeError::InvalidValue);
10976 let mut outbound_scid_aliases = HashSet::new();
10977 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
10978 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
10979 let peer_state = &mut *peer_state_lock;
10980 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
10981 if let ChannelPhase::Funded(chan) = phase {
10982 let logger = WithChannelContext::from(&args.logger, &chan.context);
10983 if chan.context.outbound_scid_alias() == 0 {
10984 let mut outbound_scid_alias;
10986 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
10987 .get_fake_scid(best_block_height, &chain_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
10988 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
10990 chan.context.set_outbound_scid_alias(outbound_scid_alias);
10991 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
10992 // Note that in rare cases its possible to hit this while reading an older
10993 // channel if we just happened to pick a colliding outbound alias above.
10994 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
10995 return Err(DecodeError::InvalidValue);
10997 if chan.context.is_usable() {
10998 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
10999 // Note that in rare cases its possible to hit this while reading an older
11000 // channel if we just happened to pick a colliding outbound alias above.
11001 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
11002 return Err(DecodeError::InvalidValue);
11006 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
11007 // created in this `channel_by_id` map.
11008 debug_assert!(false);
11009 return Err(DecodeError::InvalidValue);
11014 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
11016 for (_, monitor) in args.channel_monitors.iter() {
11017 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
11018 if let Some(payment) = claimable_payments.remove(&payment_hash) {
11019 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
11020 let mut claimable_amt_msat = 0;
11021 let mut receiver_node_id = Some(our_network_pubkey);
11022 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
11023 if phantom_shared_secret.is_some() {
11024 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
11025 .expect("Failed to get node_id for phantom node recipient");
11026 receiver_node_id = Some(phantom_pubkey)
11028 for claimable_htlc in &payment.htlcs {
11029 claimable_amt_msat += claimable_htlc.value;
11031 // Add a holding-cell claim of the payment to the Channel, which should be
11032 // applied ~immediately on peer reconnection. Because it won't generate a
11033 // new commitment transaction we can just provide the payment preimage to
11034 // the corresponding ChannelMonitor and nothing else.
11036 // We do so directly instead of via the normal ChannelMonitor update
11037 // procedure as the ChainMonitor hasn't yet been initialized, implying
11038 // we're not allowed to call it directly yet. Further, we do the update
11039 // without incrementing the ChannelMonitor update ID as there isn't any
11041 // If we were to generate a new ChannelMonitor update ID here and then
11042 // crash before the user finishes block connect we'd end up force-closing
11043 // this channel as well. On the flip side, there's no harm in restarting
11044 // without the new monitor persisted - we'll end up right back here on
11046 let previous_channel_id = claimable_htlc.prev_hop.channel_id;
11047 if let Some(peer_node_id) = outpoint_to_peer.get(&claimable_htlc.prev_hop.outpoint) {
11048 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
11049 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
11050 let peer_state = &mut *peer_state_lock;
11051 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
11052 let logger = WithChannelContext::from(&args.logger, &channel.context);
11053 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &&logger);
11056 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
11057 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
11060 pending_events_read.push_back((events::Event::PaymentClaimed {
11063 purpose: payment.purpose,
11064 amount_msat: claimable_amt_msat,
11065 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
11066 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
11072 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
11073 if let Some(peer_state) = per_peer_state.get(&node_id) {
11074 for (channel_id, actions) in monitor_update_blocked_actions.iter() {
11075 let logger = WithContext::from(&args.logger, Some(node_id), Some(*channel_id));
11076 for action in actions.iter() {
11077 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
11078 downstream_counterparty_and_funding_outpoint:
11079 Some((blocked_node_id, _blocked_channel_outpoint, blocked_channel_id, blocking_action)), ..
11081 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
11082 let channel_id = blocked_channel_id;
11084 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
11086 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
11087 .entry(*channel_id)
11088 .or_insert_with(Vec::new).push(blocking_action.clone());
11090 // If the channel we were blocking has closed, we don't need to
11091 // worry about it - the blocked monitor update should never have
11092 // been released from the `Channel` object so it can't have
11093 // completed, and if the channel closed there's no reason to bother
11097 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately { .. } = action {
11098 debug_assert!(false, "Non-event-generating channel freeing should not appear in our queue");
11102 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
11104 log_error!(WithContext::from(&args.logger, Some(node_id), None), "Got blocked actions without a per-peer-state for {}", node_id);
11105 return Err(DecodeError::InvalidValue);
11109 let channel_manager = ChannelManager {
11111 fee_estimator: bounded_fee_estimator,
11112 chain_monitor: args.chain_monitor,
11113 tx_broadcaster: args.tx_broadcaster,
11114 router: args.router,
11116 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
11118 inbound_payment_key: expanded_inbound_key,
11119 pending_inbound_payments: Mutex::new(pending_inbound_payments),
11120 pending_outbound_payments: pending_outbounds,
11121 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
11123 forward_htlcs: Mutex::new(forward_htlcs),
11124 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
11125 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
11126 outpoint_to_peer: Mutex::new(outpoint_to_peer),
11127 short_to_chan_info: FairRwLock::new(short_to_chan_info),
11128 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
11130 probing_cookie_secret: probing_cookie_secret.unwrap(),
11132 our_network_pubkey,
11135 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
11137 per_peer_state: FairRwLock::new(per_peer_state),
11139 pending_events: Mutex::new(pending_events_read),
11140 pending_events_processor: AtomicBool::new(false),
11141 pending_background_events: Mutex::new(pending_background_events),
11142 total_consistency_lock: RwLock::new(()),
11143 background_events_processed_since_startup: AtomicBool::new(false),
11145 event_persist_notifier: Notifier::new(),
11146 needs_persist_flag: AtomicBool::new(false),
11148 funding_batch_states: Mutex::new(BTreeMap::new()),
11150 pending_offers_messages: Mutex::new(Vec::new()),
11152 entropy_source: args.entropy_source,
11153 node_signer: args.node_signer,
11154 signer_provider: args.signer_provider,
11156 logger: args.logger,
11157 default_configuration: args.default_config,
11160 for htlc_source in failed_htlcs.drain(..) {
11161 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
11162 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
11163 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
11164 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
11167 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding, downstream_channel_id) in pending_claims_to_replay {
11168 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
11169 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
11170 // channel is closed we just assume that it probably came from an on-chain claim.
11171 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
11172 downstream_closed, true, downstream_node_id, downstream_funding, downstream_channel_id);
11175 //TODO: Broadcast channel update for closed channels, but only after we've made a
11176 //connection or two.
11178 Ok((best_block_hash.clone(), channel_manager))
11184 use bitcoin::hashes::Hash;
11185 use bitcoin::hashes::sha256::Hash as Sha256;
11186 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
11187 use core::sync::atomic::Ordering;
11188 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
11189 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
11190 use crate::ln::ChannelId;
11191 use crate::ln::channelmanager::{create_recv_pending_htlc_info, HTLCForwardInfo, inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
11192 use crate::ln::functional_test_utils::*;
11193 use crate::ln::msgs::{self, ErrorAction};
11194 use crate::ln::msgs::ChannelMessageHandler;
11195 use crate::prelude::*;
11196 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
11197 use crate::util::errors::APIError;
11198 use crate::util::ser::Writeable;
11199 use crate::util::test_utils;
11200 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
11201 use crate::sign::EntropySource;
11204 fn test_notify_limits() {
11205 // Check that a few cases which don't require the persistence of a new ChannelManager,
11206 // indeed, do not cause the persistence of a new ChannelManager.
11207 let chanmon_cfgs = create_chanmon_cfgs(3);
11208 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
11209 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
11210 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
11212 // All nodes start with a persistable update pending as `create_network` connects each node
11213 // with all other nodes to make most tests simpler.
11214 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11215 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11216 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11218 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11220 // We check that the channel info nodes have doesn't change too early, even though we try
11221 // to connect messages with new values
11222 chan.0.contents.fee_base_msat *= 2;
11223 chan.1.contents.fee_base_msat *= 2;
11224 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
11225 &nodes[1].node.get_our_node_id()).pop().unwrap();
11226 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
11227 &nodes[0].node.get_our_node_id()).pop().unwrap();
11229 // The first two nodes (which opened a channel) should now require fresh persistence
11230 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11231 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11232 // ... but the last node should not.
11233 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11234 // After persisting the first two nodes they should no longer need fresh persistence.
11235 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11236 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11238 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
11239 // about the channel.
11240 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
11241 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
11242 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11244 // The nodes which are a party to the channel should also ignore messages from unrelated
11246 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11247 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11248 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11249 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11250 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11251 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11253 // At this point the channel info given by peers should still be the same.
11254 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11255 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11257 // An earlier version of handle_channel_update didn't check the directionality of the
11258 // update message and would always update the local fee info, even if our peer was
11259 // (spuriously) forwarding us our own channel_update.
11260 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
11261 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
11262 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
11264 // First deliver each peers' own message, checking that the node doesn't need to be
11265 // persisted and that its channel info remains the same.
11266 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
11267 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
11268 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11269 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11270 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11271 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11273 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
11274 // the channel info has updated.
11275 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
11276 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
11277 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11278 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11279 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
11280 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
11284 fn test_keysend_dup_hash_partial_mpp() {
11285 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
11287 let chanmon_cfgs = create_chanmon_cfgs(2);
11288 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11289 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11290 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11291 create_announced_chan_between_nodes(&nodes, 0, 1);
11293 // First, send a partial MPP payment.
11294 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
11295 let mut mpp_route = route.clone();
11296 mpp_route.paths.push(mpp_route.paths[0].clone());
11298 let payment_id = PaymentId([42; 32]);
11299 // Use the utility function send_payment_along_path to send the payment with MPP data which
11300 // indicates there are more HTLCs coming.
11301 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.
11302 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
11303 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
11304 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
11305 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
11306 check_added_monitors!(nodes[0], 1);
11307 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11308 assert_eq!(events.len(), 1);
11309 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
11311 // Next, send a keysend payment with the same payment_hash and make sure it fails.
11312 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11313 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11314 check_added_monitors!(nodes[0], 1);
11315 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11316 assert_eq!(events.len(), 1);
11317 let ev = events.drain(..).next().unwrap();
11318 let payment_event = SendEvent::from_event(ev);
11319 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11320 check_added_monitors!(nodes[1], 0);
11321 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11322 expect_pending_htlcs_forwardable!(nodes[1]);
11323 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
11324 check_added_monitors!(nodes[1], 1);
11325 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11326 assert!(updates.update_add_htlcs.is_empty());
11327 assert!(updates.update_fulfill_htlcs.is_empty());
11328 assert_eq!(updates.update_fail_htlcs.len(), 1);
11329 assert!(updates.update_fail_malformed_htlcs.is_empty());
11330 assert!(updates.update_fee.is_none());
11331 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11332 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11333 expect_payment_failed!(nodes[0], our_payment_hash, true);
11335 // Send the second half of the original MPP payment.
11336 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
11337 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
11338 check_added_monitors!(nodes[0], 1);
11339 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11340 assert_eq!(events.len(), 1);
11341 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
11343 // Claim the full MPP payment. Note that we can't use a test utility like
11344 // claim_funds_along_route because the ordering of the messages causes the second half of the
11345 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
11346 // lightning messages manually.
11347 nodes[1].node.claim_funds(payment_preimage);
11348 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
11349 check_added_monitors!(nodes[1], 2);
11351 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11352 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
11353 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
11354 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
11355 check_added_monitors!(nodes[0], 1);
11356 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11357 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
11358 check_added_monitors!(nodes[1], 1);
11359 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11360 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
11361 check_added_monitors!(nodes[1], 1);
11362 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11363 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
11364 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
11365 check_added_monitors!(nodes[0], 1);
11366 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
11367 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
11368 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11369 check_added_monitors!(nodes[0], 1);
11370 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
11371 check_added_monitors!(nodes[1], 1);
11372 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
11373 check_added_monitors!(nodes[1], 1);
11374 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11375 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
11376 check_added_monitors!(nodes[0], 1);
11378 // Note that successful MPP payments will generate a single PaymentSent event upon the first
11379 // path's success and a PaymentPathSuccessful event for each path's success.
11380 let events = nodes[0].node.get_and_clear_pending_events();
11381 assert_eq!(events.len(), 2);
11383 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11384 assert_eq!(payment_id, *actual_payment_id);
11385 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11386 assert_eq!(route.paths[0], *path);
11388 _ => panic!("Unexpected event"),
11391 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11392 assert_eq!(payment_id, *actual_payment_id);
11393 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11394 assert_eq!(route.paths[0], *path);
11396 _ => panic!("Unexpected event"),
11401 fn test_keysend_dup_payment_hash() {
11402 do_test_keysend_dup_payment_hash(false);
11403 do_test_keysend_dup_payment_hash(true);
11406 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
11407 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
11408 // outbound regular payment fails as expected.
11409 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
11410 // fails as expected.
11411 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
11412 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
11413 // reject MPP keysend payments, since in this case where the payment has no payment
11414 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
11415 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
11416 // payment secrets and reject otherwise.
11417 let chanmon_cfgs = create_chanmon_cfgs(2);
11418 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11419 let mut mpp_keysend_cfg = test_default_channel_config();
11420 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
11421 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
11422 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11423 create_announced_chan_between_nodes(&nodes, 0, 1);
11424 let scorer = test_utils::TestScorer::new();
11425 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11427 // To start (1), send a regular payment but don't claim it.
11428 let expected_route = [&nodes[1]];
11429 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
11431 // Next, attempt a keysend payment and make sure it fails.
11432 let route_params = RouteParameters::from_payment_params_and_value(
11433 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
11434 TEST_FINAL_CLTV, false), 100_000);
11435 let route = find_route(
11436 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11437 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11439 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11440 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11441 check_added_monitors!(nodes[0], 1);
11442 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11443 assert_eq!(events.len(), 1);
11444 let ev = events.drain(..).next().unwrap();
11445 let payment_event = SendEvent::from_event(ev);
11446 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11447 check_added_monitors!(nodes[1], 0);
11448 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11449 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
11450 // fails), the second will process the resulting failure and fail the HTLC backward
11451 expect_pending_htlcs_forwardable!(nodes[1]);
11452 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11453 check_added_monitors!(nodes[1], 1);
11454 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11455 assert!(updates.update_add_htlcs.is_empty());
11456 assert!(updates.update_fulfill_htlcs.is_empty());
11457 assert_eq!(updates.update_fail_htlcs.len(), 1);
11458 assert!(updates.update_fail_malformed_htlcs.is_empty());
11459 assert!(updates.update_fee.is_none());
11460 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11461 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11462 expect_payment_failed!(nodes[0], payment_hash, true);
11464 // Finally, claim the original payment.
11465 claim_payment(&nodes[0], &expected_route, payment_preimage);
11467 // To start (2), send a keysend payment but don't claim it.
11468 let payment_preimage = PaymentPreimage([42; 32]);
11469 let route = find_route(
11470 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11471 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11473 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11474 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11475 check_added_monitors!(nodes[0], 1);
11476 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11477 assert_eq!(events.len(), 1);
11478 let event = events.pop().unwrap();
11479 let path = vec![&nodes[1]];
11480 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11482 // Next, attempt a regular payment and make sure it fails.
11483 let payment_secret = PaymentSecret([43; 32]);
11484 nodes[0].node.send_payment_with_route(&route, payment_hash,
11485 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
11486 check_added_monitors!(nodes[0], 1);
11487 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11488 assert_eq!(events.len(), 1);
11489 let ev = events.drain(..).next().unwrap();
11490 let payment_event = SendEvent::from_event(ev);
11491 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11492 check_added_monitors!(nodes[1], 0);
11493 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11494 expect_pending_htlcs_forwardable!(nodes[1]);
11495 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11496 check_added_monitors!(nodes[1], 1);
11497 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11498 assert!(updates.update_add_htlcs.is_empty());
11499 assert!(updates.update_fulfill_htlcs.is_empty());
11500 assert_eq!(updates.update_fail_htlcs.len(), 1);
11501 assert!(updates.update_fail_malformed_htlcs.is_empty());
11502 assert!(updates.update_fee.is_none());
11503 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11504 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11505 expect_payment_failed!(nodes[0], payment_hash, true);
11507 // Finally, succeed the keysend payment.
11508 claim_payment(&nodes[0], &expected_route, payment_preimage);
11510 // To start (3), send a keysend payment but don't claim it.
11511 let payment_id_1 = PaymentId([44; 32]);
11512 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11513 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
11514 check_added_monitors!(nodes[0], 1);
11515 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11516 assert_eq!(events.len(), 1);
11517 let event = events.pop().unwrap();
11518 let path = vec![&nodes[1]];
11519 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11521 // Next, attempt a keysend payment and make sure it fails.
11522 let route_params = RouteParameters::from_payment_params_and_value(
11523 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
11526 let route = find_route(
11527 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11528 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11530 let payment_id_2 = PaymentId([45; 32]);
11531 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11532 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
11533 check_added_monitors!(nodes[0], 1);
11534 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11535 assert_eq!(events.len(), 1);
11536 let ev = events.drain(..).next().unwrap();
11537 let payment_event = SendEvent::from_event(ev);
11538 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11539 check_added_monitors!(nodes[1], 0);
11540 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11541 expect_pending_htlcs_forwardable!(nodes[1]);
11542 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11543 check_added_monitors!(nodes[1], 1);
11544 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11545 assert!(updates.update_add_htlcs.is_empty());
11546 assert!(updates.update_fulfill_htlcs.is_empty());
11547 assert_eq!(updates.update_fail_htlcs.len(), 1);
11548 assert!(updates.update_fail_malformed_htlcs.is_empty());
11549 assert!(updates.update_fee.is_none());
11550 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11551 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11552 expect_payment_failed!(nodes[0], payment_hash, true);
11554 // Finally, claim the original payment.
11555 claim_payment(&nodes[0], &expected_route, payment_preimage);
11559 fn test_keysend_hash_mismatch() {
11560 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
11561 // preimage doesn't match the msg's payment hash.
11562 let chanmon_cfgs = create_chanmon_cfgs(2);
11563 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11564 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11565 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11567 let payer_pubkey = nodes[0].node.get_our_node_id();
11568 let payee_pubkey = nodes[1].node.get_our_node_id();
11570 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11571 let route_params = RouteParameters::from_payment_params_and_value(
11572 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11573 let network_graph = nodes[0].network_graph;
11574 let first_hops = nodes[0].node.list_usable_channels();
11575 let scorer = test_utils::TestScorer::new();
11576 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11577 let route = find_route(
11578 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11579 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11582 let test_preimage = PaymentPreimage([42; 32]);
11583 let mismatch_payment_hash = PaymentHash([43; 32]);
11584 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
11585 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
11586 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
11587 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
11588 check_added_monitors!(nodes[0], 1);
11590 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11591 assert_eq!(updates.update_add_htlcs.len(), 1);
11592 assert!(updates.update_fulfill_htlcs.is_empty());
11593 assert!(updates.update_fail_htlcs.is_empty());
11594 assert!(updates.update_fail_malformed_htlcs.is_empty());
11595 assert!(updates.update_fee.is_none());
11596 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11598 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
11602 fn test_keysend_msg_with_secret_err() {
11603 // Test that we error as expected if we receive a keysend payment that includes a payment
11604 // secret when we don't support MPP keysend.
11605 let mut reject_mpp_keysend_cfg = test_default_channel_config();
11606 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
11607 let chanmon_cfgs = create_chanmon_cfgs(2);
11608 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11609 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
11610 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11612 let payer_pubkey = nodes[0].node.get_our_node_id();
11613 let payee_pubkey = nodes[1].node.get_our_node_id();
11615 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11616 let route_params = RouteParameters::from_payment_params_and_value(
11617 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11618 let network_graph = nodes[0].network_graph;
11619 let first_hops = nodes[0].node.list_usable_channels();
11620 let scorer = test_utils::TestScorer::new();
11621 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11622 let route = find_route(
11623 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11624 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11627 let test_preimage = PaymentPreimage([42; 32]);
11628 let test_secret = PaymentSecret([43; 32]);
11629 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).to_byte_array());
11630 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
11631 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
11632 nodes[0].node.test_send_payment_internal(&route, payment_hash,
11633 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
11634 PaymentId(payment_hash.0), None, session_privs).unwrap();
11635 check_added_monitors!(nodes[0], 1);
11637 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11638 assert_eq!(updates.update_add_htlcs.len(), 1);
11639 assert!(updates.update_fulfill_htlcs.is_empty());
11640 assert!(updates.update_fail_htlcs.is_empty());
11641 assert!(updates.update_fail_malformed_htlcs.is_empty());
11642 assert!(updates.update_fee.is_none());
11643 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11645 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
11649 fn test_multi_hop_missing_secret() {
11650 let chanmon_cfgs = create_chanmon_cfgs(4);
11651 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
11652 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
11653 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
11655 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
11656 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
11657 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
11658 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
11660 // Marshall an MPP route.
11661 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
11662 let path = route.paths[0].clone();
11663 route.paths.push(path);
11664 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
11665 route.paths[0].hops[0].short_channel_id = chan_1_id;
11666 route.paths[0].hops[1].short_channel_id = chan_3_id;
11667 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
11668 route.paths[1].hops[0].short_channel_id = chan_2_id;
11669 route.paths[1].hops[1].short_channel_id = chan_4_id;
11671 match nodes[0].node.send_payment_with_route(&route, payment_hash,
11672 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
11674 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
11675 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
11677 _ => panic!("unexpected error")
11682 fn test_drop_disconnected_peers_when_removing_channels() {
11683 let chanmon_cfgs = create_chanmon_cfgs(2);
11684 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11685 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11686 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11688 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11690 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
11691 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11693 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
11694 check_closed_broadcast!(nodes[0], true);
11695 check_added_monitors!(nodes[0], 1);
11696 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
11699 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
11700 // disconnected and the channel between has been force closed.
11701 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
11702 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
11703 assert_eq!(nodes_0_per_peer_state.len(), 1);
11704 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
11707 nodes[0].node.timer_tick_occurred();
11710 // Assert that nodes[1] has now been removed.
11711 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
11716 fn bad_inbound_payment_hash() {
11717 // Add coverage for checking that a user-provided payment hash matches the payment secret.
11718 let chanmon_cfgs = create_chanmon_cfgs(2);
11719 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11720 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11721 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11723 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
11724 let payment_data = msgs::FinalOnionHopData {
11726 total_msat: 100_000,
11729 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
11730 // payment verification fails as expected.
11731 let mut bad_payment_hash = payment_hash.clone();
11732 bad_payment_hash.0[0] += 1;
11733 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) {
11734 Ok(_) => panic!("Unexpected ok"),
11736 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
11740 // Check that using the original payment hash succeeds.
11741 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());
11745 fn test_outpoint_to_peer_coverage() {
11746 // Test that the `ChannelManager:outpoint_to_peer` contains channels which have been assigned
11747 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
11748 // the channel is successfully closed.
11749 let chanmon_cfgs = create_chanmon_cfgs(2);
11750 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11751 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11752 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11754 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, None).unwrap();
11755 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11756 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
11757 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11758 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11760 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
11761 let channel_id = ChannelId::from_bytes(tx.txid().to_byte_array());
11763 // Ensure that the `outpoint_to_peer` map is empty until either party has received the
11764 // funding transaction, and have the real `channel_id`.
11765 assert_eq!(nodes[0].node.outpoint_to_peer.lock().unwrap().len(), 0);
11766 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11769 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
11771 // Assert that `nodes[0]`'s `outpoint_to_peer` map is populated with the channel as soon as
11772 // as it has the funding transaction.
11773 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11774 assert_eq!(nodes_0_lock.len(), 1);
11775 assert!(nodes_0_lock.contains_key(&funding_output));
11778 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11780 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11782 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11784 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11785 assert_eq!(nodes_0_lock.len(), 1);
11786 assert!(nodes_0_lock.contains_key(&funding_output));
11788 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11791 // Assert that `nodes[1]`'s `outpoint_to_peer` map is populated with the channel as
11792 // soon as it has the funding transaction.
11793 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11794 assert_eq!(nodes_1_lock.len(), 1);
11795 assert!(nodes_1_lock.contains_key(&funding_output));
11797 check_added_monitors!(nodes[1], 1);
11798 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11799 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11800 check_added_monitors!(nodes[0], 1);
11801 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11802 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
11803 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
11804 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
11806 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
11807 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()));
11808 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
11809 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
11811 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
11812 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
11814 // Assert that the channel is kept in the `outpoint_to_peer` map for both nodes until the
11815 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
11816 // fee for the closing transaction has been negotiated and the parties has the other
11817 // party's signature for the fee negotiated closing transaction.)
11818 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11819 assert_eq!(nodes_0_lock.len(), 1);
11820 assert!(nodes_0_lock.contains_key(&funding_output));
11824 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
11825 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
11826 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
11827 // kept in the `nodes[1]`'s `outpoint_to_peer` map.
11828 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11829 assert_eq!(nodes_1_lock.len(), 1);
11830 assert!(nodes_1_lock.contains_key(&funding_output));
11833 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()));
11835 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
11836 // therefore has all it needs to fully close the channel (both signatures for the
11837 // closing transaction).
11838 // Assert that the channel is removed from `nodes[0]`'s `outpoint_to_peer` map as it can be
11839 // fully closed by `nodes[0]`.
11840 assert_eq!(nodes[0].node.outpoint_to_peer.lock().unwrap().len(), 0);
11842 // Assert that the channel is still in `nodes[1]`'s `outpoint_to_peer` map, as `nodes[1]`
11843 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
11844 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11845 assert_eq!(nodes_1_lock.len(), 1);
11846 assert!(nodes_1_lock.contains_key(&funding_output));
11849 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
11851 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
11853 // Assert that the channel has now been removed from both parties `outpoint_to_peer` map once
11854 // they both have everything required to fully close the channel.
11855 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11857 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
11859 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
11860 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
11863 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11864 let expected_message = format!("Not connected to node: {}", expected_public_key);
11865 check_api_error_message(expected_message, res_err)
11868 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11869 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
11870 check_api_error_message(expected_message, res_err)
11873 fn check_channel_unavailable_error<T>(res_err: Result<T, APIError>, expected_channel_id: ChannelId, peer_node_id: PublicKey) {
11874 let expected_message = format!("Channel with id {} not found for the passed counterparty node_id {}", expected_channel_id, peer_node_id);
11875 check_api_error_message(expected_message, res_err)
11878 fn check_api_misuse_error<T>(res_err: Result<T, APIError>) {
11879 let expected_message = "No such channel awaiting to be accepted.".to_string();
11880 check_api_error_message(expected_message, res_err)
11883 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
11885 Err(APIError::APIMisuseError { err }) => {
11886 assert_eq!(err, expected_err_message);
11888 Err(APIError::ChannelUnavailable { err }) => {
11889 assert_eq!(err, expected_err_message);
11891 Ok(_) => panic!("Unexpected Ok"),
11892 Err(_) => panic!("Unexpected Error"),
11897 fn test_api_calls_with_unkown_counterparty_node() {
11898 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
11899 // expected if the `counterparty_node_id` is an unkown peer in the
11900 // `ChannelManager::per_peer_state` map.
11901 let chanmon_cfg = create_chanmon_cfgs(2);
11902 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11903 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11904 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11907 let channel_id = ChannelId::from_bytes([4; 32]);
11908 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
11909 let intercept_id = InterceptId([0; 32]);
11911 // Test the API functions.
11912 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);
11914 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
11916 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
11918 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
11920 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
11922 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
11924 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
11928 fn test_api_calls_with_unavailable_channel() {
11929 // Tests that our API functions that expects a `counterparty_node_id` and a `channel_id`
11930 // as input, behaves as expected if the `counterparty_node_id` is a known peer in the
11931 // `ChannelManager::per_peer_state` map, but the peer state doesn't contain a channel with
11932 // the given `channel_id`.
11933 let chanmon_cfg = create_chanmon_cfgs(2);
11934 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11935 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11936 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11938 let counterparty_node_id = nodes[1].node.get_our_node_id();
11941 let channel_id = ChannelId::from_bytes([4; 32]);
11943 // Test the API functions.
11944 check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42));
11946 check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11948 check_channel_unavailable_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11950 check_channel_unavailable_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11952 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);
11954 check_channel_unavailable_error(nodes[0].node.update_channel_config(&counterparty_node_id, &[channel_id], &ChannelConfig::default()), channel_id, counterparty_node_id);
11958 fn test_connection_limiting() {
11959 // Test that we limit un-channel'd peers and un-funded channels properly.
11960 let chanmon_cfgs = create_chanmon_cfgs(2);
11961 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11962 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11963 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11965 // Note that create_network connects the nodes together for us
11967 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11968 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11970 let mut funding_tx = None;
11971 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
11972 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11973 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11976 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11977 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
11978 funding_tx = Some(tx.clone());
11979 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
11980 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11982 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11983 check_added_monitors!(nodes[1], 1);
11984 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11986 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11988 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11989 check_added_monitors!(nodes[0], 1);
11990 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11992 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11995 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
11996 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11997 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11998 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11999 open_channel_msg.temporary_channel_id);
12001 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
12002 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
12004 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
12005 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
12006 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12007 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12008 peer_pks.push(random_pk);
12009 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
12010 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12013 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12014 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12015 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12016 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12017 }, true).unwrap_err();
12019 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
12020 // them if we have too many un-channel'd peers.
12021 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12022 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
12023 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
12024 for ev in chan_closed_events {
12025 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
12027 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12028 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12030 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12031 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12032 }, true).unwrap_err();
12034 // but of course if the connection is outbound its allowed...
12035 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12036 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12037 }, false).unwrap();
12038 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12040 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
12041 // Even though we accept one more connection from new peers, we won't actually let them
12043 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
12044 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
12045 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
12046 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
12047 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12049 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12050 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
12051 open_channel_msg.temporary_channel_id);
12053 // Of course, however, outbound channels are always allowed
12054 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None, None).unwrap();
12055 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
12057 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
12058 // "protected" and can connect again.
12059 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
12060 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12061 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12063 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
12065 // Further, because the first channel was funded, we can open another channel with
12067 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12068 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
12072 fn test_outbound_chans_unlimited() {
12073 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
12074 let chanmon_cfgs = create_chanmon_cfgs(2);
12075 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12076 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
12077 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12079 // Note that create_network connects the nodes together for us
12081 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12082 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12084 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
12085 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12086 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12087 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12090 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
12092 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12093 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12094 open_channel_msg.temporary_channel_id);
12096 // but we can still open an outbound channel.
12097 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12098 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
12100 // but even with such an outbound channel, additional inbound channels will still fail.
12101 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12102 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12103 open_channel_msg.temporary_channel_id);
12107 fn test_0conf_limiting() {
12108 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12109 // flag set and (sometimes) accept channels as 0conf.
12110 let chanmon_cfgs = create_chanmon_cfgs(2);
12111 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12112 let mut settings = test_default_channel_config();
12113 settings.manually_accept_inbound_channels = true;
12114 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
12115 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12117 // Note that create_network connects the nodes together for us
12119 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12120 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12122 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
12123 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
12124 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12125 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12126 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
12127 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12130 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
12131 let events = nodes[1].node.get_and_clear_pending_events();
12133 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12134 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
12136 _ => panic!("Unexpected event"),
12138 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
12139 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12142 // If we try to accept a channel from another peer non-0conf it will fail.
12143 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12144 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12145 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12146 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12148 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12149 let events = nodes[1].node.get_and_clear_pending_events();
12151 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12152 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
12153 Err(APIError::APIMisuseError { err }) =>
12154 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
12158 _ => panic!("Unexpected event"),
12160 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
12161 open_channel_msg.temporary_channel_id);
12163 // ...however if we accept the same channel 0conf it should work just fine.
12164 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12165 let events = nodes[1].node.get_and_clear_pending_events();
12167 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12168 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
12170 _ => panic!("Unexpected event"),
12172 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
12176 fn reject_excessively_underpaying_htlcs() {
12177 let chanmon_cfg = create_chanmon_cfgs(1);
12178 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12179 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12180 let node = create_network(1, &node_cfg, &node_chanmgr);
12181 let sender_intended_amt_msat = 100;
12182 let extra_fee_msat = 10;
12183 let hop_data = msgs::InboundOnionPayload::Receive {
12184 sender_intended_htlc_amt_msat: 100,
12185 cltv_expiry_height: 42,
12186 payment_metadata: None,
12187 keysend_preimage: None,
12188 payment_data: Some(msgs::FinalOnionHopData {
12189 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12191 custom_tlvs: Vec::new(),
12193 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
12194 // intended amount, we fail the payment.
12195 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12196 if let Err(crate::ln::channelmanager::InboundHTLCErr { err_code, .. }) =
12197 create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12198 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat),
12199 current_height, node[0].node.default_configuration.accept_mpp_keysend)
12201 assert_eq!(err_code, 19);
12202 } else { panic!(); }
12204 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
12205 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
12206 sender_intended_htlc_amt_msat: 100,
12207 cltv_expiry_height: 42,
12208 payment_metadata: None,
12209 keysend_preimage: None,
12210 payment_data: Some(msgs::FinalOnionHopData {
12211 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12213 custom_tlvs: Vec::new(),
12215 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12216 assert!(create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12217 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat),
12218 current_height, node[0].node.default_configuration.accept_mpp_keysend).is_ok());
12222 fn test_final_incorrect_cltv(){
12223 let chanmon_cfg = create_chanmon_cfgs(1);
12224 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12225 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12226 let node = create_network(1, &node_cfg, &node_chanmgr);
12228 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12229 let result = create_recv_pending_htlc_info(msgs::InboundOnionPayload::Receive {
12230 sender_intended_htlc_amt_msat: 100,
12231 cltv_expiry_height: 22,
12232 payment_metadata: None,
12233 keysend_preimage: None,
12234 payment_data: Some(msgs::FinalOnionHopData {
12235 payment_secret: PaymentSecret([0; 32]), total_msat: 100,
12237 custom_tlvs: Vec::new(),
12238 }, [0; 32], PaymentHash([0; 32]), 100, 23, None, true, None, current_height,
12239 node[0].node.default_configuration.accept_mpp_keysend);
12241 // Should not return an error as this condition:
12242 // https://github.com/lightning/bolts/blob/4dcc377209509b13cf89a4b91fde7d478f5b46d8/04-onion-routing.md?plain=1#L334
12243 // is not satisfied.
12244 assert!(result.is_ok());
12248 fn test_inbound_anchors_manual_acceptance() {
12249 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12250 // flag set and (sometimes) accept channels as 0conf.
12251 let mut anchors_cfg = test_default_channel_config();
12252 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12254 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
12255 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
12257 let chanmon_cfgs = create_chanmon_cfgs(3);
12258 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
12259 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
12260 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
12261 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
12263 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12264 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12266 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12267 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12268 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
12269 match &msg_events[0] {
12270 MessageSendEvent::HandleError { node_id, action } => {
12271 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
12273 ErrorAction::SendErrorMessage { msg } =>
12274 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
12275 _ => panic!("Unexpected error action"),
12278 _ => panic!("Unexpected event"),
12281 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12282 let events = nodes[2].node.get_and_clear_pending_events();
12284 Event::OpenChannelRequest { temporary_channel_id, .. } =>
12285 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
12286 _ => panic!("Unexpected event"),
12288 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12292 fn test_anchors_zero_fee_htlc_tx_fallback() {
12293 // Tests that if both nodes support anchors, but the remote node does not want to accept
12294 // anchor channels at the moment, an error it sent to the local node such that it can retry
12295 // the channel without the anchors feature.
12296 let chanmon_cfgs = create_chanmon_cfgs(2);
12297 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12298 let mut anchors_config = test_default_channel_config();
12299 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12300 anchors_config.manually_accept_inbound_channels = true;
12301 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
12302 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12304 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None, None).unwrap();
12305 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12306 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
12308 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12309 let events = nodes[1].node.get_and_clear_pending_events();
12311 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12312 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
12314 _ => panic!("Unexpected event"),
12317 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
12318 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
12320 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12321 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
12323 // Since nodes[1] should not have accepted the channel, it should
12324 // not have generated any events.
12325 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12329 fn test_update_channel_config() {
12330 let chanmon_cfg = create_chanmon_cfgs(2);
12331 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12332 let mut user_config = test_default_channel_config();
12333 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12334 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12335 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
12336 let channel = &nodes[0].node.list_channels()[0];
12338 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12339 let events = nodes[0].node.get_and_clear_pending_msg_events();
12340 assert_eq!(events.len(), 0);
12342 user_config.channel_config.forwarding_fee_base_msat += 10;
12343 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12344 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
12345 let events = nodes[0].node.get_and_clear_pending_msg_events();
12346 assert_eq!(events.len(), 1);
12348 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12349 _ => panic!("expected BroadcastChannelUpdate event"),
12352 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
12353 let events = nodes[0].node.get_and_clear_pending_msg_events();
12354 assert_eq!(events.len(), 0);
12356 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
12357 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12358 cltv_expiry_delta: Some(new_cltv_expiry_delta),
12359 ..Default::default()
12361 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12362 let events = nodes[0].node.get_and_clear_pending_msg_events();
12363 assert_eq!(events.len(), 1);
12365 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12366 _ => panic!("expected BroadcastChannelUpdate event"),
12369 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
12370 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12371 forwarding_fee_proportional_millionths: Some(new_fee),
12372 ..Default::default()
12374 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12375 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
12376 let events = nodes[0].node.get_and_clear_pending_msg_events();
12377 assert_eq!(events.len(), 1);
12379 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12380 _ => panic!("expected BroadcastChannelUpdate event"),
12383 // If we provide a channel_id not associated with the peer, we should get an error and no updates
12384 // should be applied to ensure update atomicity as specified in the API docs.
12385 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
12386 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
12387 let new_fee = current_fee + 100;
12390 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
12391 forwarding_fee_proportional_millionths: Some(new_fee),
12392 ..Default::default()
12394 Err(APIError::ChannelUnavailable { err: _ }),
12397 // Check that the fee hasn't changed for the channel that exists.
12398 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
12399 let events = nodes[0].node.get_and_clear_pending_msg_events();
12400 assert_eq!(events.len(), 0);
12404 fn test_payment_display() {
12405 let payment_id = PaymentId([42; 32]);
12406 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12407 let payment_hash = PaymentHash([42; 32]);
12408 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12409 let payment_preimage = PaymentPreimage([42; 32]);
12410 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12414 fn test_trigger_lnd_force_close() {
12415 let chanmon_cfg = create_chanmon_cfgs(2);
12416 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12417 let user_config = test_default_channel_config();
12418 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12419 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12421 // Open a channel, immediately disconnect each other, and broadcast Alice's latest state.
12422 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
12423 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
12424 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12425 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
12426 check_closed_broadcast(&nodes[0], 1, true);
12427 check_added_monitors(&nodes[0], 1);
12428 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
12430 let txn = nodes[0].tx_broadcaster.txn_broadcast();
12431 assert_eq!(txn.len(), 1);
12432 check_spends!(txn[0], funding_tx);
12435 // Since they're disconnected, Bob won't receive Alice's `Error` message. Reconnect them
12436 // such that Bob sends a `ChannelReestablish` to Alice since the channel is still open from
12438 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
12439 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
12441 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12442 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12443 }, false).unwrap();
12444 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
12445 let channel_reestablish = get_event_msg!(
12446 nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()
12448 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &channel_reestablish);
12450 // Alice should respond with an error since the channel isn't known, but a bogus
12451 // `ChannelReestablish` should be sent first, such that we actually trigger Bob to force
12452 // close even if it was an lnd node.
12453 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
12454 assert_eq!(msg_events.len(), 2);
12455 if let MessageSendEvent::SendChannelReestablish { node_id, msg } = &msg_events[0] {
12456 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
12457 assert_eq!(msg.next_local_commitment_number, 0);
12458 assert_eq!(msg.next_remote_commitment_number, 0);
12459 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &msg);
12460 } else { panic!() };
12461 check_closed_broadcast(&nodes[1], 1, true);
12462 check_added_monitors(&nodes[1], 1);
12463 let expected_close_reason = ClosureReason::ProcessingError {
12464 err: "Peer sent an invalid channel_reestablish to force close in a non-standard way".to_string()
12466 check_closed_event!(nodes[1], 1, expected_close_reason, [nodes[0].node.get_our_node_id()], 100000);
12468 let txn = nodes[1].tx_broadcaster.txn_broadcast();
12469 assert_eq!(txn.len(), 1);
12470 check_spends!(txn[0], funding_tx);
12475 fn test_malformed_forward_htlcs_ser() {
12476 // Ensure that `HTLCForwardInfo::FailMalformedHTLC`s are (de)serialized properly.
12477 let chanmon_cfg = create_chanmon_cfgs(1);
12478 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12481 let chanmgrs = create_node_chanmgrs(1, &node_cfg, &[None]);
12482 let deserialized_chanmgr;
12483 let mut nodes = create_network(1, &node_cfg, &chanmgrs);
12485 let dummy_failed_htlc = |htlc_id| {
12486 HTLCForwardInfo::FailHTLC { htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }, }
12488 let dummy_malformed_htlc = |htlc_id| {
12489 HTLCForwardInfo::FailMalformedHTLC { htlc_id, failure_code: 0x4000, sha256_of_onion: [0; 32] }
12492 let dummy_htlcs_1: Vec<HTLCForwardInfo> = (1..10).map(|htlc_id| {
12493 if htlc_id % 2 == 0 {
12494 dummy_failed_htlc(htlc_id)
12496 dummy_malformed_htlc(htlc_id)
12500 let dummy_htlcs_2: Vec<HTLCForwardInfo> = (1..10).map(|htlc_id| {
12501 if htlc_id % 2 == 1 {
12502 dummy_failed_htlc(htlc_id)
12504 dummy_malformed_htlc(htlc_id)
12509 let (scid_1, scid_2) = (42, 43);
12510 let mut forward_htlcs = HashMap::new();
12511 forward_htlcs.insert(scid_1, dummy_htlcs_1.clone());
12512 forward_htlcs.insert(scid_2, dummy_htlcs_2.clone());
12514 let mut chanmgr_fwd_htlcs = nodes[0].node.forward_htlcs.lock().unwrap();
12515 *chanmgr_fwd_htlcs = forward_htlcs.clone();
12516 core::mem::drop(chanmgr_fwd_htlcs);
12518 reload_node!(nodes[0], nodes[0].node.encode(), &[], persister, chain_monitor, deserialized_chanmgr);
12520 let mut deserialized_fwd_htlcs = nodes[0].node.forward_htlcs.lock().unwrap();
12521 for scid in [scid_1, scid_2].iter() {
12522 let deserialized_htlcs = deserialized_fwd_htlcs.remove(scid).unwrap();
12523 assert_eq!(forward_htlcs.remove(scid).unwrap(), deserialized_htlcs);
12525 assert!(deserialized_fwd_htlcs.is_empty());
12526 core::mem::drop(deserialized_fwd_htlcs);
12528 expect_pending_htlcs_forwardable!(nodes[0]);
12534 use crate::chain::Listen;
12535 use crate::chain::chainmonitor::{ChainMonitor, Persist};
12536 use crate::sign::{KeysManager, InMemorySigner};
12537 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
12538 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
12539 use crate::ln::functional_test_utils::*;
12540 use crate::ln::msgs::{ChannelMessageHandler, Init};
12541 use crate::routing::gossip::NetworkGraph;
12542 use crate::routing::router::{PaymentParameters, RouteParameters};
12543 use crate::util::test_utils;
12544 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
12546 use bitcoin::blockdata::locktime::absolute::LockTime;
12547 use bitcoin::hashes::Hash;
12548 use bitcoin::hashes::sha256::Hash as Sha256;
12549 use bitcoin::{Transaction, TxOut};
12551 use crate::sync::{Arc, Mutex, RwLock};
12553 use criterion::Criterion;
12555 type Manager<'a, P> = ChannelManager<
12556 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
12557 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
12558 &'a test_utils::TestLogger, &'a P>,
12559 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
12560 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
12561 &'a test_utils::TestLogger>;
12563 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
12564 node: &'node_cfg Manager<'chan_mon_cfg, P>,
12566 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
12567 type CM = Manager<'chan_mon_cfg, P>;
12569 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
12571 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
12574 pub fn bench_sends(bench: &mut Criterion) {
12575 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
12578 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
12579 // Do a simple benchmark of sending a payment back and forth between two nodes.
12580 // Note that this is unrealistic as each payment send will require at least two fsync
12582 let network = bitcoin::Network::Testnet;
12583 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
12585 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
12586 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
12587 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
12588 let scorer = RwLock::new(test_utils::TestScorer::new());
12589 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &logger_a, &scorer);
12591 let mut config: UserConfig = Default::default();
12592 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
12593 config.channel_handshake_config.minimum_depth = 1;
12595 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
12596 let seed_a = [1u8; 32];
12597 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
12598 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 {
12600 best_block: BestBlock::from_network(network),
12601 }, genesis_block.header.time);
12602 let node_a_holder = ANodeHolder { node: &node_a };
12604 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
12605 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
12606 let seed_b = [2u8; 32];
12607 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
12608 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 {
12610 best_block: BestBlock::from_network(network),
12611 }, genesis_block.header.time);
12612 let node_b_holder = ANodeHolder { node: &node_b };
12614 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
12615 features: node_b.init_features(), networks: None, remote_network_address: None
12617 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
12618 features: node_a.init_features(), networks: None, remote_network_address: None
12619 }, false).unwrap();
12620 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None, None).unwrap();
12621 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()));
12622 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()));
12625 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
12626 tx = Transaction { version: 2, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
12627 value: 8_000_000, script_pubkey: output_script,
12629 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
12630 } else { panic!(); }
12632 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()));
12633 let events_b = node_b.get_and_clear_pending_events();
12634 assert_eq!(events_b.len(), 1);
12635 match events_b[0] {
12636 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12637 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12639 _ => panic!("Unexpected event"),
12642 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()));
12643 let events_a = node_a.get_and_clear_pending_events();
12644 assert_eq!(events_a.len(), 1);
12645 match events_a[0] {
12646 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12647 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12649 _ => panic!("Unexpected event"),
12652 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
12654 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
12655 Listen::block_connected(&node_a, &block, 1);
12656 Listen::block_connected(&node_b, &block, 1);
12658 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()));
12659 let msg_events = node_a.get_and_clear_pending_msg_events();
12660 assert_eq!(msg_events.len(), 2);
12661 match msg_events[0] {
12662 MessageSendEvent::SendChannelReady { ref msg, .. } => {
12663 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
12664 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
12668 match msg_events[1] {
12669 MessageSendEvent::SendChannelUpdate { .. } => {},
12673 let events_a = node_a.get_and_clear_pending_events();
12674 assert_eq!(events_a.len(), 1);
12675 match events_a[0] {
12676 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12677 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12679 _ => panic!("Unexpected event"),
12682 let events_b = node_b.get_and_clear_pending_events();
12683 assert_eq!(events_b.len(), 1);
12684 match events_b[0] {
12685 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12686 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12688 _ => panic!("Unexpected event"),
12691 let mut payment_count: u64 = 0;
12692 macro_rules! send_payment {
12693 ($node_a: expr, $node_b: expr) => {
12694 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
12695 .with_bolt11_features($node_b.bolt11_invoice_features()).unwrap();
12696 let mut payment_preimage = PaymentPreimage([0; 32]);
12697 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
12698 payment_count += 1;
12699 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
12700 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
12702 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
12703 PaymentId(payment_hash.0),
12704 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
12705 Retry::Attempts(0)).unwrap();
12706 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
12707 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
12708 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
12709 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
12710 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
12711 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
12712 $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()));
12714 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
12715 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
12716 $node_b.claim_funds(payment_preimage);
12717 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
12719 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
12720 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
12721 assert_eq!(node_id, $node_a.get_our_node_id());
12722 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
12723 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
12725 _ => panic!("Failed to generate claim event"),
12728 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
12729 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
12730 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
12731 $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()));
12733 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
12737 bench.bench_function(bench_name, |b| b.iter(|| {
12738 send_payment!(node_a, node_b);
12739 send_payment!(node_b, node_a);