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.
1639 pub funding_txo: Option<OutPoint>,
1640 /// The features which this channel operates with. See individual features for more info.
1642 /// `None` until negotiation completes and the channel type is finalized.
1643 pub channel_type: Option<ChannelTypeFeatures>,
1644 /// The position of the funding transaction in the chain. None if the funding transaction has
1645 /// not yet been confirmed and the channel fully opened.
1647 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1648 /// payments instead of this. See [`get_inbound_payment_scid`].
1650 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1651 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1653 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1654 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1655 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1656 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1657 /// [`confirmations_required`]: Self::confirmations_required
1658 pub short_channel_id: Option<u64>,
1659 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1660 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1661 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1664 /// This will be `None` as long as the channel is not available for routing outbound payments.
1666 /// [`short_channel_id`]: Self::short_channel_id
1667 /// [`confirmations_required`]: Self::confirmations_required
1668 pub outbound_scid_alias: Option<u64>,
1669 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1670 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1671 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1672 /// when they see a payment to be routed to us.
1674 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1675 /// previous values for inbound payment forwarding.
1677 /// [`short_channel_id`]: Self::short_channel_id
1678 pub inbound_scid_alias: Option<u64>,
1679 /// The value, in satoshis, of this channel as appears in the funding output
1680 pub channel_value_satoshis: u64,
1681 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1682 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1683 /// this value on chain.
1685 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1687 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1689 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1690 pub unspendable_punishment_reserve: Option<u64>,
1691 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1692 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1693 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1694 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1695 /// serialized with LDK versions prior to 0.0.113.
1697 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1698 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1699 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1700 pub user_channel_id: u128,
1701 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1702 /// which is applied to commitment and HTLC transactions.
1704 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1705 pub feerate_sat_per_1000_weight: Option<u32>,
1706 /// Our total balance. This is the amount we would get if we close the channel.
1707 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1708 /// amount is not likely to be recoverable on close.
1710 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1711 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1712 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1713 /// This does not consider any on-chain fees.
1715 /// See also [`ChannelDetails::outbound_capacity_msat`]
1716 pub balance_msat: u64,
1717 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1718 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1719 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1720 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1722 /// See also [`ChannelDetails::balance_msat`]
1724 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1725 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1726 /// should be able to spend nearly this amount.
1727 pub outbound_capacity_msat: u64,
1728 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1729 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1730 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1731 /// to use a limit as close as possible to the HTLC limit we can currently send.
1733 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1734 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1735 pub next_outbound_htlc_limit_msat: u64,
1736 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1737 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1738 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1739 /// route which is valid.
1740 pub next_outbound_htlc_minimum_msat: u64,
1741 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1742 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1743 /// available for inclusion in new inbound HTLCs).
1744 /// Note that there are some corner cases not fully handled here, so the actual available
1745 /// inbound capacity may be slightly higher than this.
1747 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1748 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1749 /// However, our counterparty should be able to spend nearly this amount.
1750 pub inbound_capacity_msat: u64,
1751 /// The number of required confirmations on the funding transaction before the funding will be
1752 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1753 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1754 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1755 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1757 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1759 /// [`is_outbound`]: ChannelDetails::is_outbound
1760 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1761 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1762 pub confirmations_required: Option<u32>,
1763 /// The current number of confirmations on the funding transaction.
1765 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1766 pub confirmations: Option<u32>,
1767 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1768 /// until we can claim our funds after we force-close the channel. During this time our
1769 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1770 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1771 /// time to claim our non-HTLC-encumbered funds.
1773 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1774 pub force_close_spend_delay: Option<u16>,
1775 /// True if the channel was initiated (and thus funded) by us.
1776 pub is_outbound: bool,
1777 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1778 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1779 /// required confirmation count has been reached (and we were connected to the peer at some
1780 /// point after the funding transaction received enough confirmations). The required
1781 /// confirmation count is provided in [`confirmations_required`].
1783 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1784 pub is_channel_ready: bool,
1785 /// The stage of the channel's shutdown.
1786 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1787 pub channel_shutdown_state: Option<ChannelShutdownState>,
1788 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1789 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1791 /// This is a strict superset of `is_channel_ready`.
1792 pub is_usable: bool,
1793 /// True if this channel is (or will be) publicly-announced.
1794 pub is_public: bool,
1795 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1796 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1797 pub inbound_htlc_minimum_msat: Option<u64>,
1798 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1799 pub inbound_htlc_maximum_msat: Option<u64>,
1800 /// Set of configurable parameters that affect channel operation.
1802 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1803 pub config: Option<ChannelConfig>,
1806 impl ChannelDetails {
1807 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1808 /// This should be used for providing invoice hints or in any other context where our
1809 /// counterparty will forward a payment to us.
1811 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1812 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1813 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1814 self.inbound_scid_alias.or(self.short_channel_id)
1817 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1818 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1819 /// we're sending or forwarding a payment outbound over this channel.
1821 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1822 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1823 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1824 self.short_channel_id.or(self.outbound_scid_alias)
1827 fn from_channel_context<SP: Deref, F: Deref>(
1828 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1829 fee_estimator: &LowerBoundedFeeEstimator<F>
1832 SP::Target: SignerProvider,
1833 F::Target: FeeEstimator
1835 let balance = context.get_available_balances(fee_estimator);
1836 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1837 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1839 channel_id: context.channel_id(),
1840 counterparty: ChannelCounterparty {
1841 node_id: context.get_counterparty_node_id(),
1842 features: latest_features,
1843 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1844 forwarding_info: context.counterparty_forwarding_info(),
1845 // Ensures that we have actually received the `htlc_minimum_msat` value
1846 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1847 // message (as they are always the first message from the counterparty).
1848 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1849 // default `0` value set by `Channel::new_outbound`.
1850 outbound_htlc_minimum_msat: if context.have_received_message() {
1851 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1852 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1854 funding_txo: context.get_funding_txo(),
1855 // Note that accept_channel (or open_channel) is always the first message, so
1856 // `have_received_message` indicates that type negotiation has completed.
1857 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1858 short_channel_id: context.get_short_channel_id(),
1859 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1860 inbound_scid_alias: context.latest_inbound_scid_alias(),
1861 channel_value_satoshis: context.get_value_satoshis(),
1862 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1863 unspendable_punishment_reserve: to_self_reserve_satoshis,
1864 balance_msat: balance.balance_msat,
1865 inbound_capacity_msat: balance.inbound_capacity_msat,
1866 outbound_capacity_msat: balance.outbound_capacity_msat,
1867 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1868 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1869 user_channel_id: context.get_user_id(),
1870 confirmations_required: context.minimum_depth(),
1871 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1872 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1873 is_outbound: context.is_outbound(),
1874 is_channel_ready: context.is_usable(),
1875 is_usable: context.is_live(),
1876 is_public: context.should_announce(),
1877 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1878 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1879 config: Some(context.config()),
1880 channel_shutdown_state: Some(context.shutdown_state()),
1885 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1886 /// Further information on the details of the channel shutdown.
1887 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1888 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1889 /// the channel will be removed shortly.
1890 /// Also note, that in normal operation, peers could disconnect at any of these states
1891 /// and require peer re-connection before making progress onto other states
1892 pub enum ChannelShutdownState {
1893 /// Channel has not sent or received a shutdown message.
1895 /// Local node has sent a shutdown message for this channel.
1897 /// Shutdown message exchanges have concluded and the channels are in the midst of
1898 /// resolving all existing open HTLCs before closing can continue.
1900 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1901 NegotiatingClosingFee,
1902 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1903 /// to drop the channel.
1907 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1908 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1909 #[derive(Debug, PartialEq)]
1910 pub enum RecentPaymentDetails {
1911 /// When an invoice was requested and thus a payment has not yet been sent.
1913 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1914 /// a payment and ensure idempotency in LDK.
1915 payment_id: PaymentId,
1917 /// When a payment is still being sent and awaiting successful delivery.
1919 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1920 /// a payment and ensure idempotency in LDK.
1921 payment_id: PaymentId,
1922 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1924 payment_hash: PaymentHash,
1925 /// Total amount (in msat, excluding fees) across all paths for this payment,
1926 /// not just the amount currently inflight.
1929 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1930 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1931 /// payment is removed from tracking.
1933 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1934 /// a payment and ensure idempotency in LDK.
1935 payment_id: PaymentId,
1936 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1937 /// made before LDK version 0.0.104.
1938 payment_hash: Option<PaymentHash>,
1940 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1941 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1942 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1944 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1945 /// a payment and ensure idempotency in LDK.
1946 payment_id: PaymentId,
1947 /// Hash of the payment that we have given up trying to send.
1948 payment_hash: PaymentHash,
1952 /// Route hints used in constructing invoices for [phantom node payents].
1954 /// [phantom node payments]: crate::sign::PhantomKeysManager
1956 pub struct PhantomRouteHints {
1957 /// The list of channels to be included in the invoice route hints.
1958 pub channels: Vec<ChannelDetails>,
1959 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1961 pub phantom_scid: u64,
1962 /// The pubkey of the real backing node that would ultimately receive the payment.
1963 pub real_node_pubkey: PublicKey,
1966 macro_rules! handle_error {
1967 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1968 // In testing, ensure there are no deadlocks where the lock is already held upon
1969 // entering the macro.
1970 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1971 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1975 Err(MsgHandleErrInternal { err, shutdown_finish, .. }) => {
1976 let mut msg_events = Vec::with_capacity(2);
1978 if let Some((shutdown_res, update_option)) = shutdown_finish {
1979 let counterparty_node_id = shutdown_res.counterparty_node_id;
1980 let channel_id = shutdown_res.channel_id;
1981 let logger = WithContext::from(
1982 &$self.logger, Some(counterparty_node_id), Some(channel_id),
1984 log_error!(logger, "Force-closing channel: {}", err.err);
1986 $self.finish_close_channel(shutdown_res);
1987 if let Some(update) = update_option {
1988 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1993 log_error!($self.logger, "Got non-closing error: {}", err.err);
1996 if let msgs::ErrorAction::IgnoreError = err.action {
1998 msg_events.push(events::MessageSendEvent::HandleError {
1999 node_id: $counterparty_node_id,
2000 action: err.action.clone()
2004 if !msg_events.is_empty() {
2005 let per_peer_state = $self.per_peer_state.read().unwrap();
2006 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
2007 let mut peer_state = peer_state_mutex.lock().unwrap();
2008 peer_state.pending_msg_events.append(&mut msg_events);
2012 // Return error in case higher-API need one
2019 macro_rules! update_maps_on_chan_removal {
2020 ($self: expr, $channel_context: expr) => {{
2021 if let Some(outpoint) = $channel_context.get_funding_txo() {
2022 $self.outpoint_to_peer.lock().unwrap().remove(&outpoint);
2024 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2025 if let Some(short_id) = $channel_context.get_short_channel_id() {
2026 short_to_chan_info.remove(&short_id);
2028 // If the channel was never confirmed on-chain prior to its closure, remove the
2029 // outbound SCID alias we used for it from the collision-prevention set. While we
2030 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
2031 // also don't want a counterparty to be able to trivially cause a memory leak by simply
2032 // opening a million channels with us which are closed before we ever reach the funding
2034 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
2035 debug_assert!(alias_removed);
2037 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
2041 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
2042 macro_rules! convert_chan_phase_err {
2043 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
2045 ChannelError::Warn(msg) => {
2046 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
2048 ChannelError::Ignore(msg) => {
2049 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
2051 ChannelError::Close(msg) => {
2052 let logger = WithChannelContext::from(&$self.logger, &$channel.context);
2053 log_error!(logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
2054 update_maps_on_chan_removal!($self, $channel.context);
2055 let reason = ClosureReason::ProcessingError { err: msg.clone() };
2056 let shutdown_res = $channel.context.force_shutdown(true, reason);
2058 MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $channel_update);
2063 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
2064 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
2066 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
2067 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
2069 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
2070 match $channel_phase {
2071 ChannelPhase::Funded(channel) => {
2072 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
2074 ChannelPhase::UnfundedOutboundV1(channel) => {
2075 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2077 ChannelPhase::UnfundedInboundV1(channel) => {
2078 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
2084 macro_rules! break_chan_phase_entry {
2085 ($self: ident, $res: expr, $entry: expr) => {
2089 let key = *$entry.key();
2090 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2092 $entry.remove_entry();
2100 macro_rules! try_chan_phase_entry {
2101 ($self: ident, $res: expr, $entry: expr) => {
2105 let key = *$entry.key();
2106 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
2108 $entry.remove_entry();
2116 macro_rules! remove_channel_phase {
2117 ($self: expr, $entry: expr) => {
2119 let channel = $entry.remove_entry().1;
2120 update_maps_on_chan_removal!($self, &channel.context());
2126 macro_rules! send_channel_ready {
2127 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
2128 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
2129 node_id: $channel.context.get_counterparty_node_id(),
2130 msg: $channel_ready_msg,
2132 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
2133 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
2134 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2135 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2136 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2137 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2138 if let Some(real_scid) = $channel.context.get_short_channel_id() {
2139 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2140 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2141 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2146 macro_rules! emit_channel_pending_event {
2147 ($locked_events: expr, $channel: expr) => {
2148 if $channel.context.should_emit_channel_pending_event() {
2149 $locked_events.push_back((events::Event::ChannelPending {
2150 channel_id: $channel.context.channel_id(),
2151 former_temporary_channel_id: $channel.context.temporary_channel_id(),
2152 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2153 user_channel_id: $channel.context.get_user_id(),
2154 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
2155 channel_type: Some($channel.context.get_channel_type().clone()),
2157 $channel.context.set_channel_pending_event_emitted();
2162 macro_rules! emit_channel_ready_event {
2163 ($locked_events: expr, $channel: expr) => {
2164 if $channel.context.should_emit_channel_ready_event() {
2165 debug_assert!($channel.context.channel_pending_event_emitted());
2166 $locked_events.push_back((events::Event::ChannelReady {
2167 channel_id: $channel.context.channel_id(),
2168 user_channel_id: $channel.context.get_user_id(),
2169 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2170 channel_type: $channel.context.get_channel_type().clone(),
2172 $channel.context.set_channel_ready_event_emitted();
2177 macro_rules! handle_monitor_update_completion {
2178 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2179 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2180 let mut updates = $chan.monitor_updating_restored(&&logger,
2181 &$self.node_signer, $self.chain_hash, &$self.default_configuration,
2182 $self.best_block.read().unwrap().height());
2183 let counterparty_node_id = $chan.context.get_counterparty_node_id();
2184 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
2185 // We only send a channel_update in the case where we are just now sending a
2186 // channel_ready and the channel is in a usable state. We may re-send a
2187 // channel_update later through the announcement_signatures process for public
2188 // channels, but there's no reason not to just inform our counterparty of our fees
2190 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
2191 Some(events::MessageSendEvent::SendChannelUpdate {
2192 node_id: counterparty_node_id,
2198 let update_actions = $peer_state.monitor_update_blocked_actions
2199 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
2201 let htlc_forwards = $self.handle_channel_resumption(
2202 &mut $peer_state.pending_msg_events, $chan, updates.raa,
2203 updates.commitment_update, updates.order, updates.accepted_htlcs,
2204 updates.funding_broadcastable, updates.channel_ready,
2205 updates.announcement_sigs);
2206 if let Some(upd) = channel_update {
2207 $peer_state.pending_msg_events.push(upd);
2210 let channel_id = $chan.context.channel_id();
2211 let unbroadcasted_batch_funding_txid = $chan.context.unbroadcasted_batch_funding_txid();
2212 core::mem::drop($peer_state_lock);
2213 core::mem::drop($per_peer_state_lock);
2215 // If the channel belongs to a batch funding transaction, the progress of the batch
2216 // should be updated as we have received funding_signed and persisted the monitor.
2217 if let Some(txid) = unbroadcasted_batch_funding_txid {
2218 let mut funding_batch_states = $self.funding_batch_states.lock().unwrap();
2219 let mut batch_completed = false;
2220 if let Some(batch_state) = funding_batch_states.get_mut(&txid) {
2221 let channel_state = batch_state.iter_mut().find(|(chan_id, pubkey, _)| (
2222 *chan_id == channel_id &&
2223 *pubkey == counterparty_node_id
2225 if let Some(channel_state) = channel_state {
2226 channel_state.2 = true;
2228 debug_assert!(false, "Missing channel batch state for channel which completed initial monitor update");
2230 batch_completed = batch_state.iter().all(|(_, _, completed)| *completed);
2232 debug_assert!(false, "Missing batch state for channel which completed initial monitor update");
2235 // When all channels in a batched funding transaction have become ready, it is not necessary
2236 // to track the progress of the batch anymore and the state of the channels can be updated.
2237 if batch_completed {
2238 let removed_batch_state = funding_batch_states.remove(&txid).into_iter().flatten();
2239 let per_peer_state = $self.per_peer_state.read().unwrap();
2240 let mut batch_funding_tx = None;
2241 for (channel_id, counterparty_node_id, _) in removed_batch_state {
2242 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2243 let mut peer_state = peer_state_mutex.lock().unwrap();
2244 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
2245 batch_funding_tx = batch_funding_tx.or_else(|| chan.context.unbroadcasted_funding());
2246 chan.set_batch_ready();
2247 let mut pending_events = $self.pending_events.lock().unwrap();
2248 emit_channel_pending_event!(pending_events, chan);
2252 if let Some(tx) = batch_funding_tx {
2253 log_info!($self.logger, "Broadcasting batch funding transaction with txid {}", tx.txid());
2254 $self.tx_broadcaster.broadcast_transactions(&[&tx]);
2259 $self.handle_monitor_update_completion_actions(update_actions);
2261 if let Some(forwards) = htlc_forwards {
2262 $self.forward_htlcs(&mut [forwards][..]);
2264 $self.finalize_claims(updates.finalized_claimed_htlcs);
2265 for failure in updates.failed_htlcs.drain(..) {
2266 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2267 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2272 macro_rules! handle_new_monitor_update {
2273 ($self: ident, $update_res: expr, $chan: expr, _internal, $completed: expr) => { {
2274 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2275 let logger = WithChannelContext::from(&$self.logger, &$chan.context);
2277 ChannelMonitorUpdateStatus::UnrecoverableError => {
2278 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
2279 log_error!(logger, "{}", err_str);
2280 panic!("{}", err_str);
2282 ChannelMonitorUpdateStatus::InProgress => {
2283 log_debug!(logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2284 &$chan.context.channel_id());
2287 ChannelMonitorUpdateStatus::Completed => {
2293 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, INITIAL_MONITOR) => {
2294 handle_new_monitor_update!($self, $update_res, $chan, _internal,
2295 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2297 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2298 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2299 .or_insert_with(Vec::new);
2300 // During startup, we push monitor updates as background events through to here in
2301 // order to replay updates that were in-flight when we shut down. Thus, we have to
2302 // filter for uniqueness here.
2303 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2304 .unwrap_or_else(|| {
2305 in_flight_updates.push($update);
2306 in_flight_updates.len() - 1
2308 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2309 handle_new_monitor_update!($self, update_res, $chan, _internal,
2311 let _ = in_flight_updates.remove(idx);
2312 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2313 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2319 macro_rules! process_events_body {
2320 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2321 let mut processed_all_events = false;
2322 while !processed_all_events {
2323 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2330 // We'll acquire our total consistency lock so that we can be sure no other
2331 // persists happen while processing monitor events.
2332 let _read_guard = $self.total_consistency_lock.read().unwrap();
2334 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2335 // ensure any startup-generated background events are handled first.
2336 result = $self.process_background_events();
2338 // TODO: This behavior should be documented. It's unintuitive that we query
2339 // ChannelMonitors when clearing other events.
2340 if $self.process_pending_monitor_events() {
2341 result = NotifyOption::DoPersist;
2345 let pending_events = $self.pending_events.lock().unwrap().clone();
2346 let num_events = pending_events.len();
2347 if !pending_events.is_empty() {
2348 result = NotifyOption::DoPersist;
2351 let mut post_event_actions = Vec::new();
2353 for (event, action_opt) in pending_events {
2354 $event_to_handle = event;
2356 if let Some(action) = action_opt {
2357 post_event_actions.push(action);
2362 let mut pending_events = $self.pending_events.lock().unwrap();
2363 pending_events.drain(..num_events);
2364 processed_all_events = pending_events.is_empty();
2365 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2366 // updated here with the `pending_events` lock acquired.
2367 $self.pending_events_processor.store(false, Ordering::Release);
2370 if !post_event_actions.is_empty() {
2371 $self.handle_post_event_actions(post_event_actions);
2372 // If we had some actions, go around again as we may have more events now
2373 processed_all_events = false;
2377 NotifyOption::DoPersist => {
2378 $self.needs_persist_flag.store(true, Ordering::Release);
2379 $self.event_persist_notifier.notify();
2381 NotifyOption::SkipPersistHandleEvents =>
2382 $self.event_persist_notifier.notify(),
2383 NotifyOption::SkipPersistNoEvents => {},
2389 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>
2391 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
2392 T::Target: BroadcasterInterface,
2393 ES::Target: EntropySource,
2394 NS::Target: NodeSigner,
2395 SP::Target: SignerProvider,
2396 F::Target: FeeEstimator,
2400 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2402 /// The current time or latest block header time can be provided as the `current_timestamp`.
2404 /// This is the main "logic hub" for all channel-related actions, and implements
2405 /// [`ChannelMessageHandler`].
2407 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2409 /// Users need to notify the new `ChannelManager` when a new block is connected or
2410 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2411 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2414 /// [`block_connected`]: chain::Listen::block_connected
2415 /// [`block_disconnected`]: chain::Listen::block_disconnected
2416 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2418 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2419 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2420 current_timestamp: u32,
2422 let mut secp_ctx = Secp256k1::new();
2423 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2424 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2425 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2427 default_configuration: config.clone(),
2428 chain_hash: ChainHash::using_genesis_block(params.network),
2429 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2434 best_block: RwLock::new(params.best_block),
2436 outbound_scid_aliases: Mutex::new(HashSet::new()),
2437 pending_inbound_payments: Mutex::new(HashMap::new()),
2438 pending_outbound_payments: OutboundPayments::new(),
2439 forward_htlcs: Mutex::new(HashMap::new()),
2440 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2441 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2442 outpoint_to_peer: Mutex::new(HashMap::new()),
2443 short_to_chan_info: FairRwLock::new(HashMap::new()),
2445 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2448 inbound_payment_key: expanded_inbound_key,
2449 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2451 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2453 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2455 per_peer_state: FairRwLock::new(HashMap::new()),
2457 pending_events: Mutex::new(VecDeque::new()),
2458 pending_events_processor: AtomicBool::new(false),
2459 pending_background_events: Mutex::new(Vec::new()),
2460 total_consistency_lock: RwLock::new(()),
2461 background_events_processed_since_startup: AtomicBool::new(false),
2462 event_persist_notifier: Notifier::new(),
2463 needs_persist_flag: AtomicBool::new(false),
2464 funding_batch_states: Mutex::new(BTreeMap::new()),
2466 pending_offers_messages: Mutex::new(Vec::new()),
2476 /// Gets the current configuration applied to all new channels.
2477 pub fn get_current_default_configuration(&self) -> &UserConfig {
2478 &self.default_configuration
2481 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2482 let height = self.best_block.read().unwrap().height();
2483 let mut outbound_scid_alias = 0;
2486 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2487 outbound_scid_alias += 1;
2489 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2491 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2495 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"); }
2500 /// Creates a new outbound channel to the given remote node and with the given value.
2502 /// `user_channel_id` will be provided back as in
2503 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2504 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2505 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2506 /// is simply copied to events and otherwise ignored.
2508 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2509 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2511 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2512 /// generate a shutdown scriptpubkey or destination script set by
2513 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2515 /// Note that we do not check if you are currently connected to the given peer. If no
2516 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2517 /// the channel eventually being silently forgotten (dropped on reload).
2519 /// If `temporary_channel_id` is specified, it will be used as the temporary channel ID of the
2520 /// channel. Otherwise, a random one will be generated for you.
2522 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2523 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2524 /// [`ChannelDetails::channel_id`] until after
2525 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2526 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2527 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2529 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2530 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2531 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2532 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> {
2533 if channel_value_satoshis < 1000 {
2534 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2537 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2538 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2539 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2541 let per_peer_state = self.per_peer_state.read().unwrap();
2543 let peer_state_mutex = per_peer_state.get(&their_network_key)
2544 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2546 let mut peer_state = peer_state_mutex.lock().unwrap();
2548 if let Some(temporary_channel_id) = temporary_channel_id {
2549 if peer_state.channel_by_id.contains_key(&temporary_channel_id) {
2550 return Err(APIError::APIMisuseError{ err: format!("Channel with temporary channel ID {} already exists!", temporary_channel_id)});
2555 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2556 let their_features = &peer_state.latest_features;
2557 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2558 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2559 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2560 self.best_block.read().unwrap().height(), outbound_scid_alias, temporary_channel_id)
2564 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2569 let res = channel.get_open_channel(self.chain_hash);
2571 let temporary_channel_id = channel.context.channel_id();
2572 match peer_state.channel_by_id.entry(temporary_channel_id) {
2573 hash_map::Entry::Occupied(_) => {
2575 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2577 panic!("RNG is bad???");
2580 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2583 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2584 node_id: their_network_key,
2587 Ok(temporary_channel_id)
2590 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2591 // Allocate our best estimate of the number of channels we have in the `res`
2592 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2593 // a scid or a scid alias, and the `outpoint_to_peer` shouldn't be used outside
2594 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2595 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2596 // the same channel.
2597 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2599 let best_block_height = self.best_block.read().unwrap().height();
2600 let per_peer_state = self.per_peer_state.read().unwrap();
2601 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2602 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2603 let peer_state = &mut *peer_state_lock;
2604 res.extend(peer_state.channel_by_id.iter()
2605 .filter_map(|(chan_id, phase)| match phase {
2606 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2607 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2611 .map(|(_channel_id, channel)| {
2612 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2613 peer_state.latest_features.clone(), &self.fee_estimator)
2621 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2622 /// more information.
2623 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2624 // Allocate our best estimate of the number of channels we have in the `res`
2625 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2626 // a scid or a scid alias, and the `outpoint_to_peer` shouldn't be used outside
2627 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2628 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2629 // the same channel.
2630 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2632 let best_block_height = self.best_block.read().unwrap().height();
2633 let per_peer_state = self.per_peer_state.read().unwrap();
2634 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2635 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2636 let peer_state = &mut *peer_state_lock;
2637 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2638 let details = ChannelDetails::from_channel_context(context, best_block_height,
2639 peer_state.latest_features.clone(), &self.fee_estimator);
2647 /// Gets the list of usable channels, in random order. Useful as an argument to
2648 /// [`Router::find_route`] to ensure non-announced channels are used.
2650 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2651 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2653 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2654 // Note we use is_live here instead of usable which leads to somewhat confused
2655 // internal/external nomenclature, but that's ok cause that's probably what the user
2656 // really wanted anyway.
2657 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2660 /// Gets the list of channels we have with a given counterparty, in random order.
2661 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2662 let best_block_height = self.best_block.read().unwrap().height();
2663 let per_peer_state = self.per_peer_state.read().unwrap();
2665 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2666 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2667 let peer_state = &mut *peer_state_lock;
2668 let features = &peer_state.latest_features;
2669 let context_to_details = |context| {
2670 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2672 return peer_state.channel_by_id
2674 .map(|(_, phase)| phase.context())
2675 .map(context_to_details)
2681 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2682 /// successful path, or have unresolved HTLCs.
2684 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2685 /// result of a crash. If such a payment exists, is not listed here, and an
2686 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2688 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2689 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2690 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2691 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2692 PendingOutboundPayment::AwaitingInvoice { .. } => {
2693 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2695 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2696 PendingOutboundPayment::InvoiceReceived { .. } => {
2697 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2699 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2700 Some(RecentPaymentDetails::Pending {
2701 payment_id: *payment_id,
2702 payment_hash: *payment_hash,
2703 total_msat: *total_msat,
2706 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2707 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2709 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2710 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2712 PendingOutboundPayment::Legacy { .. } => None
2717 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> {
2718 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2720 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
2721 let mut shutdown_result = None;
2724 let per_peer_state = self.per_peer_state.read().unwrap();
2726 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2727 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2729 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2730 let peer_state = &mut *peer_state_lock;
2732 match peer_state.channel_by_id.entry(channel_id.clone()) {
2733 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2734 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2735 let funding_txo_opt = chan.context.get_funding_txo();
2736 let their_features = &peer_state.latest_features;
2737 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2738 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2739 failed_htlcs = htlcs;
2741 // We can send the `shutdown` message before updating the `ChannelMonitor`
2742 // here as we don't need the monitor update to complete until we send a
2743 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2744 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2745 node_id: *counterparty_node_id,
2749 debug_assert!(monitor_update_opt.is_none() || !chan.is_shutdown(),
2750 "We can't both complete shutdown and generate a monitor update");
2752 // Update the monitor with the shutdown script if necessary.
2753 if let Some(monitor_update) = monitor_update_opt.take() {
2754 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2755 peer_state_lock, peer_state, per_peer_state, chan);
2758 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2759 shutdown_result = Some(chan_phase.context_mut().force_shutdown(false, ClosureReason::HolderForceClosed));
2762 hash_map::Entry::Vacant(_) => {
2763 return Err(APIError::ChannelUnavailable {
2765 "Channel with id {} not found for the passed counterparty node_id {}",
2766 channel_id, counterparty_node_id,
2773 for htlc_source in failed_htlcs.drain(..) {
2774 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2775 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2776 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2779 if let Some(shutdown_result) = shutdown_result {
2780 self.finish_close_channel(shutdown_result);
2786 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2787 /// will be accepted on the given channel, and after additional timeout/the closing of all
2788 /// pending HTLCs, the channel will be closed on chain.
2790 /// * If we are the channel initiator, we will pay between our [`ChannelCloseMinimum`] and
2791 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2793 /// * If our counterparty is the channel initiator, we will require a channel closing
2794 /// transaction feerate of at least our [`ChannelCloseMinimum`] feerate or the feerate which
2795 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2796 /// counterparty to pay as much fee as they'd like, however.
2798 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2800 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2801 /// generate a shutdown scriptpubkey or destination script set by
2802 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2805 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2806 /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
2807 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2808 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2809 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2810 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2813 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2814 /// will be accepted on the given channel, and after additional timeout/the closing of all
2815 /// pending HTLCs, the channel will be closed on chain.
2817 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2818 /// the channel being closed or not:
2819 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2820 /// transaction. The upper-bound is set by
2821 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2822 /// fee estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2823 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2824 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2825 /// will appear on a force-closure transaction, whichever is lower).
2827 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2828 /// Will fail if a shutdown script has already been set for this channel by
2829 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2830 /// also be compatible with our and the counterparty's features.
2832 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2834 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2835 /// generate a shutdown scriptpubkey or destination script set by
2836 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2839 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2840 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2841 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2842 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> {
2843 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2846 fn finish_close_channel(&self, mut shutdown_res: ShutdownResult) {
2847 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
2848 #[cfg(debug_assertions)]
2849 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
2850 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
2853 let logger = WithContext::from(
2854 &self.logger, Some(shutdown_res.counterparty_node_id), Some(shutdown_res.channel_id),
2857 log_debug!(logger, "Finishing closure of channel due to {} with {} HTLCs to fail",
2858 shutdown_res.closure_reason, shutdown_res.dropped_outbound_htlcs.len());
2859 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
2860 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2861 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2862 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2863 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2865 if let Some((_, funding_txo, _channel_id, monitor_update)) = shutdown_res.monitor_update {
2866 // There isn't anything we can do if we get an update failure - we're already
2867 // force-closing. The monitor update on the required in-memory copy should broadcast
2868 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2869 // ignore the result here.
2870 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2872 let mut shutdown_results = Vec::new();
2873 if let Some(txid) = shutdown_res.unbroadcasted_batch_funding_txid {
2874 let mut funding_batch_states = self.funding_batch_states.lock().unwrap();
2875 let affected_channels = funding_batch_states.remove(&txid).into_iter().flatten();
2876 let per_peer_state = self.per_peer_state.read().unwrap();
2877 let mut has_uncompleted_channel = None;
2878 for (channel_id, counterparty_node_id, state) in affected_channels {
2879 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2880 let mut peer_state = peer_state_mutex.lock().unwrap();
2881 if let Some(mut chan) = peer_state.channel_by_id.remove(&channel_id) {
2882 update_maps_on_chan_removal!(self, &chan.context());
2883 shutdown_results.push(chan.context_mut().force_shutdown(false, ClosureReason::FundingBatchClosure));
2886 has_uncompleted_channel = Some(has_uncompleted_channel.map_or(!state, |v| v || !state));
2889 has_uncompleted_channel.unwrap_or(true),
2890 "Closing a batch where all channels have completed initial monitor update",
2895 let mut pending_events = self.pending_events.lock().unwrap();
2896 pending_events.push_back((events::Event::ChannelClosed {
2897 channel_id: shutdown_res.channel_id,
2898 user_channel_id: shutdown_res.user_channel_id,
2899 reason: shutdown_res.closure_reason,
2900 counterparty_node_id: Some(shutdown_res.counterparty_node_id),
2901 channel_capacity_sats: Some(shutdown_res.channel_capacity_satoshis),
2902 channel_funding_txo: shutdown_res.channel_funding_txo,
2905 if let Some(transaction) = shutdown_res.unbroadcasted_funding_tx {
2906 pending_events.push_back((events::Event::DiscardFunding {
2907 channel_id: shutdown_res.channel_id, transaction
2911 for shutdown_result in shutdown_results.drain(..) {
2912 self.finish_close_channel(shutdown_result);
2916 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2917 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2918 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2919 -> Result<PublicKey, APIError> {
2920 let per_peer_state = self.per_peer_state.read().unwrap();
2921 let peer_state_mutex = per_peer_state.get(peer_node_id)
2922 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2923 let (update_opt, counterparty_node_id) = {
2924 let mut peer_state = peer_state_mutex.lock().unwrap();
2925 let closure_reason = if let Some(peer_msg) = peer_msg {
2926 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2928 ClosureReason::HolderForceClosed
2930 let logger = WithContext::from(&self.logger, Some(*peer_node_id), Some(*channel_id));
2931 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2932 log_error!(logger, "Force-closing channel {}", channel_id);
2933 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2934 mem::drop(peer_state);
2935 mem::drop(per_peer_state);
2937 ChannelPhase::Funded(mut chan) => {
2938 self.finish_close_channel(chan.context.force_shutdown(broadcast, closure_reason));
2939 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2941 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2942 self.finish_close_channel(chan_phase.context_mut().force_shutdown(false, closure_reason));
2943 // Unfunded channel has no update
2944 (None, chan_phase.context().get_counterparty_node_id())
2947 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2948 log_error!(logger, "Force-closing channel {}", &channel_id);
2949 // N.B. that we don't send any channel close event here: we
2950 // don't have a user_channel_id, and we never sent any opening
2952 (None, *peer_node_id)
2954 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2957 if let Some(update) = update_opt {
2958 // Try to send the `BroadcastChannelUpdate` to the peer we just force-closed on, but if
2959 // not try to broadcast it via whatever peer we have.
2960 let per_peer_state = self.per_peer_state.read().unwrap();
2961 let a_peer_state_opt = per_peer_state.get(peer_node_id)
2962 .ok_or(per_peer_state.values().next());
2963 if let Ok(a_peer_state_mutex) = a_peer_state_opt {
2964 let mut a_peer_state = a_peer_state_mutex.lock().unwrap();
2965 a_peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2971 Ok(counterparty_node_id)
2974 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2975 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2976 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2977 Ok(counterparty_node_id) => {
2978 let per_peer_state = self.per_peer_state.read().unwrap();
2979 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2980 let mut peer_state = peer_state_mutex.lock().unwrap();
2981 peer_state.pending_msg_events.push(
2982 events::MessageSendEvent::HandleError {
2983 node_id: counterparty_node_id,
2984 action: msgs::ErrorAction::DisconnectPeer {
2985 msg: Some(msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() })
2996 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2997 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2998 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
3000 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
3001 -> Result<(), APIError> {
3002 self.force_close_sending_error(channel_id, counterparty_node_id, true)
3005 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
3006 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
3007 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
3009 /// You can always get the latest local transaction(s) to broadcast from
3010 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
3011 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
3012 -> Result<(), APIError> {
3013 self.force_close_sending_error(channel_id, counterparty_node_id, false)
3016 /// Force close all channels, immediately broadcasting the latest local commitment transaction
3017 /// for each to the chain and rejecting new HTLCs on each.
3018 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
3019 for chan in self.list_channels() {
3020 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
3024 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
3025 /// local transaction(s).
3026 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
3027 for chan in self.list_channels() {
3028 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
3032 fn decode_update_add_htlc_onion(
3033 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey,
3035 (onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg
3037 let (next_hop, shared_secret, next_packet_details_opt) = decode_incoming_update_add_htlc_onion(
3038 msg, &self.node_signer, &self.logger, &self.secp_ctx
3041 let is_intro_node_forward = match next_hop {
3042 onion_utils::Hop::Forward {
3043 next_hop_data: msgs::InboundOnionPayload::BlindedForward {
3044 intro_node_blinding_point: Some(_), ..
3050 macro_rules! return_err {
3051 ($msg: expr, $err_code: expr, $data: expr) => {
3054 WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id)),
3055 "Failed to accept/forward incoming HTLC: {}", $msg
3057 // If `msg.blinding_point` is set, we must always fail with malformed.
3058 if msg.blinding_point.is_some() {
3059 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
3060 channel_id: msg.channel_id,
3061 htlc_id: msg.htlc_id,
3062 sha256_of_onion: [0; 32],
3063 failure_code: INVALID_ONION_BLINDING,
3067 let (err_code, err_data) = if is_intro_node_forward {
3068 (INVALID_ONION_BLINDING, &[0; 32][..])
3069 } else { ($err_code, $data) };
3070 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3071 channel_id: msg.channel_id,
3072 htlc_id: msg.htlc_id,
3073 reason: HTLCFailReason::reason(err_code, err_data.to_vec())
3074 .get_encrypted_failure_packet(&shared_secret, &None),
3080 let NextPacketDetails {
3081 next_packet_pubkey, outgoing_amt_msat, outgoing_scid, outgoing_cltv_value
3082 } = match next_packet_details_opt {
3083 Some(next_packet_details) => next_packet_details,
3084 // it is a receive, so no need for outbound checks
3085 None => return Ok((next_hop, shared_secret, None)),
3088 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
3089 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
3090 if let Some((err, mut code, chan_update)) = loop {
3091 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
3092 let forwarding_chan_info_opt = match id_option {
3093 None => { // unknown_next_peer
3094 // Note that this is likely a timing oracle for detecting whether an scid is a
3095 // phantom or an intercept.
3096 if (self.default_configuration.accept_intercept_htlcs &&
3097 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)) ||
3098 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)
3102 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3105 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
3107 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
3108 let per_peer_state = self.per_peer_state.read().unwrap();
3109 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3110 if peer_state_mutex_opt.is_none() {
3111 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3113 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3114 let peer_state = &mut *peer_state_lock;
3115 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
3116 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
3119 // Channel was removed. The short_to_chan_info and channel_by_id maps
3120 // have no consistency guarantees.
3121 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3125 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3126 // Note that the behavior here should be identical to the above block - we
3127 // should NOT reveal the existence or non-existence of a private channel if
3128 // we don't allow forwards outbound over them.
3129 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3131 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3132 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3133 // "refuse to forward unless the SCID alias was used", so we pretend
3134 // we don't have the channel here.
3135 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3137 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3139 // Note that we could technically not return an error yet here and just hope
3140 // that the connection is reestablished or monitor updated by the time we get
3141 // around to doing the actual forward, but better to fail early if we can and
3142 // hopefully an attacker trying to path-trace payments cannot make this occur
3143 // on a small/per-node/per-channel scale.
3144 if !chan.context.is_live() { // channel_disabled
3145 // If the channel_update we're going to return is disabled (i.e. the
3146 // peer has been disabled for some time), return `channel_disabled`,
3147 // otherwise return `temporary_channel_failure`.
3148 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3149 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3151 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3154 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3155 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3157 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3158 break Some((err, code, chan_update_opt));
3165 let cur_height = self.best_block.read().unwrap().height() + 1;
3167 if let Err((err_msg, code)) = check_incoming_htlc_cltv(
3168 cur_height, outgoing_cltv_value, msg.cltv_expiry
3170 if code & 0x1000 != 0 && chan_update_opt.is_none() {
3171 // We really should set `incorrect_cltv_expiry` here but as we're not
3172 // forwarding over a real channel we can't generate a channel_update
3173 // for it. Instead we just return a generic temporary_node_failure.
3174 break Some((err_msg, 0x2000 | 2, None))
3176 let chan_update_opt = if code & 0x1000 != 0 { chan_update_opt } else { None };
3177 break Some((err_msg, code, chan_update_opt));
3183 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3184 if let Some(chan_update) = chan_update {
3185 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3186 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3188 else if code == 0x1000 | 13 {
3189 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3191 else if code == 0x1000 | 20 {
3192 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3193 0u16.write(&mut res).expect("Writes cannot fail");
3195 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3196 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3197 chan_update.write(&mut res).expect("Writes cannot fail");
3198 } else if code & 0x1000 == 0x1000 {
3199 // If we're trying to return an error that requires a `channel_update` but
3200 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3201 // generate an update), just use the generic "temporary_node_failure"
3205 return_err!(err, code, &res.0[..]);
3207 Ok((next_hop, shared_secret, Some(next_packet_pubkey)))
3210 fn construct_pending_htlc_status<'a>(
3211 &self, msg: &msgs::UpdateAddHTLC, counterparty_node_id: &PublicKey, shared_secret: [u8; 32],
3212 decoded_hop: onion_utils::Hop, allow_underpay: bool,
3213 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>,
3214 ) -> PendingHTLCStatus {
3215 macro_rules! return_err {
3216 ($msg: expr, $err_code: expr, $data: expr) => {
3218 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
3219 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3220 if msg.blinding_point.is_some() {
3221 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(
3222 msgs::UpdateFailMalformedHTLC {
3223 channel_id: msg.channel_id,
3224 htlc_id: msg.htlc_id,
3225 sha256_of_onion: [0; 32],
3226 failure_code: INVALID_ONION_BLINDING,
3230 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3231 channel_id: msg.channel_id,
3232 htlc_id: msg.htlc_id,
3233 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3234 .get_encrypted_failure_packet(&shared_secret, &None),
3240 onion_utils::Hop::Receive(next_hop_data) => {
3242 let current_height: u32 = self.best_block.read().unwrap().height();
3243 match create_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3244 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat,
3245 current_height, self.default_configuration.accept_mpp_keysend)
3248 // Note that we could obviously respond immediately with an update_fulfill_htlc
3249 // message, however that would leak that we are the recipient of this payment, so
3250 // instead we stay symmetric with the forwarding case, only responding (after a
3251 // delay) once they've send us a commitment_signed!
3252 PendingHTLCStatus::Forward(info)
3254 Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3257 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3258 match create_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3259 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3260 Ok(info) => PendingHTLCStatus::Forward(info),
3261 Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3267 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3268 /// public, and thus should be called whenever the result is going to be passed out in a
3269 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3271 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3272 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3273 /// storage and the `peer_state` lock has been dropped.
3275 /// [`channel_update`]: msgs::ChannelUpdate
3276 /// [`internal_closing_signed`]: Self::internal_closing_signed
3277 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3278 if !chan.context.should_announce() {
3279 return Err(LightningError {
3280 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3281 action: msgs::ErrorAction::IgnoreError
3284 if chan.context.get_short_channel_id().is_none() {
3285 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3287 let logger = WithChannelContext::from(&self.logger, &chan.context);
3288 log_trace!(logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3289 self.get_channel_update_for_unicast(chan)
3292 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3293 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3294 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3295 /// provided evidence that they know about the existence of the channel.
3297 /// Note that through [`internal_closing_signed`], this function is called without the
3298 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3299 /// removed from the storage and the `peer_state` lock has been dropped.
3301 /// [`channel_update`]: msgs::ChannelUpdate
3302 /// [`internal_closing_signed`]: Self::internal_closing_signed
3303 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3304 let logger = WithChannelContext::from(&self.logger, &chan.context);
3305 log_trace!(logger, "Attempting to generate channel update for channel {}", chan.context.channel_id());
3306 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3307 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3311 self.get_channel_update_for_onion(short_channel_id, chan)
3314 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3315 let logger = WithChannelContext::from(&self.logger, &chan.context);
3316 log_trace!(logger, "Generating channel update for channel {}", chan.context.channel_id());
3317 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3319 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3320 ChannelUpdateStatus::Enabled => true,
3321 ChannelUpdateStatus::DisabledStaged(_) => true,
3322 ChannelUpdateStatus::Disabled => false,
3323 ChannelUpdateStatus::EnabledStaged(_) => false,
3326 let unsigned = msgs::UnsignedChannelUpdate {
3327 chain_hash: self.chain_hash,
3329 timestamp: chan.context.get_update_time_counter(),
3330 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3331 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3332 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3333 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3334 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3335 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3336 excess_data: Vec::new(),
3338 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3339 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3340 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3342 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3344 Ok(msgs::ChannelUpdate {
3351 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> {
3352 let _lck = self.total_consistency_lock.read().unwrap();
3353 self.send_payment_along_path(SendAlongPathArgs {
3354 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3359 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3360 let SendAlongPathArgs {
3361 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3364 // The top-level caller should hold the total_consistency_lock read lock.
3365 debug_assert!(self.total_consistency_lock.try_write().is_err());
3366 let prng_seed = self.entropy_source.get_secure_random_bytes();
3367 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3369 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
3370 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
3371 payment_hash, keysend_preimage, prng_seed
3373 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3374 log_error!(logger, "Failed to build an onion for path for payment hash {}", payment_hash);
3378 let err: Result<(), _> = loop {
3379 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3381 let logger = WithContext::from(&self.logger, Some(path.hops.first().unwrap().pubkey), None);
3382 log_error!(logger, "Failed to find first-hop for payment hash {}", payment_hash);
3383 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()})
3385 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3388 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(id));
3390 "Attempting to send payment with payment hash {} along path with next hop {}",
3391 payment_hash, path.hops.first().unwrap().short_channel_id);
3393 let per_peer_state = self.per_peer_state.read().unwrap();
3394 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3395 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3396 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3397 let peer_state = &mut *peer_state_lock;
3398 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3399 match chan_phase_entry.get_mut() {
3400 ChannelPhase::Funded(chan) => {
3401 if !chan.context.is_live() {
3402 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3404 let funding_txo = chan.context.get_funding_txo().unwrap();
3405 let logger = WithChannelContext::from(&self.logger, &chan.context);
3406 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3407 htlc_cltv, HTLCSource::OutboundRoute {
3409 session_priv: session_priv.clone(),
3410 first_hop_htlc_msat: htlc_msat,
3412 }, onion_packet, None, &self.fee_estimator, &&logger);
3413 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3414 Some(monitor_update) => {
3415 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3417 // Note that MonitorUpdateInProgress here indicates (per function
3418 // docs) that we will resend the commitment update once monitor
3419 // updating completes. Therefore, we must return an error
3420 // indicating that it is unsafe to retry the payment wholesale,
3421 // which we do in the send_payment check for
3422 // MonitorUpdateInProgress, below.
3423 return Err(APIError::MonitorUpdateInProgress);
3431 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3434 // The channel was likely removed after we fetched the id from the
3435 // `short_to_chan_info` map, but before we successfully locked the
3436 // `channel_by_id` map.
3437 // This can occur as no consistency guarantees exists between the two maps.
3438 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3442 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3443 Ok(_) => unreachable!(),
3445 Err(APIError::ChannelUnavailable { err: e.err })
3450 /// Sends a payment along a given route.
3452 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3453 /// fields for more info.
3455 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3456 /// [`PeerManager::process_events`]).
3458 /// # Avoiding Duplicate Payments
3460 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3461 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3462 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3463 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3464 /// second payment with the same [`PaymentId`].
3466 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3467 /// tracking of payments, including state to indicate once a payment has completed. Because you
3468 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3469 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3470 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3472 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3473 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3474 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3475 /// [`ChannelManager::list_recent_payments`] for more information.
3477 /// # Possible Error States on [`PaymentSendFailure`]
3479 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3480 /// each entry matching the corresponding-index entry in the route paths, see
3481 /// [`PaymentSendFailure`] for more info.
3483 /// In general, a path may raise:
3484 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3485 /// node public key) is specified.
3486 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3487 /// closed, doesn't exist, or the peer is currently disconnected.
3488 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3489 /// relevant updates.
3491 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3492 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3493 /// different route unless you intend to pay twice!
3495 /// [`RouteHop`]: crate::routing::router::RouteHop
3496 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3497 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3498 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3499 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3500 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3501 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3502 let best_block_height = self.best_block.read().unwrap().height();
3503 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3504 self.pending_outbound_payments
3505 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3506 &self.entropy_source, &self.node_signer, best_block_height,
3507 |args| self.send_payment_along_path(args))
3510 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3511 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3512 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3513 let best_block_height = self.best_block.read().unwrap().height();
3514 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3515 self.pending_outbound_payments
3516 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3517 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3518 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3519 &self.pending_events, |args| self.send_payment_along_path(args))
3523 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> {
3524 let best_block_height = self.best_block.read().unwrap().height();
3525 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3526 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3527 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3528 best_block_height, |args| self.send_payment_along_path(args))
3532 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> {
3533 let best_block_height = self.best_block.read().unwrap().height();
3534 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3538 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3539 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3542 pub(super) fn send_payment_for_bolt12_invoice(&self, invoice: &Bolt12Invoice, payment_id: PaymentId) -> Result<(), Bolt12PaymentError> {
3543 let best_block_height = self.best_block.read().unwrap().height();
3544 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3545 self.pending_outbound_payments
3546 .send_payment_for_bolt12_invoice(
3547 invoice, payment_id, &self.router, self.list_usable_channels(),
3548 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer,
3549 best_block_height, &self.logger, &self.pending_events,
3550 |args| self.send_payment_along_path(args)
3554 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3555 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3556 /// retries are exhausted.
3558 /// # Event Generation
3560 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3561 /// as there are no remaining pending HTLCs for this payment.
3563 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3564 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3565 /// determine the ultimate status of a payment.
3567 /// # Requested Invoices
3569 /// In the case of paying a [`Bolt12Invoice`] via [`ChannelManager::pay_for_offer`], abandoning
3570 /// the payment prior to receiving the invoice will result in an [`Event::InvoiceRequestFailed`]
3571 /// and prevent any attempts at paying it once received. The other events may only be generated
3572 /// once the invoice has been received.
3574 /// # Restart Behavior
3576 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3577 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3578 /// [`Event::InvoiceRequestFailed`].
3580 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3581 pub fn abandon_payment(&self, payment_id: PaymentId) {
3582 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3583 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3586 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3587 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3588 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3589 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3590 /// never reach the recipient.
3592 /// See [`send_payment`] documentation for more details on the return value of this function
3593 /// and idempotency guarantees provided by the [`PaymentId`] key.
3595 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3596 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3598 /// [`send_payment`]: Self::send_payment
3599 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3600 let best_block_height = self.best_block.read().unwrap().height();
3601 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3602 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3603 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3604 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3607 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3608 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3610 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3613 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3614 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> {
3615 let best_block_height = self.best_block.read().unwrap().height();
3616 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3617 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3618 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3619 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3620 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3623 /// Send a payment that is probing the given route for liquidity. We calculate the
3624 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3625 /// us to easily discern them from real payments.
3626 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3627 let best_block_height = self.best_block.read().unwrap().height();
3628 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3629 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3630 &self.entropy_source, &self.node_signer, best_block_height,
3631 |args| self.send_payment_along_path(args))
3634 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3637 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3638 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3641 /// Sends payment probes over all paths of a route that would be used to pay the given
3642 /// amount to the given `node_id`.
3644 /// See [`ChannelManager::send_preflight_probes`] for more information.
3645 pub fn send_spontaneous_preflight_probes(
3646 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3647 liquidity_limit_multiplier: Option<u64>,
3648 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3649 let payment_params =
3650 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3652 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
3654 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3657 /// Sends payment probes over all paths of a route that would be used to pay a route found
3658 /// according to the given [`RouteParameters`].
3660 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3661 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3662 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3663 /// confirmation in a wallet UI.
3665 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3666 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3667 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3668 /// payment. To mitigate this issue, channels with available liquidity less than the required
3669 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3670 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3671 pub fn send_preflight_probes(
3672 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3673 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3674 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3676 let payer = self.get_our_node_id();
3677 let usable_channels = self.list_usable_channels();
3678 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3679 let inflight_htlcs = self.compute_inflight_htlcs();
3683 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3685 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3686 ProbeSendFailure::RouteNotFound
3689 let mut used_liquidity_map = HashMap::with_capacity(first_hops.len());
3691 let mut res = Vec::new();
3693 for mut path in route.paths {
3694 // If the last hop is probably an unannounced channel we refrain from probing all the
3695 // way through to the end and instead probe up to the second-to-last channel.
3696 while let Some(last_path_hop) = path.hops.last() {
3697 if last_path_hop.maybe_announced_channel {
3698 // We found a potentially announced last hop.
3701 // Drop the last hop, as it's likely unannounced.
3704 "Avoided sending payment probe all the way to last hop {} as it is likely unannounced.",
3705 last_path_hop.short_channel_id
3707 let final_value_msat = path.final_value_msat();
3709 if let Some(new_last) = path.hops.last_mut() {
3710 new_last.fee_msat += final_value_msat;
3715 if path.hops.len() < 2 {
3718 "Skipped sending payment probe over path with less than two hops."
3723 if let Some(first_path_hop) = path.hops.first() {
3724 if let Some(first_hop) = first_hops.iter().find(|h| {
3725 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3727 let path_value = path.final_value_msat() + path.fee_msat();
3728 let used_liquidity =
3729 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3731 if first_hop.next_outbound_htlc_limit_msat
3732 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3734 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3737 *used_liquidity += path_value;
3742 res.push(self.send_probe(path).map_err(|e| {
3743 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3744 ProbeSendFailure::SendingFailed(e)
3751 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3752 /// which checks the correctness of the funding transaction given the associated channel.
3753 fn funding_transaction_generated_intern<FundingOutput: FnMut(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3754 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, is_batch_funding: bool,
3755 mut find_funding_output: FundingOutput,
3756 ) -> Result<(), APIError> {
3757 let per_peer_state = self.per_peer_state.read().unwrap();
3758 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3759 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3761 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3762 let peer_state = &mut *peer_state_lock;
3764 let (mut chan, msg_opt) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3765 Some(ChannelPhase::UnfundedOutboundV1(mut chan)) => {
3766 funding_txo = find_funding_output(&chan, &funding_transaction)?;
3768 let logger = WithChannelContext::from(&self.logger, &chan.context);
3769 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, is_batch_funding, &&logger)
3770 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3771 let channel_id = chan.context.channel_id();
3772 let reason = ClosureReason::ProcessingError { err: msg.clone() };
3773 let shutdown_res = chan.context.force_shutdown(false, reason);
3774 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, None))
3775 } else { unreachable!(); });
3777 Ok(funding_msg) => (chan, funding_msg),
3778 Err((chan, err)) => {
3779 mem::drop(peer_state_lock);
3780 mem::drop(per_peer_state);
3781 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3782 return Err(APIError::ChannelUnavailable {
3783 err: "Signer refused to sign the initial commitment transaction".to_owned()
3789 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3790 return Err(APIError::APIMisuseError {
3792 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3793 temporary_channel_id, counterparty_node_id),
3796 None => return Err(APIError::ChannelUnavailable {err: format!(
3797 "Channel with id {} not found for the passed counterparty node_id {}",
3798 temporary_channel_id, counterparty_node_id),
3802 if let Some(msg) = msg_opt {
3803 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3804 node_id: chan.context.get_counterparty_node_id(),
3808 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3809 hash_map::Entry::Occupied(_) => {
3810 panic!("Generated duplicate funding txid?");
3812 hash_map::Entry::Vacant(e) => {
3813 let mut outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
3814 match outpoint_to_peer.entry(funding_txo) {
3815 hash_map::Entry::Vacant(e) => { e.insert(chan.context.get_counterparty_node_id()); },
3816 hash_map::Entry::Occupied(o) => {
3818 "An existing channel using outpoint {} is open with peer {}",
3819 funding_txo, o.get()
3821 mem::drop(outpoint_to_peer);
3822 mem::drop(peer_state_lock);
3823 mem::drop(per_peer_state);
3824 let reason = ClosureReason::ProcessingError { err: err.clone() };
3825 self.finish_close_channel(chan.context.force_shutdown(true, reason));
3826 return Err(APIError::ChannelUnavailable { err });
3829 e.insert(ChannelPhase::UnfundedOutboundV1(chan));
3836 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3837 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, false, |_, tx| {
3838 Ok(OutPoint { txid: tx.txid(), index: output_index })
3842 /// Call this upon creation of a funding transaction for the given channel.
3844 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3845 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3847 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3848 /// across the p2p network.
3850 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3851 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3853 /// May panic if the output found in the funding transaction is duplicative with some other
3854 /// channel (note that this should be trivially prevented by using unique funding transaction
3855 /// keys per-channel).
3857 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3858 /// counterparty's signature the funding transaction will automatically be broadcast via the
3859 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3861 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3862 /// not currently support replacing a funding transaction on an existing channel. Instead,
3863 /// create a new channel with a conflicting funding transaction.
3865 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3866 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3867 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3868 /// for more details.
3870 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3871 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3872 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3873 self.batch_funding_transaction_generated(&[(temporary_channel_id, counterparty_node_id)], funding_transaction)
3876 /// Call this upon creation of a batch funding transaction for the given channels.
3878 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
3879 /// each individual channel and transaction output.
3881 /// Do NOT broadcast the funding transaction yourself. This batch funding transaction
3882 /// will only be broadcast when we have safely received and persisted the counterparty's
3883 /// signature for each channel.
3885 /// If there is an error, all channels in the batch are to be considered closed.
3886 pub fn batch_funding_transaction_generated(&self, temporary_channels: &[(&ChannelId, &PublicKey)], funding_transaction: Transaction) -> Result<(), APIError> {
3887 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3888 let mut result = Ok(());
3890 if !funding_transaction.is_coin_base() {
3891 for inp in funding_transaction.input.iter() {
3892 if inp.witness.is_empty() {
3893 result = result.and(Err(APIError::APIMisuseError {
3894 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3899 if funding_transaction.output.len() > u16::max_value() as usize {
3900 result = result.and(Err(APIError::APIMisuseError {
3901 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3905 let height = self.best_block.read().unwrap().height();
3906 // Transactions are evaluated as final by network mempools if their locktime is strictly
3907 // lower than the next block height. However, the modules constituting our Lightning
3908 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3909 // module is ahead of LDK, only allow one more block of headroom.
3910 if !funding_transaction.input.iter().all(|input| input.sequence == Sequence::MAX) &&
3911 funding_transaction.lock_time.is_block_height() &&
3912 funding_transaction.lock_time.to_consensus_u32() > height + 1
3914 result = result.and(Err(APIError::APIMisuseError {
3915 err: "Funding transaction absolute timelock is non-final".to_owned()
3920 let txid = funding_transaction.txid();
3921 let is_batch_funding = temporary_channels.len() > 1;
3922 let mut funding_batch_states = if is_batch_funding {
3923 Some(self.funding_batch_states.lock().unwrap())
3927 let mut funding_batch_state = funding_batch_states.as_mut().and_then(|states| {
3928 match states.entry(txid) {
3929 btree_map::Entry::Occupied(_) => {
3930 result = result.clone().and(Err(APIError::APIMisuseError {
3931 err: "Batch funding transaction with the same txid already exists".to_owned()
3935 btree_map::Entry::Vacant(vacant) => Some(vacant.insert(Vec::new())),
3938 for &(temporary_channel_id, counterparty_node_id) in temporary_channels {
3939 result = result.and_then(|_| self.funding_transaction_generated_intern(
3940 temporary_channel_id,
3941 counterparty_node_id,
3942 funding_transaction.clone(),
3945 let mut output_index = None;
3946 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3947 for (idx, outp) in tx.output.iter().enumerate() {
3948 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3949 if output_index.is_some() {
3950 return Err(APIError::APIMisuseError {
3951 err: "Multiple outputs matched the expected script and value".to_owned()
3954 output_index = Some(idx as u16);
3957 if output_index.is_none() {
3958 return Err(APIError::APIMisuseError {
3959 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3962 let outpoint = OutPoint { txid: tx.txid(), index: output_index.unwrap() };
3963 if let Some(funding_batch_state) = funding_batch_state.as_mut() {
3964 // TODO(dual_funding): We only do batch funding for V1 channels at the moment, but we'll probably
3965 // need to fix this somehow to not rely on using the outpoint for the channel ID if we
3966 // want to support V2 batching here as well.
3967 funding_batch_state.push((ChannelId::v1_from_funding_outpoint(outpoint), *counterparty_node_id, false));
3973 if let Err(ref e) = result {
3974 // Remaining channels need to be removed on any error.
3975 let e = format!("Error in transaction funding: {:?}", e);
3976 let mut channels_to_remove = Vec::new();
3977 channels_to_remove.extend(funding_batch_states.as_mut()
3978 .and_then(|states| states.remove(&txid))
3979 .into_iter().flatten()
3980 .map(|(chan_id, node_id, _state)| (chan_id, node_id))
3982 channels_to_remove.extend(temporary_channels.iter()
3983 .map(|(&chan_id, &node_id)| (chan_id, node_id))
3985 let mut shutdown_results = Vec::new();
3987 let per_peer_state = self.per_peer_state.read().unwrap();
3988 for (channel_id, counterparty_node_id) in channels_to_remove {
3989 per_peer_state.get(&counterparty_node_id)
3990 .map(|peer_state_mutex| peer_state_mutex.lock().unwrap())
3991 .and_then(|mut peer_state| peer_state.channel_by_id.remove(&channel_id))
3993 update_maps_on_chan_removal!(self, &chan.context());
3994 let closure_reason = ClosureReason::ProcessingError { err: e.clone() };
3995 shutdown_results.push(chan.context_mut().force_shutdown(false, closure_reason));
3999 mem::drop(funding_batch_states);
4000 for shutdown_result in shutdown_results.drain(..) {
4001 self.finish_close_channel(shutdown_result);
4007 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
4009 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4010 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4011 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4012 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4014 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4015 /// `counterparty_node_id` is provided.
4017 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4018 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4020 /// If an error is returned, none of the updates should be considered applied.
4022 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4023 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4024 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4025 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4026 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4027 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4028 /// [`APIMisuseError`]: APIError::APIMisuseError
4029 pub fn update_partial_channel_config(
4030 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
4031 ) -> Result<(), APIError> {
4032 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
4033 return Err(APIError::APIMisuseError {
4034 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
4038 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4039 let per_peer_state = self.per_peer_state.read().unwrap();
4040 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4041 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4042 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4043 let peer_state = &mut *peer_state_lock;
4044 for channel_id in channel_ids {
4045 if !peer_state.has_channel(channel_id) {
4046 return Err(APIError::ChannelUnavailable {
4047 err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, counterparty_node_id),
4051 for channel_id in channel_ids {
4052 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
4053 let mut config = channel_phase.context().config();
4054 config.apply(config_update);
4055 if !channel_phase.context_mut().update_config(&config) {
4058 if let ChannelPhase::Funded(channel) = channel_phase {
4059 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
4060 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
4061 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
4062 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4063 node_id: channel.context.get_counterparty_node_id(),
4070 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
4071 debug_assert!(false);
4072 return Err(APIError::ChannelUnavailable {
4074 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
4075 channel_id, counterparty_node_id),
4082 /// Atomically updates the [`ChannelConfig`] for the given channels.
4084 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4085 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4086 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4087 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4089 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4090 /// `counterparty_node_id` is provided.
4092 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4093 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4095 /// If an error is returned, none of the updates should be considered applied.
4097 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4098 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4099 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4100 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4101 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4102 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4103 /// [`APIMisuseError`]: APIError::APIMisuseError
4104 pub fn update_channel_config(
4105 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
4106 ) -> Result<(), APIError> {
4107 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
4110 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
4111 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
4113 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
4114 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
4116 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
4117 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
4118 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
4119 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
4120 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
4122 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
4123 /// you from forwarding more than you received. See
4124 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
4127 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4130 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
4131 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4132 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
4133 // TODO: when we move to deciding the best outbound channel at forward time, only take
4134 // `next_node_id` and not `next_hop_channel_id`
4135 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> {
4136 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4138 let next_hop_scid = {
4139 let peer_state_lock = self.per_peer_state.read().unwrap();
4140 let peer_state_mutex = peer_state_lock.get(&next_node_id)
4141 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
4142 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4143 let peer_state = &mut *peer_state_lock;
4144 match peer_state.channel_by_id.get(next_hop_channel_id) {
4145 Some(ChannelPhase::Funded(chan)) => {
4146 if !chan.context.is_usable() {
4147 return Err(APIError::ChannelUnavailable {
4148 err: format!("Channel with id {} not fully established", next_hop_channel_id)
4151 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
4153 Some(_) => return Err(APIError::ChannelUnavailable {
4154 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
4155 next_hop_channel_id, next_node_id)
4158 let error = format!("Channel with id {} not found for the passed counterparty node_id {}",
4159 next_hop_channel_id, next_node_id);
4160 let logger = WithContext::from(&self.logger, Some(next_node_id), Some(*next_hop_channel_id));
4161 log_error!(logger, "{} when attempting to forward intercepted HTLC", error);
4162 return Err(APIError::ChannelUnavailable {
4169 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4170 .ok_or_else(|| APIError::APIMisuseError {
4171 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4174 let routing = match payment.forward_info.routing {
4175 PendingHTLCRouting::Forward { onion_packet, blinded, .. } => {
4176 PendingHTLCRouting::Forward {
4177 onion_packet, blinded, short_channel_id: next_hop_scid
4180 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
4182 let skimmed_fee_msat =
4183 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
4184 let pending_htlc_info = PendingHTLCInfo {
4185 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
4186 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
4189 let mut per_source_pending_forward = [(
4190 payment.prev_short_channel_id,
4191 payment.prev_funding_outpoint,
4192 payment.prev_channel_id,
4193 payment.prev_user_channel_id,
4194 vec![(pending_htlc_info, payment.prev_htlc_id)]
4196 self.forward_htlcs(&mut per_source_pending_forward);
4200 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
4201 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
4203 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4206 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4207 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
4208 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4210 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4211 .ok_or_else(|| APIError::APIMisuseError {
4212 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4215 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
4216 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4217 short_channel_id: payment.prev_short_channel_id,
4218 user_channel_id: Some(payment.prev_user_channel_id),
4219 outpoint: payment.prev_funding_outpoint,
4220 channel_id: payment.prev_channel_id,
4221 htlc_id: payment.prev_htlc_id,
4222 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
4223 phantom_shared_secret: None,
4224 blinded_failure: payment.forward_info.routing.blinded_failure(),
4227 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
4228 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
4229 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
4230 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
4235 /// Processes HTLCs which are pending waiting on random forward delay.
4237 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
4238 /// Will likely generate further events.
4239 pub fn process_pending_htlc_forwards(&self) {
4240 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4242 let mut new_events = VecDeque::new();
4243 let mut failed_forwards = Vec::new();
4244 let mut phantom_receives: Vec<(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
4246 let mut forward_htlcs = HashMap::new();
4247 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
4249 for (short_chan_id, mut pending_forwards) in forward_htlcs {
4250 if short_chan_id != 0 {
4251 let mut forwarding_counterparty = None;
4252 macro_rules! forwarding_channel_not_found {
4254 for forward_info in pending_forwards.drain(..) {
4255 match forward_info {
4256 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4257 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4258 prev_user_channel_id, forward_info: PendingHTLCInfo {
4259 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
4260 outgoing_cltv_value, ..
4263 macro_rules! failure_handler {
4264 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
4265 let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_channel_id));
4266 log_info!(logger, "Failed to accept/forward incoming HTLC: {}", $msg);
4268 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4269 short_channel_id: prev_short_channel_id,
4270 user_channel_id: Some(prev_user_channel_id),
4271 channel_id: prev_channel_id,
4272 outpoint: prev_funding_outpoint,
4273 htlc_id: prev_htlc_id,
4274 incoming_packet_shared_secret: incoming_shared_secret,
4275 phantom_shared_secret: $phantom_ss,
4276 blinded_failure: routing.blinded_failure(),
4279 let reason = if $next_hop_unknown {
4280 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
4282 HTLCDestination::FailedPayment{ payment_hash }
4285 failed_forwards.push((htlc_source, payment_hash,
4286 HTLCFailReason::reason($err_code, $err_data),
4292 macro_rules! fail_forward {
4293 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4295 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4299 macro_rules! failed_payment {
4300 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4302 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4306 if let PendingHTLCRouting::Forward { ref onion_packet, .. } = routing {
4307 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4308 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.chain_hash) {
4309 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4310 let next_hop = match onion_utils::decode_next_payment_hop(
4311 phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac,
4312 payment_hash, None, &self.node_signer
4315 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4316 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).to_byte_array();
4317 // In this scenario, the phantom would have sent us an
4318 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4319 // if it came from us (the second-to-last hop) but contains the sha256
4321 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4323 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4324 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4328 onion_utils::Hop::Receive(hop_data) => {
4329 let current_height: u32 = self.best_block.read().unwrap().height();
4330 match create_recv_pending_htlc_info(hop_data,
4331 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4332 outgoing_cltv_value, Some(phantom_shared_secret), false, None,
4333 current_height, self.default_configuration.accept_mpp_keysend)
4335 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4336 Err(InboundHTLCErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4342 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4345 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4348 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4349 // Channel went away before we could fail it. This implies
4350 // the channel is now on chain and our counterparty is
4351 // trying to broadcast the HTLC-Timeout, but that's their
4352 // problem, not ours.
4358 let chan_info_opt = self.short_to_chan_info.read().unwrap().get(&short_chan_id).cloned();
4359 let (counterparty_node_id, forward_chan_id) = match chan_info_opt {
4360 Some((cp_id, chan_id)) => (cp_id, chan_id),
4362 forwarding_channel_not_found!();
4366 forwarding_counterparty = Some(counterparty_node_id);
4367 let per_peer_state = self.per_peer_state.read().unwrap();
4368 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4369 if peer_state_mutex_opt.is_none() {
4370 forwarding_channel_not_found!();
4373 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4374 let peer_state = &mut *peer_state_lock;
4375 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4376 let logger = WithChannelContext::from(&self.logger, &chan.context);
4377 for forward_info in pending_forwards.drain(..) {
4378 let queue_fail_htlc_res = match forward_info {
4379 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4380 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4381 prev_user_channel_id, forward_info: PendingHTLCInfo {
4382 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4383 routing: PendingHTLCRouting::Forward {
4384 onion_packet, blinded, ..
4385 }, skimmed_fee_msat, ..
4388 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);
4389 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4390 short_channel_id: prev_short_channel_id,
4391 user_channel_id: Some(prev_user_channel_id),
4392 channel_id: prev_channel_id,
4393 outpoint: prev_funding_outpoint,
4394 htlc_id: prev_htlc_id,
4395 incoming_packet_shared_secret: incoming_shared_secret,
4396 // Phantom payments are only PendingHTLCRouting::Receive.
4397 phantom_shared_secret: None,
4398 blinded_failure: blinded.map(|b| b.failure),
4400 let next_blinding_point = blinded.and_then(|b| {
4401 let encrypted_tlvs_ss = self.node_signer.ecdh(
4402 Recipient::Node, &b.inbound_blinding_point, None
4403 ).unwrap().secret_bytes();
4404 onion_utils::next_hop_pubkey(
4405 &self.secp_ctx, b.inbound_blinding_point, &encrypted_tlvs_ss
4408 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4409 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4410 onion_packet, skimmed_fee_msat, next_blinding_point, &self.fee_estimator,
4413 if let ChannelError::Ignore(msg) = e {
4414 log_trace!(logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4416 panic!("Stated return value requirements in send_htlc() were not met");
4418 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4419 failed_forwards.push((htlc_source, payment_hash,
4420 HTLCFailReason::reason(failure_code, data),
4421 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4427 HTLCForwardInfo::AddHTLC { .. } => {
4428 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4430 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4431 log_trace!(logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4432 Some((chan.queue_fail_htlc(htlc_id, err_packet, &&logger), htlc_id))
4434 HTLCForwardInfo::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
4435 log_trace!(logger, "Failing malformed HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4436 let res = chan.queue_fail_malformed_htlc(
4437 htlc_id, failure_code, sha256_of_onion, &&logger
4439 Some((res, htlc_id))
4442 if let Some((queue_fail_htlc_res, htlc_id)) = queue_fail_htlc_res {
4443 if let Err(e) = queue_fail_htlc_res {
4444 if let ChannelError::Ignore(msg) = e {
4445 log_trace!(logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4447 panic!("Stated return value requirements in queue_fail_{{malformed_}}htlc() were not met");
4449 // fail-backs are best-effort, we probably already have one
4450 // pending, and if not that's OK, if not, the channel is on
4451 // the chain and sending the HTLC-Timeout is their problem.
4457 forwarding_channel_not_found!();
4461 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4462 match forward_info {
4463 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4464 prev_short_channel_id, prev_htlc_id, prev_channel_id, prev_funding_outpoint,
4465 prev_user_channel_id, forward_info: PendingHTLCInfo {
4466 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4467 skimmed_fee_msat, ..
4470 let blinded_failure = routing.blinded_failure();
4471 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4472 PendingHTLCRouting::Receive {
4473 payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret,
4474 custom_tlvs, requires_blinded_error: _
4476 let _legacy_hop_data = Some(payment_data.clone());
4477 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4478 payment_metadata, custom_tlvs };
4479 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4480 Some(payment_data), phantom_shared_secret, onion_fields)
4482 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4483 let onion_fields = RecipientOnionFields {
4484 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4488 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4489 payment_data, None, onion_fields)
4492 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4495 let claimable_htlc = ClaimableHTLC {
4496 prev_hop: HTLCPreviousHopData {
4497 short_channel_id: prev_short_channel_id,
4498 user_channel_id: Some(prev_user_channel_id),
4499 channel_id: prev_channel_id,
4500 outpoint: prev_funding_outpoint,
4501 htlc_id: prev_htlc_id,
4502 incoming_packet_shared_secret: incoming_shared_secret,
4503 phantom_shared_secret,
4506 // We differentiate the received value from the sender intended value
4507 // if possible so that we don't prematurely mark MPP payments complete
4508 // if routing nodes overpay
4509 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4510 sender_intended_value: outgoing_amt_msat,
4512 total_value_received: None,
4513 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4516 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4519 let mut committed_to_claimable = false;
4521 macro_rules! fail_htlc {
4522 ($htlc: expr, $payment_hash: expr) => {
4523 debug_assert!(!committed_to_claimable);
4524 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4525 htlc_msat_height_data.extend_from_slice(
4526 &self.best_block.read().unwrap().height().to_be_bytes(),
4528 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4529 short_channel_id: $htlc.prev_hop.short_channel_id,
4530 user_channel_id: $htlc.prev_hop.user_channel_id,
4531 channel_id: prev_channel_id,
4532 outpoint: prev_funding_outpoint,
4533 htlc_id: $htlc.prev_hop.htlc_id,
4534 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4535 phantom_shared_secret,
4538 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4539 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4541 continue 'next_forwardable_htlc;
4544 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4545 let mut receiver_node_id = self.our_network_pubkey;
4546 if phantom_shared_secret.is_some() {
4547 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4548 .expect("Failed to get node_id for phantom node recipient");
4551 macro_rules! check_total_value {
4552 ($purpose: expr) => {{
4553 let mut payment_claimable_generated = false;
4554 let is_keysend = match $purpose {
4555 events::PaymentPurpose::SpontaneousPayment(_) => true,
4556 events::PaymentPurpose::InvoicePayment { .. } => false,
4558 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4559 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4560 fail_htlc!(claimable_htlc, payment_hash);
4562 let ref mut claimable_payment = claimable_payments.claimable_payments
4563 .entry(payment_hash)
4564 // Note that if we insert here we MUST NOT fail_htlc!()
4565 .or_insert_with(|| {
4566 committed_to_claimable = true;
4568 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4571 if $purpose != claimable_payment.purpose {
4572 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4573 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));
4574 fail_htlc!(claimable_htlc, payment_hash);
4576 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4577 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);
4578 fail_htlc!(claimable_htlc, payment_hash);
4580 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4581 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4582 fail_htlc!(claimable_htlc, payment_hash);
4585 claimable_payment.onion_fields = Some(onion_fields);
4587 let ref mut htlcs = &mut claimable_payment.htlcs;
4588 let mut total_value = claimable_htlc.sender_intended_value;
4589 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4590 for htlc in htlcs.iter() {
4591 total_value += htlc.sender_intended_value;
4592 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4593 if htlc.total_msat != claimable_htlc.total_msat {
4594 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4595 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4596 total_value = msgs::MAX_VALUE_MSAT;
4598 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4600 // The condition determining whether an MPP is complete must
4601 // match exactly the condition used in `timer_tick_occurred`
4602 if total_value >= msgs::MAX_VALUE_MSAT {
4603 fail_htlc!(claimable_htlc, payment_hash);
4604 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4605 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4607 fail_htlc!(claimable_htlc, payment_hash);
4608 } else if total_value >= claimable_htlc.total_msat {
4609 #[allow(unused_assignments)] {
4610 committed_to_claimable = true;
4612 htlcs.push(claimable_htlc);
4613 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4614 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4615 let counterparty_skimmed_fee_msat = htlcs.iter()
4616 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4617 debug_assert!(total_value.saturating_sub(amount_msat) <=
4618 counterparty_skimmed_fee_msat);
4619 new_events.push_back((events::Event::PaymentClaimable {
4620 receiver_node_id: Some(receiver_node_id),
4624 counterparty_skimmed_fee_msat,
4625 via_channel_id: Some(prev_channel_id),
4626 via_user_channel_id: Some(prev_user_channel_id),
4627 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4628 onion_fields: claimable_payment.onion_fields.clone(),
4630 payment_claimable_generated = true;
4632 // Nothing to do - we haven't reached the total
4633 // payment value yet, wait until we receive more
4635 htlcs.push(claimable_htlc);
4636 #[allow(unused_assignments)] {
4637 committed_to_claimable = true;
4640 payment_claimable_generated
4644 // Check that the payment hash and secret are known. Note that we
4645 // MUST take care to handle the "unknown payment hash" and
4646 // "incorrect payment secret" cases here identically or we'd expose
4647 // that we are the ultimate recipient of the given payment hash.
4648 // Further, we must not expose whether we have any other HTLCs
4649 // associated with the same payment_hash pending or not.
4650 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4651 match payment_secrets.entry(payment_hash) {
4652 hash_map::Entry::Vacant(_) => {
4653 match claimable_htlc.onion_payload {
4654 OnionPayload::Invoice { .. } => {
4655 let payment_data = payment_data.unwrap();
4656 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) {
4657 Ok(result) => result,
4659 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4660 fail_htlc!(claimable_htlc, payment_hash);
4663 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4664 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4665 if (cltv_expiry as u64) < expected_min_expiry_height {
4666 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4667 &payment_hash, cltv_expiry, expected_min_expiry_height);
4668 fail_htlc!(claimable_htlc, payment_hash);
4671 let purpose = events::PaymentPurpose::InvoicePayment {
4672 payment_preimage: payment_preimage.clone(),
4673 payment_secret: payment_data.payment_secret,
4675 check_total_value!(purpose);
4677 OnionPayload::Spontaneous(preimage) => {
4678 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4679 check_total_value!(purpose);
4683 hash_map::Entry::Occupied(inbound_payment) => {
4684 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4685 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);
4686 fail_htlc!(claimable_htlc, payment_hash);
4688 let payment_data = payment_data.unwrap();
4689 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4690 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4691 fail_htlc!(claimable_htlc, payment_hash);
4692 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4693 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4694 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4695 fail_htlc!(claimable_htlc, payment_hash);
4697 let purpose = events::PaymentPurpose::InvoicePayment {
4698 payment_preimage: inbound_payment.get().payment_preimage,
4699 payment_secret: payment_data.payment_secret,
4701 let payment_claimable_generated = check_total_value!(purpose);
4702 if payment_claimable_generated {
4703 inbound_payment.remove_entry();
4709 HTLCForwardInfo::FailHTLC { .. } | HTLCForwardInfo::FailMalformedHTLC { .. } => {
4710 panic!("Got pending fail of our own HTLC");
4718 let best_block_height = self.best_block.read().unwrap().height();
4719 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4720 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4721 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4723 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4724 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4726 self.forward_htlcs(&mut phantom_receives);
4728 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4729 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4730 // nice to do the work now if we can rather than while we're trying to get messages in the
4732 self.check_free_holding_cells();
4734 if new_events.is_empty() { return }
4735 let mut events = self.pending_events.lock().unwrap();
4736 events.append(&mut new_events);
4739 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4741 /// Expects the caller to have a total_consistency_lock read lock.
4742 fn process_background_events(&self) -> NotifyOption {
4743 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4745 self.background_events_processed_since_startup.store(true, Ordering::Release);
4747 let mut background_events = Vec::new();
4748 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4749 if background_events.is_empty() {
4750 return NotifyOption::SkipPersistNoEvents;
4753 for event in background_events.drain(..) {
4755 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, _channel_id, update)) => {
4756 // The channel has already been closed, so no use bothering to care about the
4757 // monitor updating completing.
4758 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4760 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, channel_id, update } => {
4761 let mut updated_chan = false;
4763 let per_peer_state = self.per_peer_state.read().unwrap();
4764 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4765 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4766 let peer_state = &mut *peer_state_lock;
4767 match peer_state.channel_by_id.entry(channel_id) {
4768 hash_map::Entry::Occupied(mut chan_phase) => {
4769 if let ChannelPhase::Funded(chan) = chan_phase.get_mut() {
4770 updated_chan = true;
4771 handle_new_monitor_update!(self, funding_txo, update.clone(),
4772 peer_state_lock, peer_state, per_peer_state, chan);
4774 debug_assert!(false, "We shouldn't have an update for a non-funded channel");
4777 hash_map::Entry::Vacant(_) => {},
4782 // TODO: Track this as in-flight even though the channel is closed.
4783 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4786 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4787 let per_peer_state = self.per_peer_state.read().unwrap();
4788 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4789 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4790 let peer_state = &mut *peer_state_lock;
4791 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4792 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4794 let update_actions = peer_state.monitor_update_blocked_actions
4795 .remove(&channel_id).unwrap_or(Vec::new());
4796 mem::drop(peer_state_lock);
4797 mem::drop(per_peer_state);
4798 self.handle_monitor_update_completion_actions(update_actions);
4804 NotifyOption::DoPersist
4807 #[cfg(any(test, feature = "_test_utils"))]
4808 /// Process background events, for functional testing
4809 pub fn test_process_background_events(&self) {
4810 let _lck = self.total_consistency_lock.read().unwrap();
4811 let _ = self.process_background_events();
4814 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4815 if !chan.context.is_outbound() { return NotifyOption::SkipPersistNoEvents; }
4817 let logger = WithChannelContext::from(&self.logger, &chan.context);
4819 // If the feerate has decreased by less than half, don't bother
4820 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4821 if new_feerate != chan.context.get_feerate_sat_per_1000_weight() {
4822 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4823 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4825 return NotifyOption::SkipPersistNoEvents;
4827 if !chan.context.is_live() {
4828 log_trace!(logger, "Channel {} does not qualify for a feerate change from {} to {} as it cannot currently be updated (probably the peer is disconnected).",
4829 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4830 return NotifyOption::SkipPersistNoEvents;
4832 log_trace!(logger, "Channel {} qualifies for a feerate change from {} to {}.",
4833 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4835 chan.queue_update_fee(new_feerate, &self.fee_estimator, &&logger);
4836 NotifyOption::DoPersist
4840 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4841 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4842 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4843 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4844 pub fn maybe_update_chan_fees(&self) {
4845 PersistenceNotifierGuard::optionally_notify(self, || {
4846 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4848 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4849 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4851 let per_peer_state = self.per_peer_state.read().unwrap();
4852 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4853 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4854 let peer_state = &mut *peer_state_lock;
4855 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4856 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4858 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4863 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4864 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4872 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4874 /// This currently includes:
4875 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4876 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4877 /// than a minute, informing the network that they should no longer attempt to route over
4879 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4880 /// with the current [`ChannelConfig`].
4881 /// * Removing peers which have disconnected but and no longer have any channels.
4882 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4883 /// * Forgetting about stale outbound payments, either those that have already been fulfilled
4884 /// or those awaiting an invoice that hasn't been delivered in the necessary amount of time.
4885 /// The latter is determined using the system clock in `std` and the highest seen block time
4886 /// minus two hours in `no-std`.
4888 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4889 /// estimate fetches.
4891 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4892 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4893 pub fn timer_tick_occurred(&self) {
4894 PersistenceNotifierGuard::optionally_notify(self, || {
4895 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4897 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4898 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4900 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4901 let mut timed_out_mpp_htlcs = Vec::new();
4902 let mut pending_peers_awaiting_removal = Vec::new();
4903 let mut shutdown_channels = Vec::new();
4905 let mut process_unfunded_channel_tick = |
4906 chan_id: &ChannelId,
4907 context: &mut ChannelContext<SP>,
4908 unfunded_context: &mut UnfundedChannelContext,
4909 pending_msg_events: &mut Vec<MessageSendEvent>,
4910 counterparty_node_id: PublicKey,
4912 context.maybe_expire_prev_config();
4913 if unfunded_context.should_expire_unfunded_channel() {
4914 let logger = WithChannelContext::from(&self.logger, context);
4916 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4917 update_maps_on_chan_removal!(self, &context);
4918 shutdown_channels.push(context.force_shutdown(false, ClosureReason::HolderForceClosed));
4919 pending_msg_events.push(MessageSendEvent::HandleError {
4920 node_id: counterparty_node_id,
4921 action: msgs::ErrorAction::SendErrorMessage {
4922 msg: msgs::ErrorMessage {
4923 channel_id: *chan_id,
4924 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4935 let per_peer_state = self.per_peer_state.read().unwrap();
4936 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4937 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4938 let peer_state = &mut *peer_state_lock;
4939 let pending_msg_events = &mut peer_state.pending_msg_events;
4940 let counterparty_node_id = *counterparty_node_id;
4941 peer_state.channel_by_id.retain(|chan_id, phase| {
4943 ChannelPhase::Funded(chan) => {
4944 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4949 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4950 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4952 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4953 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4954 handle_errors.push((Err(err), counterparty_node_id));
4955 if needs_close { return false; }
4958 match chan.channel_update_status() {
4959 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4960 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4961 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4962 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4963 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4964 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4965 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4967 if n >= DISABLE_GOSSIP_TICKS {
4968 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4969 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4970 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4974 should_persist = NotifyOption::DoPersist;
4976 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4979 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4981 if n >= ENABLE_GOSSIP_TICKS {
4982 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4983 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4984 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4988 should_persist = NotifyOption::DoPersist;
4990 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4996 chan.context.maybe_expire_prev_config();
4998 if chan.should_disconnect_peer_awaiting_response() {
4999 let logger = WithChannelContext::from(&self.logger, &chan.context);
5000 log_debug!(logger, "Disconnecting peer {} due to not making any progress on channel {}",
5001 counterparty_node_id, chan_id);
5002 pending_msg_events.push(MessageSendEvent::HandleError {
5003 node_id: counterparty_node_id,
5004 action: msgs::ErrorAction::DisconnectPeerWithWarning {
5005 msg: msgs::WarningMessage {
5006 channel_id: *chan_id,
5007 data: "Disconnecting due to timeout awaiting response".to_owned(),
5015 ChannelPhase::UnfundedInboundV1(chan) => {
5016 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
5017 pending_msg_events, counterparty_node_id)
5019 ChannelPhase::UnfundedOutboundV1(chan) => {
5020 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
5021 pending_msg_events, counterparty_node_id)
5026 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
5027 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
5028 let logger = WithContext::from(&self.logger, Some(counterparty_node_id), Some(*chan_id));
5029 log_error!(logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
5030 peer_state.pending_msg_events.push(
5031 events::MessageSendEvent::HandleError {
5032 node_id: counterparty_node_id,
5033 action: msgs::ErrorAction::SendErrorMessage {
5034 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
5040 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
5042 if peer_state.ok_to_remove(true) {
5043 pending_peers_awaiting_removal.push(counterparty_node_id);
5048 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
5049 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
5050 // of to that peer is later closed while still being disconnected (i.e. force closed),
5051 // we therefore need to remove the peer from `peer_state` separately.
5052 // To avoid having to take the `per_peer_state` `write` lock once the channels are
5053 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
5054 // negative effects on parallelism as much as possible.
5055 if pending_peers_awaiting_removal.len() > 0 {
5056 let mut per_peer_state = self.per_peer_state.write().unwrap();
5057 for counterparty_node_id in pending_peers_awaiting_removal {
5058 match per_peer_state.entry(counterparty_node_id) {
5059 hash_map::Entry::Occupied(entry) => {
5060 // Remove the entry if the peer is still disconnected and we still
5061 // have no channels to the peer.
5062 let remove_entry = {
5063 let peer_state = entry.get().lock().unwrap();
5064 peer_state.ok_to_remove(true)
5067 entry.remove_entry();
5070 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
5075 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
5076 if payment.htlcs.is_empty() {
5077 // This should be unreachable
5078 debug_assert!(false);
5081 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
5082 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
5083 // In this case we're not going to handle any timeouts of the parts here.
5084 // This condition determining whether the MPP is complete here must match
5085 // exactly the condition used in `process_pending_htlc_forwards`.
5086 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
5087 .fold(0, |total, htlc| total + htlc.sender_intended_value)
5090 } else if payment.htlcs.iter_mut().any(|htlc| {
5091 htlc.timer_ticks += 1;
5092 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
5094 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
5095 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
5102 for htlc_source in timed_out_mpp_htlcs.drain(..) {
5103 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
5104 let reason = HTLCFailReason::from_failure_code(23);
5105 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
5106 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
5109 for (err, counterparty_node_id) in handle_errors.drain(..) {
5110 let _ = handle_error!(self, err, counterparty_node_id);
5113 for shutdown_res in shutdown_channels {
5114 self.finish_close_channel(shutdown_res);
5117 #[cfg(feature = "std")]
5118 let duration_since_epoch = std::time::SystemTime::now()
5119 .duration_since(std::time::SystemTime::UNIX_EPOCH)
5120 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
5121 #[cfg(not(feature = "std"))]
5122 let duration_since_epoch = Duration::from_secs(
5123 self.highest_seen_timestamp.load(Ordering::Acquire).saturating_sub(7200) as u64
5126 self.pending_outbound_payments.remove_stale_payments(
5127 duration_since_epoch, &self.pending_events
5130 // Technically we don't need to do this here, but if we have holding cell entries in a
5131 // channel that need freeing, it's better to do that here and block a background task
5132 // than block the message queueing pipeline.
5133 if self.check_free_holding_cells() {
5134 should_persist = NotifyOption::DoPersist;
5141 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
5142 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
5143 /// along the path (including in our own channel on which we received it).
5145 /// Note that in some cases around unclean shutdown, it is possible the payment may have
5146 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
5147 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
5148 /// may have already been failed automatically by LDK if it was nearing its expiration time.
5150 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
5151 /// [`ChannelManager::claim_funds`]), you should still monitor for
5152 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
5153 /// startup during which time claims that were in-progress at shutdown may be replayed.
5154 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
5155 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
5158 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
5159 /// reason for the failure.
5161 /// See [`FailureCode`] for valid failure codes.
5162 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
5163 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5165 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
5166 if let Some(payment) = removed_source {
5167 for htlc in payment.htlcs {
5168 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
5169 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5170 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
5171 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5176 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
5177 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
5178 match failure_code {
5179 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
5180 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
5181 FailureCode::IncorrectOrUnknownPaymentDetails => {
5182 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5183 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5184 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
5186 FailureCode::InvalidOnionPayload(data) => {
5187 let fail_data = match data {
5188 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
5191 HTLCFailReason::reason(failure_code.into(), fail_data)
5196 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5197 /// that we want to return and a channel.
5199 /// This is for failures on the channel on which the HTLC was *received*, not failures
5201 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5202 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
5203 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
5204 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
5205 // an inbound SCID alias before the real SCID.
5206 let scid_pref = if chan.context.should_announce() {
5207 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
5209 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
5211 if let Some(scid) = scid_pref {
5212 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
5214 (0x4000|10, Vec::new())
5219 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5220 /// that we want to return and a channel.
5221 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5222 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
5223 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
5224 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
5225 if desired_err_code == 0x1000 | 20 {
5226 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
5227 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
5228 0u16.write(&mut enc).expect("Writes cannot fail");
5230 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
5231 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
5232 upd.write(&mut enc).expect("Writes cannot fail");
5233 (desired_err_code, enc.0)
5235 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
5236 // which means we really shouldn't have gotten a payment to be forwarded over this
5237 // channel yet, or if we did it's from a route hint. Either way, returning an error of
5238 // PERM|no_such_channel should be fine.
5239 (0x4000|10, Vec::new())
5243 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
5244 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
5245 // be surfaced to the user.
5246 fn fail_holding_cell_htlcs(
5247 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
5248 counterparty_node_id: &PublicKey
5250 let (failure_code, onion_failure_data) = {
5251 let per_peer_state = self.per_peer_state.read().unwrap();
5252 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5253 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5254 let peer_state = &mut *peer_state_lock;
5255 match peer_state.channel_by_id.entry(channel_id) {
5256 hash_map::Entry::Occupied(chan_phase_entry) => {
5257 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
5258 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
5260 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
5261 debug_assert!(false);
5262 (0x4000|10, Vec::new())
5265 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
5267 } else { (0x4000|10, Vec::new()) }
5270 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
5271 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
5272 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
5273 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
5277 /// Fails an HTLC backwards to the sender of it to us.
5278 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
5279 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
5280 // Ensure that no peer state channel storage lock is held when calling this function.
5281 // This ensures that future code doesn't introduce a lock-order requirement for
5282 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
5283 // this function with any `per_peer_state` peer lock acquired would.
5284 #[cfg(debug_assertions)]
5285 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
5286 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
5289 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
5290 //identify whether we sent it or not based on the (I presume) very different runtime
5291 //between the branches here. We should make this async and move it into the forward HTLCs
5294 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5295 // from block_connected which may run during initialization prior to the chain_monitor
5296 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
5298 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
5299 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
5300 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
5301 &self.pending_events, &self.logger)
5302 { self.push_pending_forwards_ev(); }
5304 HTLCSource::PreviousHopData(HTLCPreviousHopData {
5305 ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret,
5306 ref phantom_shared_secret, outpoint: _, ref blinded_failure, ref channel_id, ..
5309 WithContext::from(&self.logger, None, Some(*channel_id)),
5310 "Failing {}HTLC with payment_hash {} backwards from us: {:?}",
5311 if blinded_failure.is_some() { "blinded " } else { "" }, &payment_hash, onion_error
5313 let failure = match blinded_failure {
5314 Some(BlindedFailure::FromIntroductionNode) => {
5315 let blinded_onion_error = HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32]);
5316 let err_packet = blinded_onion_error.get_encrypted_failure_packet(
5317 incoming_packet_shared_secret, phantom_shared_secret
5319 HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }
5321 Some(BlindedFailure::FromBlindedNode) => {
5322 HTLCForwardInfo::FailMalformedHTLC {
5324 failure_code: INVALID_ONION_BLINDING,
5325 sha256_of_onion: [0; 32]
5329 let err_packet = onion_error.get_encrypted_failure_packet(
5330 incoming_packet_shared_secret, phantom_shared_secret
5332 HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }
5336 let mut push_forward_ev = false;
5337 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5338 if forward_htlcs.is_empty() {
5339 push_forward_ev = true;
5341 match forward_htlcs.entry(*short_channel_id) {
5342 hash_map::Entry::Occupied(mut entry) => {
5343 entry.get_mut().push(failure);
5345 hash_map::Entry::Vacant(entry) => {
5346 entry.insert(vec!(failure));
5349 mem::drop(forward_htlcs);
5350 if push_forward_ev { self.push_pending_forwards_ev(); }
5351 let mut pending_events = self.pending_events.lock().unwrap();
5352 pending_events.push_back((events::Event::HTLCHandlingFailed {
5353 prev_channel_id: *channel_id,
5354 failed_next_destination: destination,
5360 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
5361 /// [`MessageSendEvent`]s needed to claim the payment.
5363 /// This method is guaranteed to ensure the payment has been claimed but only if the current
5364 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
5365 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
5366 /// successful. It will generally be available in the next [`process_pending_events`] call.
5368 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
5369 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
5370 /// event matches your expectation. If you fail to do so and call this method, you may provide
5371 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5373 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5374 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5375 /// [`claim_funds_with_known_custom_tlvs`].
5377 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5378 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5379 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5380 /// [`process_pending_events`]: EventsProvider::process_pending_events
5381 /// [`create_inbound_payment`]: Self::create_inbound_payment
5382 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5383 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5384 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5385 self.claim_payment_internal(payment_preimage, false);
5388 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5389 /// even type numbers.
5393 /// You MUST check you've understood all even TLVs before using this to
5394 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5396 /// [`claim_funds`]: Self::claim_funds
5397 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5398 self.claim_payment_internal(payment_preimage, true);
5401 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5402 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).to_byte_array());
5404 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5407 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5408 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5409 let mut receiver_node_id = self.our_network_pubkey;
5410 for htlc in payment.htlcs.iter() {
5411 if htlc.prev_hop.phantom_shared_secret.is_some() {
5412 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5413 .expect("Failed to get node_id for phantom node recipient");
5414 receiver_node_id = phantom_pubkey;
5419 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5420 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5421 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5422 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5423 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5425 if dup_purpose.is_some() {
5426 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5427 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5431 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5432 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5433 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5434 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5435 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5436 mem::drop(claimable_payments);
5437 for htlc in payment.htlcs {
5438 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5439 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5440 let receiver = HTLCDestination::FailedPayment { payment_hash };
5441 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5450 debug_assert!(!sources.is_empty());
5452 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5453 // and when we got here we need to check that the amount we're about to claim matches the
5454 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5455 // the MPP parts all have the same `total_msat`.
5456 let mut claimable_amt_msat = 0;
5457 let mut prev_total_msat = None;
5458 let mut expected_amt_msat = None;
5459 let mut valid_mpp = true;
5460 let mut errs = Vec::new();
5461 let per_peer_state = self.per_peer_state.read().unwrap();
5462 for htlc in sources.iter() {
5463 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5464 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5465 debug_assert!(false);
5469 prev_total_msat = Some(htlc.total_msat);
5471 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5472 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5473 debug_assert!(false);
5477 expected_amt_msat = htlc.total_value_received;
5478 claimable_amt_msat += htlc.value;
5480 mem::drop(per_peer_state);
5481 if sources.is_empty() || expected_amt_msat.is_none() {
5482 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5483 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5486 if claimable_amt_msat != expected_amt_msat.unwrap() {
5487 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5488 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5489 expected_amt_msat.unwrap(), claimable_amt_msat);
5493 for htlc in sources.drain(..) {
5494 let prev_hop_chan_id = htlc.prev_hop.channel_id;
5495 if let Err((pk, err)) = self.claim_funds_from_hop(
5496 htlc.prev_hop, payment_preimage,
5497 |_, definitely_duplicate| {
5498 debug_assert!(!definitely_duplicate, "We shouldn't claim duplicatively from a payment");
5499 Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash })
5502 if let msgs::ErrorAction::IgnoreError = err.err.action {
5503 // We got a temporary failure updating monitor, but will claim the
5504 // HTLC when the monitor updating is restored (or on chain).
5505 let logger = WithContext::from(&self.logger, None, Some(prev_hop_chan_id));
5506 log_error!(logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5507 } else { errs.push((pk, err)); }
5512 for htlc in sources.drain(..) {
5513 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5514 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5515 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5516 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5517 let receiver = HTLCDestination::FailedPayment { payment_hash };
5518 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5520 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5523 // Now we can handle any errors which were generated.
5524 for (counterparty_node_id, err) in errs.drain(..) {
5525 let res: Result<(), _> = Err(err);
5526 let _ = handle_error!(self, res, counterparty_node_id);
5530 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>, bool) -> Option<MonitorUpdateCompletionAction>>(&self,
5531 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5532 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5533 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5535 // If we haven't yet run background events assume we're still deserializing and shouldn't
5536 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5537 // `BackgroundEvent`s.
5538 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5540 // As we may call handle_monitor_update_completion_actions in rather rare cases, check that
5541 // the required mutexes are not held before we start.
5542 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5543 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5546 let per_peer_state = self.per_peer_state.read().unwrap();
5547 let chan_id = prev_hop.channel_id;
5548 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5549 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5553 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5554 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5555 .map(|peer_mutex| peer_mutex.lock().unwrap())
5558 if peer_state_opt.is_some() {
5559 let mut peer_state_lock = peer_state_opt.unwrap();
5560 let peer_state = &mut *peer_state_lock;
5561 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5562 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5563 let counterparty_node_id = chan.context.get_counterparty_node_id();
5564 let logger = WithChannelContext::from(&self.logger, &chan.context);
5565 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &&logger);
5568 UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } => {
5569 if let Some(action) = completion_action(Some(htlc_value_msat), false) {
5570 log_trace!(logger, "Tracking monitor update completion action for channel {}: {:?}",
5572 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5575 handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5576 peer_state, per_peer_state, chan);
5578 // If we're running during init we cannot update a monitor directly -
5579 // they probably haven't actually been loaded yet. Instead, push the
5580 // monitor update as a background event.
5581 self.pending_background_events.lock().unwrap().push(
5582 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5583 counterparty_node_id,
5584 funding_txo: prev_hop.outpoint,
5585 channel_id: prev_hop.channel_id,
5586 update: monitor_update.clone(),
5590 UpdateFulfillCommitFetch::DuplicateClaim {} => {
5591 let action = if let Some(action) = completion_action(None, true) {
5596 mem::drop(peer_state_lock);
5598 log_trace!(logger, "Completing monitor update completion action for channel {} as claim was redundant: {:?}",
5600 let (node_id, _funding_outpoint, channel_id, blocker) =
5601 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5602 downstream_counterparty_node_id: node_id,
5603 downstream_funding_outpoint: funding_outpoint,
5604 blocking_action: blocker, downstream_channel_id: channel_id,
5606 (node_id, funding_outpoint, channel_id, blocker)
5608 debug_assert!(false,
5609 "Duplicate claims should always free another channel immediately");
5612 if let Some(peer_state_mtx) = per_peer_state.get(&node_id) {
5613 let mut peer_state = peer_state_mtx.lock().unwrap();
5614 if let Some(blockers) = peer_state
5615 .actions_blocking_raa_monitor_updates
5616 .get_mut(&channel_id)
5618 let mut found_blocker = false;
5619 blockers.retain(|iter| {
5620 // Note that we could actually be blocked, in
5621 // which case we need to only remove the one
5622 // blocker which was added duplicatively.
5623 let first_blocker = !found_blocker;
5624 if *iter == blocker { found_blocker = true; }
5625 *iter != blocker || !first_blocker
5627 debug_assert!(found_blocker);
5630 debug_assert!(false);
5639 let preimage_update = ChannelMonitorUpdate {
5640 update_id: CLOSED_CHANNEL_UPDATE_ID,
5641 counterparty_node_id: None,
5642 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5645 channel_id: Some(prev_hop.channel_id),
5649 // We update the ChannelMonitor on the backward link, after
5650 // receiving an `update_fulfill_htlc` from the forward link.
5651 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5652 if update_res != ChannelMonitorUpdateStatus::Completed {
5653 // TODO: This needs to be handled somehow - if we receive a monitor update
5654 // with a preimage we *must* somehow manage to propagate it to the upstream
5655 // channel, or we must have an ability to receive the same event and try
5656 // again on restart.
5657 log_error!(WithContext::from(&self.logger, None, Some(prev_hop.channel_id)),
5658 "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5659 payment_preimage, update_res);
5662 // If we're running during init we cannot update a monitor directly - they probably
5663 // haven't actually been loaded yet. Instead, push the monitor update as a background
5665 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5666 // channel is already closed) we need to ultimately handle the monitor update
5667 // completion action only after we've completed the monitor update. This is the only
5668 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5669 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5670 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5671 // complete the monitor update completion action from `completion_action`.
5672 self.pending_background_events.lock().unwrap().push(
5673 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5674 prev_hop.outpoint, prev_hop.channel_id, preimage_update,
5677 // Note that we do process the completion action here. This totally could be a
5678 // duplicate claim, but we have no way of knowing without interrogating the
5679 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5680 // generally always allowed to be duplicative (and it's specifically noted in
5681 // `PaymentForwarded`).
5682 self.handle_monitor_update_completion_actions(completion_action(None, false));
5686 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5687 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5690 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5691 forwarded_htlc_value_msat: Option<u64>, skimmed_fee_msat: Option<u64>, from_onchain: bool,
5692 startup_replay: bool, next_channel_counterparty_node_id: Option<PublicKey>,
5693 next_channel_outpoint: OutPoint, next_channel_id: ChannelId,
5696 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5697 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5698 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5699 if let Some(pubkey) = next_channel_counterparty_node_id {
5700 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5702 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5703 channel_funding_outpoint: next_channel_outpoint, channel_id: next_channel_id,
5704 counterparty_node_id: path.hops[0].pubkey,
5706 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5707 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5710 HTLCSource::PreviousHopData(hop_data) => {
5711 let prev_channel_id = hop_data.channel_id;
5712 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5713 #[cfg(debug_assertions)]
5714 let claiming_chan_funding_outpoint = hop_data.outpoint;
5715 #[cfg(debug_assertions)]
5716 let claiming_channel_id = hop_data.channel_id;
5717 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5718 |htlc_claim_value_msat, definitely_duplicate| {
5719 let chan_to_release =
5720 if let Some(node_id) = next_channel_counterparty_node_id {
5721 Some((node_id, next_channel_outpoint, next_channel_id, completed_blocker))
5723 // We can only get `None` here if we are processing a
5724 // `ChannelMonitor`-originated event, in which case we
5725 // don't care about ensuring we wake the downstream
5726 // channel's monitor updating - the channel is already
5731 if definitely_duplicate && startup_replay {
5732 // On startup we may get redundant claims which are related to
5733 // monitor updates still in flight. In that case, we shouldn't
5734 // immediately free, but instead let that monitor update complete
5735 // in the background.
5736 #[cfg(debug_assertions)] {
5737 let background_events = self.pending_background_events.lock().unwrap();
5738 // There should be a `BackgroundEvent` pending...
5739 assert!(background_events.iter().any(|ev| {
5741 // to apply a monitor update that blocked the claiming channel,
5742 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5743 funding_txo, update, ..
5745 if *funding_txo == claiming_chan_funding_outpoint {
5746 assert!(update.updates.iter().any(|upd|
5747 if let ChannelMonitorUpdateStep::PaymentPreimage {
5748 payment_preimage: update_preimage
5750 payment_preimage == *update_preimage
5756 // or the channel we'd unblock is already closed,
5757 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup(
5758 (funding_txo, _channel_id, monitor_update)
5760 if *funding_txo == next_channel_outpoint {
5761 assert_eq!(monitor_update.updates.len(), 1);
5763 monitor_update.updates[0],
5764 ChannelMonitorUpdateStep::ChannelForceClosed { .. }
5769 // or the monitor update has completed and will unblock
5770 // immediately once we get going.
5771 BackgroundEvent::MonitorUpdatesComplete {
5774 *channel_id == claiming_channel_id,
5776 }), "{:?}", *background_events);
5779 } else if definitely_duplicate {
5780 if let Some(other_chan) = chan_to_release {
5781 Some(MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5782 downstream_counterparty_node_id: other_chan.0,
5783 downstream_funding_outpoint: other_chan.1,
5784 downstream_channel_id: other_chan.2,
5785 blocking_action: other_chan.3,
5789 let total_fee_earned_msat = if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5790 if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5791 Some(claimed_htlc_value - forwarded_htlc_value)
5794 debug_assert!(skimmed_fee_msat <= total_fee_earned_msat,
5795 "skimmed_fee_msat must always be included in total_fee_earned_msat");
5796 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5797 event: events::Event::PaymentForwarded {
5798 total_fee_earned_msat,
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,
5805 downstream_counterparty_and_funding_outpoint: chan_to_release,
5809 if let Err((pk, err)) = res {
5810 let result: Result<(), _> = Err(err);
5811 let _ = handle_error!(self, result, pk);
5817 /// Gets the node_id held by this ChannelManager
5818 pub fn get_our_node_id(&self) -> PublicKey {
5819 self.our_network_pubkey.clone()
5822 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5823 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5824 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5825 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
5827 for action in actions.into_iter() {
5829 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5830 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5831 if let Some(ClaimingPayment {
5833 payment_purpose: purpose,
5836 sender_intended_value: sender_intended_total_msat,
5838 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5842 receiver_node_id: Some(receiver_node_id),
5844 sender_intended_total_msat,
5848 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5849 event, downstream_counterparty_and_funding_outpoint
5851 self.pending_events.lock().unwrap().push_back((event, None));
5852 if let Some((node_id, funding_outpoint, channel_id, blocker)) = downstream_counterparty_and_funding_outpoint {
5853 self.handle_monitor_update_release(node_id, funding_outpoint, channel_id, Some(blocker));
5856 MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5857 downstream_counterparty_node_id, downstream_funding_outpoint, downstream_channel_id, blocking_action,
5859 self.handle_monitor_update_release(
5860 downstream_counterparty_node_id,
5861 downstream_funding_outpoint,
5862 downstream_channel_id,
5863 Some(blocking_action),
5870 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5871 /// update completion.
5872 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5873 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5874 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5875 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5876 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5877 -> Option<(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)> {
5878 let logger = WithChannelContext::from(&self.logger, &channel.context);
5879 log_trace!(logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5880 &channel.context.channel_id(),
5881 if raa.is_some() { "an" } else { "no" },
5882 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5883 if funding_broadcastable.is_some() { "" } else { "not " },
5884 if channel_ready.is_some() { "sending" } else { "without" },
5885 if announcement_sigs.is_some() { "sending" } else { "without" });
5887 let mut htlc_forwards = None;
5889 let counterparty_node_id = channel.context.get_counterparty_node_id();
5890 if !pending_forwards.is_empty() {
5891 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5892 channel.context.get_funding_txo().unwrap(), channel.context.channel_id(), channel.context.get_user_id(), pending_forwards));
5895 if let Some(msg) = channel_ready {
5896 send_channel_ready!(self, pending_msg_events, channel, msg);
5898 if let Some(msg) = announcement_sigs {
5899 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5900 node_id: counterparty_node_id,
5905 macro_rules! handle_cs { () => {
5906 if let Some(update) = commitment_update {
5907 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5908 node_id: counterparty_node_id,
5913 macro_rules! handle_raa { () => {
5914 if let Some(revoke_and_ack) = raa {
5915 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5916 node_id: counterparty_node_id,
5917 msg: revoke_and_ack,
5922 RAACommitmentOrder::CommitmentFirst => {
5926 RAACommitmentOrder::RevokeAndACKFirst => {
5932 if let Some(tx) = funding_broadcastable {
5933 log_info!(logger, "Broadcasting funding transaction with txid {}", tx.txid());
5934 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5938 let mut pending_events = self.pending_events.lock().unwrap();
5939 emit_channel_pending_event!(pending_events, channel);
5940 emit_channel_ready_event!(pending_events, channel);
5946 fn channel_monitor_updated(&self, funding_txo: &OutPoint, channel_id: &ChannelId, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5947 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5949 let counterparty_node_id = match counterparty_node_id {
5950 Some(cp_id) => cp_id.clone(),
5952 // TODO: Once we can rely on the counterparty_node_id from the
5953 // monitor event, this and the outpoint_to_peer map should be removed.
5954 let outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
5955 match outpoint_to_peer.get(&funding_txo) {
5956 Some(cp_id) => cp_id.clone(),
5961 let per_peer_state = self.per_peer_state.read().unwrap();
5962 let mut peer_state_lock;
5963 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5964 if peer_state_mutex_opt.is_none() { return }
5965 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5966 let peer_state = &mut *peer_state_lock;
5968 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
5971 let update_actions = peer_state.monitor_update_blocked_actions
5972 .remove(&channel_id).unwrap_or(Vec::new());
5973 mem::drop(peer_state_lock);
5974 mem::drop(per_peer_state);
5975 self.handle_monitor_update_completion_actions(update_actions);
5978 let remaining_in_flight =
5979 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5980 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5983 let logger = WithChannelContext::from(&self.logger, &channel.context);
5984 log_trace!(logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5985 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5986 remaining_in_flight);
5987 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5990 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5993 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5995 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5996 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5999 /// The `user_channel_id` parameter will be provided back in
6000 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
6001 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
6003 /// Note that this method will return an error and reject the channel, if it requires support
6004 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
6005 /// used to accept such channels.
6007 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
6008 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
6009 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
6010 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
6013 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
6014 /// it as confirmed immediately.
6016 /// The `user_channel_id` parameter will be provided back in
6017 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
6018 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
6020 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
6021 /// and (if the counterparty agrees), enables forwarding of payments immediately.
6023 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
6024 /// transaction and blindly assumes that it will eventually confirm.
6026 /// If it does not confirm before we decide to close the channel, or if the funding transaction
6027 /// does not pay to the correct script the correct amount, *you will lose funds*.
6029 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
6030 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
6031 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
6032 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
6035 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
6037 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(*temporary_channel_id));
6038 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6040 let peers_without_funded_channels =
6041 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
6042 let per_peer_state = self.per_peer_state.read().unwrap();
6043 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6045 let err_str = format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id);
6046 log_error!(logger, "{}", err_str);
6048 APIError::ChannelUnavailable { err: err_str }
6050 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6051 let peer_state = &mut *peer_state_lock;
6052 let is_only_peer_channel = peer_state.total_channel_count() == 1;
6054 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
6055 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
6056 // that we can delay allocating the SCID until after we're sure that the checks below will
6058 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
6059 Some(unaccepted_channel) => {
6060 let best_block_height = self.best_block.read().unwrap().height();
6061 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6062 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
6063 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
6064 &self.logger, accept_0conf).map_err(|e| {
6065 let err_str = e.to_string();
6066 log_error!(logger, "{}", err_str);
6068 APIError::ChannelUnavailable { err: err_str }
6072 let err_str = "No such channel awaiting to be accepted.".to_owned();
6073 log_error!(logger, "{}", err_str);
6075 Err(APIError::APIMisuseError { err: err_str })
6080 // This should have been correctly configured by the call to InboundV1Channel::new.
6081 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
6082 } else if channel.context.get_channel_type().requires_zero_conf() {
6083 let send_msg_err_event = events::MessageSendEvent::HandleError {
6084 node_id: channel.context.get_counterparty_node_id(),
6085 action: msgs::ErrorAction::SendErrorMessage{
6086 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
6089 peer_state.pending_msg_events.push(send_msg_err_event);
6090 let err_str = "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned();
6091 log_error!(logger, "{}", err_str);
6093 return Err(APIError::APIMisuseError { err: err_str });
6095 // If this peer already has some channels, a new channel won't increase our number of peers
6096 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6097 // channels per-peer we can accept channels from a peer with existing ones.
6098 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
6099 let send_msg_err_event = events::MessageSendEvent::HandleError {
6100 node_id: channel.context.get_counterparty_node_id(),
6101 action: msgs::ErrorAction::SendErrorMessage{
6102 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
6105 peer_state.pending_msg_events.push(send_msg_err_event);
6106 let err_str = "Too many peers with unfunded channels, refusing to accept new ones".to_owned();
6107 log_error!(logger, "{}", err_str);
6109 return Err(APIError::APIMisuseError { err: err_str });
6113 // Now that we know we have a channel, assign an outbound SCID alias.
6114 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6115 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6117 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6118 node_id: channel.context.get_counterparty_node_id(),
6119 msg: channel.accept_inbound_channel(),
6122 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
6127 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
6128 /// or 0-conf channels.
6130 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
6131 /// non-0-conf channels we have with the peer.
6132 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
6133 where Filter: Fn(&PeerState<SP>) -> bool {
6134 let mut peers_without_funded_channels = 0;
6135 let best_block_height = self.best_block.read().unwrap().height();
6137 let peer_state_lock = self.per_peer_state.read().unwrap();
6138 for (_, peer_mtx) in peer_state_lock.iter() {
6139 let peer = peer_mtx.lock().unwrap();
6140 if !maybe_count_peer(&*peer) { continue; }
6141 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
6142 if num_unfunded_channels == peer.total_channel_count() {
6143 peers_without_funded_channels += 1;
6147 return peers_without_funded_channels;
6150 fn unfunded_channel_count(
6151 peer: &PeerState<SP>, best_block_height: u32
6153 let mut num_unfunded_channels = 0;
6154 for (_, phase) in peer.channel_by_id.iter() {
6156 ChannelPhase::Funded(chan) => {
6157 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
6158 // which have not yet had any confirmations on-chain.
6159 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
6160 chan.context.get_funding_tx_confirmations(best_block_height) == 0
6162 num_unfunded_channels += 1;
6165 ChannelPhase::UnfundedInboundV1(chan) => {
6166 if chan.context.minimum_depth().unwrap_or(1) != 0 {
6167 num_unfunded_channels += 1;
6170 ChannelPhase::UnfundedOutboundV1(_) => {
6171 // Outbound channels don't contribute to the unfunded count in the DoS context.
6176 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
6179 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
6180 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6181 // likely to be lost on restart!
6182 if msg.chain_hash != self.chain_hash {
6183 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
6186 if !self.default_configuration.accept_inbound_channels {
6187 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6190 // Get the number of peers with channels, but without funded ones. We don't care too much
6191 // about peers that never open a channel, so we filter by peers that have at least one
6192 // channel, and then limit the number of those with unfunded channels.
6193 let channeled_peers_without_funding =
6194 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
6196 let per_peer_state = self.per_peer_state.read().unwrap();
6197 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6199 debug_assert!(false);
6200 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())
6202 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6203 let peer_state = &mut *peer_state_lock;
6205 // If this peer already has some channels, a new channel won't increase our number of peers
6206 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6207 // channels per-peer we can accept channels from a peer with existing ones.
6208 if peer_state.total_channel_count() == 0 &&
6209 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
6210 !self.default_configuration.manually_accept_inbound_channels
6212 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6213 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
6214 msg.temporary_channel_id.clone()));
6217 let best_block_height = self.best_block.read().unwrap().height();
6218 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
6219 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6220 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
6221 msg.temporary_channel_id.clone()));
6224 let channel_id = msg.temporary_channel_id;
6225 let channel_exists = peer_state.has_channel(&channel_id);
6227 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
6230 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
6231 if self.default_configuration.manually_accept_inbound_channels {
6232 let channel_type = channel::channel_type_from_open_channel(
6233 &msg, &peer_state.latest_features, &self.channel_type_features()
6235 MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id)
6237 let mut pending_events = self.pending_events.lock().unwrap();
6238 pending_events.push_back((events::Event::OpenChannelRequest {
6239 temporary_channel_id: msg.temporary_channel_id.clone(),
6240 counterparty_node_id: counterparty_node_id.clone(),
6241 funding_satoshis: msg.funding_satoshis,
6242 push_msat: msg.push_msat,
6245 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
6246 open_channel_msg: msg.clone(),
6247 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
6252 // Otherwise create the channel right now.
6253 let mut random_bytes = [0u8; 16];
6254 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
6255 let user_channel_id = u128::from_be_bytes(random_bytes);
6256 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6257 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
6258 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
6261 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
6266 let channel_type = channel.context.get_channel_type();
6267 if channel_type.requires_zero_conf() {
6268 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6270 if channel_type.requires_anchors_zero_fee_htlc_tx() {
6271 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
6274 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6275 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6277 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6278 node_id: counterparty_node_id.clone(),
6279 msg: channel.accept_inbound_channel(),
6281 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
6285 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
6286 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6287 // likely to be lost on restart!
6288 let (value, output_script, user_id) = {
6289 let per_peer_state = self.per_peer_state.read().unwrap();
6290 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6292 debug_assert!(false);
6293 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)
6295 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6296 let peer_state = &mut *peer_state_lock;
6297 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
6298 hash_map::Entry::Occupied(mut phase) => {
6299 match phase.get_mut() {
6300 ChannelPhase::UnfundedOutboundV1(chan) => {
6301 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
6302 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
6305 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));
6309 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))
6312 let mut pending_events = self.pending_events.lock().unwrap();
6313 pending_events.push_back((events::Event::FundingGenerationReady {
6314 temporary_channel_id: msg.temporary_channel_id,
6315 counterparty_node_id: *counterparty_node_id,
6316 channel_value_satoshis: value,
6318 user_channel_id: user_id,
6323 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
6324 let best_block = *self.best_block.read().unwrap();
6326 let per_peer_state = self.per_peer_state.read().unwrap();
6327 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6329 debug_assert!(false);
6330 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)
6333 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6334 let peer_state = &mut *peer_state_lock;
6335 let (mut chan, funding_msg_opt, monitor) =
6336 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
6337 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
6338 let logger = WithChannelContext::from(&self.logger, &inbound_chan.context);
6339 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &&logger) {
6341 Err((inbound_chan, err)) => {
6342 // We've already removed this inbound channel from the map in `PeerState`
6343 // above so at this point we just need to clean up any lingering entries
6344 // concerning this channel as it is safe to do so.
6345 debug_assert!(matches!(err, ChannelError::Close(_)));
6346 // Really we should be returning the channel_id the peer expects based
6347 // on their funding info here, but they're horribly confused anyway, so
6348 // there's not a lot we can do to save them.
6349 return Err(convert_chan_phase_err!(self, err, &mut ChannelPhase::UnfundedInboundV1(inbound_chan), &msg.temporary_channel_id).1);
6353 Some(mut phase) => {
6354 let err_msg = format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id);
6355 let err = ChannelError::Close(err_msg);
6356 return Err(convert_chan_phase_err!(self, err, &mut phase, &msg.temporary_channel_id).1);
6358 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))
6361 let funded_channel_id = chan.context.channel_id();
6363 macro_rules! fail_chan { ($err: expr) => { {
6364 // Note that at this point we've filled in the funding outpoint on our
6365 // channel, but its actually in conflict with another channel. Thus, if
6366 // we call `convert_chan_phase_err` immediately (thus calling
6367 // `update_maps_on_chan_removal`), we'll remove the existing channel
6368 // from `outpoint_to_peer`. Thus, we must first unset the funding outpoint
6370 let err = ChannelError::Close($err.to_owned());
6371 chan.unset_funding_info(msg.temporary_channel_id);
6372 return Err(convert_chan_phase_err!(self, err, chan, &funded_channel_id, UNFUNDED_CHANNEL).1);
6375 match peer_state.channel_by_id.entry(funded_channel_id) {
6376 hash_map::Entry::Occupied(_) => {
6377 fail_chan!("Already had channel with the new channel_id");
6379 hash_map::Entry::Vacant(e) => {
6380 let mut outpoint_to_peer_lock = self.outpoint_to_peer.lock().unwrap();
6381 match outpoint_to_peer_lock.entry(monitor.get_funding_txo().0) {
6382 hash_map::Entry::Occupied(_) => {
6383 fail_chan!("The funding_created message had the same funding_txid as an existing channel - funding is not possible");
6385 hash_map::Entry::Vacant(i_e) => {
6386 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
6387 if let Ok(persist_state) = monitor_res {
6388 i_e.insert(chan.context.get_counterparty_node_id());
6389 mem::drop(outpoint_to_peer_lock);
6391 // There's no problem signing a counterparty's funding transaction if our monitor
6392 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
6393 // accepted payment from yet. We do, however, need to wait to send our channel_ready
6394 // until we have persisted our monitor.
6395 if let Some(msg) = funding_msg_opt {
6396 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6397 node_id: counterparty_node_id.clone(),
6402 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
6403 handle_new_monitor_update!(self, persist_state, peer_state_lock, peer_state,
6404 per_peer_state, chan, INITIAL_MONITOR);
6406 unreachable!("This must be a funded channel as we just inserted it.");
6410 let logger = WithChannelContext::from(&self.logger, &chan.context);
6411 log_error!(logger, "Persisting initial ChannelMonitor failed, implying the funding outpoint was duplicated");
6412 fail_chan!("Duplicate funding outpoint");
6420 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
6421 let best_block = *self.best_block.read().unwrap();
6422 let per_peer_state = self.per_peer_state.read().unwrap();
6423 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6425 debug_assert!(false);
6426 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6429 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6430 let peer_state = &mut *peer_state_lock;
6431 match peer_state.channel_by_id.entry(msg.channel_id) {
6432 hash_map::Entry::Occupied(chan_phase_entry) => {
6433 if matches!(chan_phase_entry.get(), ChannelPhase::UnfundedOutboundV1(_)) {
6434 let chan = if let ChannelPhase::UnfundedOutboundV1(chan) = chan_phase_entry.remove() { chan } else { unreachable!() };
6435 let logger = WithContext::from(
6437 Some(chan.context.get_counterparty_node_id()),
6438 Some(chan.context.channel_id())
6441 chan.funding_signed(&msg, best_block, &self.signer_provider, &&logger);
6443 Ok((mut chan, monitor)) => {
6444 if let Ok(persist_status) = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor) {
6445 // We really should be able to insert here without doing a second
6446 // lookup, but sadly rust stdlib doesn't currently allow keeping
6447 // the original Entry around with the value removed.
6448 let mut chan = peer_state.channel_by_id.entry(msg.channel_id).or_insert(ChannelPhase::Funded(chan));
6449 if let ChannelPhase::Funded(ref mut chan) = &mut chan {
6450 handle_new_monitor_update!(self, persist_status, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
6451 } else { unreachable!(); }
6454 let e = ChannelError::Close("Channel funding outpoint was a duplicate".to_owned());
6455 // We weren't able to watch the channel to begin with, so no
6456 // updates should be made on it. Previously, full_stack_target
6457 // found an (unreachable) panic when the monitor update contained
6458 // within `shutdown_finish` was applied.
6459 chan.unset_funding_info(msg.channel_id);
6460 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::Funded(chan), &msg.channel_id).1);
6464 debug_assert!(matches!(e, ChannelError::Close(_)),
6465 "We don't have a channel anymore, so the error better have expected close");
6466 // We've already removed this outbound channel from the map in
6467 // `PeerState` above so at this point we just need to clean up any
6468 // lingering entries concerning this channel as it is safe to do so.
6469 return Err(convert_chan_phase_err!(self, e, &mut ChannelPhase::UnfundedOutboundV1(chan), &msg.channel_id).1);
6473 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
6476 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
6480 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
6481 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6482 // closing a channel), so any changes are likely to be lost on restart!
6483 let per_peer_state = self.per_peer_state.read().unwrap();
6484 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6486 debug_assert!(false);
6487 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6489 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6490 let peer_state = &mut *peer_state_lock;
6491 match peer_state.channel_by_id.entry(msg.channel_id) {
6492 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6493 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6494 let logger = WithChannelContext::from(&self.logger, &chan.context);
6495 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
6496 self.chain_hash, &self.default_configuration, &self.best_block.read().unwrap(), &&logger), chan_phase_entry);
6497 if let Some(announcement_sigs) = announcement_sigs_opt {
6498 log_trace!(logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
6499 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6500 node_id: counterparty_node_id.clone(),
6501 msg: announcement_sigs,
6503 } else if chan.context.is_usable() {
6504 // If we're sending an announcement_signatures, we'll send the (public)
6505 // channel_update after sending a channel_announcement when we receive our
6506 // counterparty's announcement_signatures. Thus, we only bother to send a
6507 // channel_update here if the channel is not public, i.e. we're not sending an
6508 // announcement_signatures.
6509 log_trace!(logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
6510 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6511 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6512 node_id: counterparty_node_id.clone(),
6519 let mut pending_events = self.pending_events.lock().unwrap();
6520 emit_channel_ready_event!(pending_events, chan);
6525 try_chan_phase_entry!(self, Err(ChannelError::Close(
6526 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
6529 hash_map::Entry::Vacant(_) => {
6530 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))
6535 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
6536 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
6537 let mut finish_shutdown = None;
6539 let per_peer_state = self.per_peer_state.read().unwrap();
6540 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6542 debug_assert!(false);
6543 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6545 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6546 let peer_state = &mut *peer_state_lock;
6547 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6548 let phase = chan_phase_entry.get_mut();
6550 ChannelPhase::Funded(chan) => {
6551 if !chan.received_shutdown() {
6552 let logger = WithChannelContext::from(&self.logger, &chan.context);
6553 log_info!(logger, "Received a shutdown message from our counterparty for channel {}{}.",
6555 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
6558 let funding_txo_opt = chan.context.get_funding_txo();
6559 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
6560 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
6561 dropped_htlcs = htlcs;
6563 if let Some(msg) = shutdown {
6564 // We can send the `shutdown` message before updating the `ChannelMonitor`
6565 // here as we don't need the monitor update to complete until we send a
6566 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
6567 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6568 node_id: *counterparty_node_id,
6572 // Update the monitor with the shutdown script if necessary.
6573 if let Some(monitor_update) = monitor_update_opt {
6574 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
6575 peer_state_lock, peer_state, per_peer_state, chan);
6578 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6579 let context = phase.context_mut();
6580 let logger = WithChannelContext::from(&self.logger, context);
6581 log_error!(logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6582 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6583 finish_shutdown = Some(chan.context_mut().force_shutdown(false, ClosureReason::CounterpartyCoopClosedUnfundedChannel));
6587 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))
6590 for htlc_source in dropped_htlcs.drain(..) {
6591 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6592 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6593 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6595 if let Some(shutdown_res) = finish_shutdown {
6596 self.finish_close_channel(shutdown_res);
6602 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6603 let per_peer_state = self.per_peer_state.read().unwrap();
6604 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6606 debug_assert!(false);
6607 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6609 let (tx, chan_option, shutdown_result) = {
6610 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6611 let peer_state = &mut *peer_state_lock;
6612 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6613 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6614 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6615 let (closing_signed, tx, shutdown_result) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6616 debug_assert_eq!(shutdown_result.is_some(), chan.is_shutdown());
6617 if let Some(msg) = closing_signed {
6618 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6619 node_id: counterparty_node_id.clone(),
6624 // We're done with this channel, we've got a signed closing transaction and
6625 // will send the closing_signed back to the remote peer upon return. This
6626 // also implies there are no pending HTLCs left on the channel, so we can
6627 // fully delete it from tracking (the channel monitor is still around to
6628 // watch for old state broadcasts)!
6629 (tx, Some(remove_channel_phase!(self, chan_phase_entry)), shutdown_result)
6630 } else { (tx, None, shutdown_result) }
6632 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6633 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6636 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))
6639 if let Some(broadcast_tx) = tx {
6640 let channel_id = chan_option.as_ref().map(|channel| channel.context().channel_id());
6641 log_info!(WithContext::from(&self.logger, Some(*counterparty_node_id), channel_id), "Broadcasting {}", log_tx!(broadcast_tx));
6642 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6644 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6645 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6646 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6647 let peer_state = &mut *peer_state_lock;
6648 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6653 mem::drop(per_peer_state);
6654 if let Some(shutdown_result) = shutdown_result {
6655 self.finish_close_channel(shutdown_result);
6660 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6661 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6662 //determine the state of the payment based on our response/if we forward anything/the time
6663 //we take to respond. We should take care to avoid allowing such an attack.
6665 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6666 //us repeatedly garbled in different ways, and compare our error messages, which are
6667 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6668 //but we should prevent it anyway.
6670 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6671 // closing a channel), so any changes are likely to be lost on restart!
6673 let decoded_hop_res = self.decode_update_add_htlc_onion(msg, counterparty_node_id);
6674 let per_peer_state = self.per_peer_state.read().unwrap();
6675 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6677 debug_assert!(false);
6678 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6680 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6681 let peer_state = &mut *peer_state_lock;
6682 match peer_state.channel_by_id.entry(msg.channel_id) {
6683 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6684 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6685 let pending_forward_info = match decoded_hop_res {
6686 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6687 self.construct_pending_htlc_status(
6688 msg, counterparty_node_id, shared_secret, next_hop,
6689 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt,
6691 Err(e) => PendingHTLCStatus::Fail(e)
6693 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6694 if msg.blinding_point.is_some() {
6695 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(
6696 msgs::UpdateFailMalformedHTLC {
6697 channel_id: msg.channel_id,
6698 htlc_id: msg.htlc_id,
6699 sha256_of_onion: [0; 32],
6700 failure_code: INVALID_ONION_BLINDING,
6704 // If the update_add is completely bogus, the call will Err and we will close,
6705 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6706 // want to reject the new HTLC and fail it backwards instead of forwarding.
6707 match pending_forward_info {
6708 PendingHTLCStatus::Forward(PendingHTLCInfo {
6709 ref incoming_shared_secret, ref routing, ..
6711 let reason = if routing.blinded_failure().is_some() {
6712 HTLCFailReason::reason(INVALID_ONION_BLINDING, vec![0; 32])
6713 } else if (error_code & 0x1000) != 0 {
6714 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6715 HTLCFailReason::reason(real_code, error_data)
6717 HTLCFailReason::from_failure_code(error_code)
6718 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6719 let msg = msgs::UpdateFailHTLC {
6720 channel_id: msg.channel_id,
6721 htlc_id: msg.htlc_id,
6724 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6726 _ => pending_forward_info
6729 let logger = WithChannelContext::from(&self.logger, &chan.context);
6730 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &&logger), chan_phase_entry);
6732 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6733 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6736 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))
6741 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6743 let (htlc_source, forwarded_htlc_value, skimmed_fee_msat) = {
6744 let per_peer_state = self.per_peer_state.read().unwrap();
6745 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6747 debug_assert!(false);
6748 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6750 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6751 let peer_state = &mut *peer_state_lock;
6752 match peer_state.channel_by_id.entry(msg.channel_id) {
6753 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6754 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6755 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6756 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6757 let logger = WithChannelContext::from(&self.logger, &chan.context);
6759 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
6761 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6762 .or_insert_with(Vec::new)
6763 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6765 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6766 // entry here, even though we *do* need to block the next RAA monitor update.
6767 // We do this instead in the `claim_funds_internal` by attaching a
6768 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6769 // outbound HTLC is claimed. This is guaranteed to all complete before we
6770 // process the RAA as messages are processed from single peers serially.
6771 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6774 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6775 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6778 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))
6781 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(),
6782 Some(forwarded_htlc_value), skimmed_fee_msat, false, false, Some(*counterparty_node_id),
6783 funding_txo, msg.channel_id
6789 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6790 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6791 // closing a channel), so any changes are likely to be lost on restart!
6792 let per_peer_state = self.per_peer_state.read().unwrap();
6793 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6795 debug_assert!(false);
6796 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6798 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6799 let peer_state = &mut *peer_state_lock;
6800 match peer_state.channel_by_id.entry(msg.channel_id) {
6801 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6802 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6803 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6805 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6806 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6809 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))
6814 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6815 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6816 // closing a channel), so any changes are likely to be lost on restart!
6817 let per_peer_state = self.per_peer_state.read().unwrap();
6818 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6820 debug_assert!(false);
6821 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6823 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6824 let peer_state = &mut *peer_state_lock;
6825 match peer_state.channel_by_id.entry(msg.channel_id) {
6826 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6827 if (msg.failure_code & 0x8000) == 0 {
6828 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6829 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6831 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6832 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);
6834 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6835 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6839 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))
6843 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6844 let per_peer_state = self.per_peer_state.read().unwrap();
6845 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6847 debug_assert!(false);
6848 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6850 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6851 let peer_state = &mut *peer_state_lock;
6852 match peer_state.channel_by_id.entry(msg.channel_id) {
6853 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6854 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6855 let logger = WithChannelContext::from(&self.logger, &chan.context);
6856 let funding_txo = chan.context.get_funding_txo();
6857 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &&logger), chan_phase_entry);
6858 if let Some(monitor_update) = monitor_update_opt {
6859 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6860 peer_state, per_peer_state, chan);
6864 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6865 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6868 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))
6873 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, ChannelId, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6874 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 {
6875 let mut push_forward_event = false;
6876 let mut new_intercept_events = VecDeque::new();
6877 let mut failed_intercept_forwards = Vec::new();
6878 if !pending_forwards.is_empty() {
6879 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6880 let scid = match forward_info.routing {
6881 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6882 PendingHTLCRouting::Receive { .. } => 0,
6883 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6885 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6886 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6888 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6889 let forward_htlcs_empty = forward_htlcs.is_empty();
6890 match forward_htlcs.entry(scid) {
6891 hash_map::Entry::Occupied(mut entry) => {
6892 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6893 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info }));
6895 hash_map::Entry::Vacant(entry) => {
6896 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6897 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.chain_hash)
6899 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).to_byte_array());
6900 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6901 match pending_intercepts.entry(intercept_id) {
6902 hash_map::Entry::Vacant(entry) => {
6903 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6904 requested_next_hop_scid: scid,
6905 payment_hash: forward_info.payment_hash,
6906 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6907 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6910 entry.insert(PendingAddHTLCInfo {
6911 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info });
6913 hash_map::Entry::Occupied(_) => {
6914 let logger = WithContext::from(&self.logger, None, Some(prev_channel_id));
6915 log_info!(logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6916 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6917 short_channel_id: prev_short_channel_id,
6918 user_channel_id: Some(prev_user_channel_id),
6919 outpoint: prev_funding_outpoint,
6920 channel_id: prev_channel_id,
6921 htlc_id: prev_htlc_id,
6922 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6923 phantom_shared_secret: None,
6924 blinded_failure: forward_info.routing.blinded_failure(),
6927 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6928 HTLCFailReason::from_failure_code(0x4000 | 10),
6929 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6934 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6935 // payments are being processed.
6936 if forward_htlcs_empty {
6937 push_forward_event = true;
6939 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6940 prev_short_channel_id, prev_funding_outpoint, prev_channel_id, prev_htlc_id, prev_user_channel_id, forward_info })));
6947 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6948 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6951 if !new_intercept_events.is_empty() {
6952 let mut events = self.pending_events.lock().unwrap();
6953 events.append(&mut new_intercept_events);
6955 if push_forward_event { self.push_pending_forwards_ev() }
6959 fn push_pending_forwards_ev(&self) {
6960 let mut pending_events = self.pending_events.lock().unwrap();
6961 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6962 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6963 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6965 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6966 // events is done in batches and they are not removed until we're done processing each
6967 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6968 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6969 // payments will need an additional forwarding event before being claimed to make them look
6970 // real by taking more time.
6971 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6972 pending_events.push_back((Event::PendingHTLCsForwardable {
6973 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6978 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6979 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6980 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6981 /// the [`ChannelMonitorUpdate`] in question.
6982 fn raa_monitor_updates_held(&self,
6983 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6984 channel_funding_outpoint: OutPoint, channel_id: ChannelId, counterparty_node_id: PublicKey
6986 actions_blocking_raa_monitor_updates
6987 .get(&channel_id).map(|v| !v.is_empty()).unwrap_or(false)
6988 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6989 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6990 channel_funding_outpoint,
6992 counterparty_node_id,
6997 #[cfg(any(test, feature = "_test_utils"))]
6998 pub(crate) fn test_raa_monitor_updates_held(&self,
6999 counterparty_node_id: PublicKey, channel_id: ChannelId
7001 let per_peer_state = self.per_peer_state.read().unwrap();
7002 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
7003 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
7004 let peer_state = &mut *peer_state_lck;
7006 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
7007 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
7008 chan.context().get_funding_txo().unwrap(), channel_id, counterparty_node_id);
7014 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
7015 let htlcs_to_fail = {
7016 let per_peer_state = self.per_peer_state.read().unwrap();
7017 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
7019 debug_assert!(false);
7020 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7021 }).map(|mtx| mtx.lock().unwrap())?;
7022 let peer_state = &mut *peer_state_lock;
7023 match peer_state.channel_by_id.entry(msg.channel_id) {
7024 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7025 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7026 let logger = WithChannelContext::from(&self.logger, &chan.context);
7027 let funding_txo_opt = chan.context.get_funding_txo();
7028 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
7029 self.raa_monitor_updates_held(
7030 &peer_state.actions_blocking_raa_monitor_updates, funding_txo, msg.channel_id,
7031 *counterparty_node_id)
7033 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
7034 chan.revoke_and_ack(&msg, &self.fee_estimator, &&logger, mon_update_blocked), chan_phase_entry);
7035 if let Some(monitor_update) = monitor_update_opt {
7036 let funding_txo = funding_txo_opt
7037 .expect("Funding outpoint must have been set for RAA handling to succeed");
7038 handle_new_monitor_update!(self, funding_txo, monitor_update,
7039 peer_state_lock, peer_state, per_peer_state, chan);
7043 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7044 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
7047 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))
7050 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
7054 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
7055 let per_peer_state = self.per_peer_state.read().unwrap();
7056 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7058 debug_assert!(false);
7059 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7061 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7062 let peer_state = &mut *peer_state_lock;
7063 match peer_state.channel_by_id.entry(msg.channel_id) {
7064 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7065 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7066 let logger = WithChannelContext::from(&self.logger, &chan.context);
7067 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &&logger), chan_phase_entry);
7069 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7070 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
7073 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))
7078 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
7079 let per_peer_state = self.per_peer_state.read().unwrap();
7080 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7082 debug_assert!(false);
7083 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
7085 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7086 let peer_state = &mut *peer_state_lock;
7087 match peer_state.channel_by_id.entry(msg.channel_id) {
7088 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7089 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7090 if !chan.context.is_usable() {
7091 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
7094 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7095 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
7096 &self.node_signer, self.chain_hash, self.best_block.read().unwrap().height(),
7097 msg, &self.default_configuration
7098 ), chan_phase_entry),
7099 // Note that announcement_signatures fails if the channel cannot be announced,
7100 // so get_channel_update_for_broadcast will never fail by the time we get here.
7101 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
7104 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7105 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
7108 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))
7113 /// Returns DoPersist if anything changed, otherwise either SkipPersistNoEvents or an Err.
7114 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
7115 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
7116 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
7118 // It's not a local channel
7119 return Ok(NotifyOption::SkipPersistNoEvents)
7122 let per_peer_state = self.per_peer_state.read().unwrap();
7123 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
7124 if peer_state_mutex_opt.is_none() {
7125 return Ok(NotifyOption::SkipPersistNoEvents)
7127 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7128 let peer_state = &mut *peer_state_lock;
7129 match peer_state.channel_by_id.entry(chan_id) {
7130 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7131 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7132 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
7133 if chan.context.should_announce() {
7134 // If the announcement is about a channel of ours which is public, some
7135 // other peer may simply be forwarding all its gossip to us. Don't provide
7136 // a scary-looking error message and return Ok instead.
7137 return Ok(NotifyOption::SkipPersistNoEvents);
7139 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));
7141 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
7142 let msg_from_node_one = msg.contents.flags & 1 == 0;
7143 if were_node_one == msg_from_node_one {
7144 return Ok(NotifyOption::SkipPersistNoEvents);
7146 let logger = WithChannelContext::from(&self.logger, &chan.context);
7147 log_debug!(logger, "Received channel_update {:?} for channel {}.", msg, chan_id);
7148 let did_change = try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
7149 // If nothing changed after applying their update, we don't need to bother
7152 return Ok(NotifyOption::SkipPersistNoEvents);
7156 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7157 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
7160 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersistNoEvents)
7162 Ok(NotifyOption::DoPersist)
7165 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<NotifyOption, MsgHandleErrInternal> {
7167 let need_lnd_workaround = {
7168 let per_peer_state = self.per_peer_state.read().unwrap();
7170 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7172 debug_assert!(false);
7173 MsgHandleErrInternal::send_err_msg_no_close(
7174 format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id),
7178 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), Some(msg.channel_id));
7179 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7180 let peer_state = &mut *peer_state_lock;
7181 match peer_state.channel_by_id.entry(msg.channel_id) {
7182 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7183 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7184 // Currently, we expect all holding cell update_adds to be dropped on peer
7185 // disconnect, so Channel's reestablish will never hand us any holding cell
7186 // freed HTLCs to fail backwards. If in the future we no longer drop pending
7187 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
7188 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
7189 msg, &&logger, &self.node_signer, self.chain_hash,
7190 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
7191 let mut channel_update = None;
7192 if let Some(msg) = responses.shutdown_msg {
7193 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7194 node_id: counterparty_node_id.clone(),
7197 } else if chan.context.is_usable() {
7198 // If the channel is in a usable state (ie the channel is not being shut
7199 // down), send a unicast channel_update to our counterparty to make sure
7200 // they have the latest channel parameters.
7201 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
7202 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
7203 node_id: chan.context.get_counterparty_node_id(),
7208 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
7209 htlc_forwards = self.handle_channel_resumption(
7210 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
7211 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
7212 if let Some(upd) = channel_update {
7213 peer_state.pending_msg_events.push(upd);
7217 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7218 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
7221 hash_map::Entry::Vacant(_) => {
7222 log_debug!(logger, "Sending bogus ChannelReestablish for unknown channel {} to force channel closure",
7224 // Unfortunately, lnd doesn't force close on errors
7225 // (https://github.com/lightningnetwork/lnd/blob/abb1e3463f3a83bbb843d5c399869dbe930ad94f/htlcswitch/link.go#L2119).
7226 // One of the few ways to get an lnd counterparty to force close is by
7227 // replicating what they do when restoring static channel backups (SCBs). They
7228 // send an invalid `ChannelReestablish` with `0` commitment numbers and an
7229 // invalid `your_last_per_commitment_secret`.
7231 // Since we received a `ChannelReestablish` for a channel that doesn't exist, we
7232 // can assume it's likely the channel closed from our point of view, but it
7233 // remains open on the counterparty's side. By sending this bogus
7234 // `ChannelReestablish` message now as a response to theirs, we trigger them to
7235 // force close broadcasting their latest state. If the closing transaction from
7236 // our point of view remains unconfirmed, it'll enter a race with the
7237 // counterparty's to-be-broadcast latest commitment transaction.
7238 peer_state.pending_msg_events.push(MessageSendEvent::SendChannelReestablish {
7239 node_id: *counterparty_node_id,
7240 msg: msgs::ChannelReestablish {
7241 channel_id: msg.channel_id,
7242 next_local_commitment_number: 0,
7243 next_remote_commitment_number: 0,
7244 your_last_per_commitment_secret: [1u8; 32],
7245 my_current_per_commitment_point: PublicKey::from_slice(&[2u8; 33]).unwrap(),
7246 next_funding_txid: None,
7249 return Err(MsgHandleErrInternal::send_err_msg_no_close(
7250 format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
7251 counterparty_node_id), msg.channel_id)
7257 let mut persist = NotifyOption::SkipPersistHandleEvents;
7258 if let Some(forwards) = htlc_forwards {
7259 self.forward_htlcs(&mut [forwards][..]);
7260 persist = NotifyOption::DoPersist;
7263 if let Some(channel_ready_msg) = need_lnd_workaround {
7264 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
7269 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
7270 fn process_pending_monitor_events(&self) -> bool {
7271 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
7273 let mut failed_channels = Vec::new();
7274 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
7275 let has_pending_monitor_events = !pending_monitor_events.is_empty();
7276 for (funding_outpoint, channel_id, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
7277 for monitor_event in monitor_events.drain(..) {
7278 match monitor_event {
7279 MonitorEvent::HTLCEvent(htlc_update) => {
7280 let logger = WithContext::from(&self.logger, counterparty_node_id, Some(channel_id));
7281 if let Some(preimage) = htlc_update.payment_preimage {
7282 log_trace!(logger, "Claiming HTLC with preimage {} from our monitor", preimage);
7283 self.claim_funds_internal(htlc_update.source, preimage,
7284 htlc_update.htlc_value_satoshis.map(|v| v * 1000), None, true,
7285 false, counterparty_node_id, funding_outpoint, channel_id);
7287 log_trace!(logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
7288 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id };
7289 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7290 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
7293 MonitorEvent::HolderForceClosed(_funding_outpoint) => {
7294 let counterparty_node_id_opt = match counterparty_node_id {
7295 Some(cp_id) => Some(cp_id),
7297 // TODO: Once we can rely on the counterparty_node_id from the
7298 // monitor event, this and the outpoint_to_peer map should be removed.
7299 let outpoint_to_peer = self.outpoint_to_peer.lock().unwrap();
7300 outpoint_to_peer.get(&funding_outpoint).cloned()
7303 if let Some(counterparty_node_id) = counterparty_node_id_opt {
7304 let per_peer_state = self.per_peer_state.read().unwrap();
7305 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7306 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7307 let peer_state = &mut *peer_state_lock;
7308 let pending_msg_events = &mut peer_state.pending_msg_events;
7309 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id) {
7310 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
7311 failed_channels.push(chan.context.force_shutdown(false, ClosureReason::HolderForceClosed));
7312 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7313 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7317 pending_msg_events.push(events::MessageSendEvent::HandleError {
7318 node_id: chan.context.get_counterparty_node_id(),
7319 action: msgs::ErrorAction::DisconnectPeer {
7320 msg: Some(msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() })
7328 MonitorEvent::Completed { funding_txo, channel_id, monitor_update_id } => {
7329 self.channel_monitor_updated(&funding_txo, &channel_id, monitor_update_id, counterparty_node_id.as_ref());
7335 for failure in failed_channels.drain(..) {
7336 self.finish_close_channel(failure);
7339 has_pending_monitor_events
7342 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
7343 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
7344 /// update events as a separate process method here.
7346 pub fn process_monitor_events(&self) {
7347 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7348 self.process_pending_monitor_events();
7351 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
7352 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
7353 /// update was applied.
7354 fn check_free_holding_cells(&self) -> bool {
7355 let mut has_monitor_update = false;
7356 let mut failed_htlcs = Vec::new();
7358 // Walk our list of channels and find any that need to update. Note that when we do find an
7359 // update, if it includes actions that must be taken afterwards, we have to drop the
7360 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
7361 // manage to go through all our peers without finding a single channel to update.
7363 let per_peer_state = self.per_peer_state.read().unwrap();
7364 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7366 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7367 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
7368 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
7369 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
7371 let counterparty_node_id = chan.context.get_counterparty_node_id();
7372 let funding_txo = chan.context.get_funding_txo();
7373 let (monitor_opt, holding_cell_failed_htlcs) =
7374 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &&WithChannelContext::from(&self.logger, &chan.context));
7375 if !holding_cell_failed_htlcs.is_empty() {
7376 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
7378 if let Some(monitor_update) = monitor_opt {
7379 has_monitor_update = true;
7381 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
7382 peer_state_lock, peer_state, per_peer_state, chan);
7383 continue 'peer_loop;
7392 let has_update = has_monitor_update || !failed_htlcs.is_empty();
7393 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
7394 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
7400 /// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
7401 /// is (temporarily) unavailable, and the operation should be retried later.
7403 /// This method allows for that retry - either checking for any signer-pending messages to be
7404 /// attempted in every channel, or in the specifically provided channel.
7406 /// [`ChannelSigner`]: crate::sign::ChannelSigner
7407 #[cfg(async_signing)]
7408 pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
7409 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7411 let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
7412 let node_id = phase.context().get_counterparty_node_id();
7414 ChannelPhase::Funded(chan) => {
7415 let msgs = chan.signer_maybe_unblocked(&self.logger);
7416 if let Some(updates) = msgs.commitment_update {
7417 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
7422 if let Some(msg) = msgs.funding_signed {
7423 pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
7428 if let Some(msg) = msgs.channel_ready {
7429 send_channel_ready!(self, pending_msg_events, chan, msg);
7432 ChannelPhase::UnfundedOutboundV1(chan) => {
7433 if let Some(msg) = chan.signer_maybe_unblocked(&self.logger) {
7434 pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
7440 ChannelPhase::UnfundedInboundV1(_) => {},
7444 let per_peer_state = self.per_peer_state.read().unwrap();
7445 if let Some((counterparty_node_id, channel_id)) = channel_opt {
7446 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7447 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7448 let peer_state = &mut *peer_state_lock;
7449 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
7450 unblock_chan(chan, &mut peer_state.pending_msg_events);
7454 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7455 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7456 let peer_state = &mut *peer_state_lock;
7457 for (_, chan) in peer_state.channel_by_id.iter_mut() {
7458 unblock_chan(chan, &mut peer_state.pending_msg_events);
7464 /// Check whether any channels have finished removing all pending updates after a shutdown
7465 /// exchange and can now send a closing_signed.
7466 /// Returns whether any closing_signed messages were generated.
7467 fn maybe_generate_initial_closing_signed(&self) -> bool {
7468 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
7469 let mut has_update = false;
7470 let mut shutdown_results = Vec::new();
7472 let per_peer_state = self.per_peer_state.read().unwrap();
7474 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7475 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7476 let peer_state = &mut *peer_state_lock;
7477 let pending_msg_events = &mut peer_state.pending_msg_events;
7478 peer_state.channel_by_id.retain(|channel_id, phase| {
7480 ChannelPhase::Funded(chan) => {
7481 let logger = WithChannelContext::from(&self.logger, &chan.context);
7482 match chan.maybe_propose_closing_signed(&self.fee_estimator, &&logger) {
7483 Ok((msg_opt, tx_opt, shutdown_result_opt)) => {
7484 if let Some(msg) = msg_opt {
7486 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
7487 node_id: chan.context.get_counterparty_node_id(), msg,
7490 debug_assert_eq!(shutdown_result_opt.is_some(), chan.is_shutdown());
7491 if let Some(shutdown_result) = shutdown_result_opt {
7492 shutdown_results.push(shutdown_result);
7494 if let Some(tx) = tx_opt {
7495 // We're done with this channel. We got a closing_signed and sent back
7496 // a closing_signed with a closing transaction to broadcast.
7497 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7498 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7503 log_info!(logger, "Broadcasting {}", log_tx!(tx));
7504 self.tx_broadcaster.broadcast_transactions(&[&tx]);
7505 update_maps_on_chan_removal!(self, &chan.context);
7511 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
7512 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
7517 _ => true, // Retain unfunded channels if present.
7523 for (counterparty_node_id, err) in handle_errors.drain(..) {
7524 let _ = handle_error!(self, err, counterparty_node_id);
7527 for shutdown_result in shutdown_results.drain(..) {
7528 self.finish_close_channel(shutdown_result);
7534 /// Handle a list of channel failures during a block_connected or block_disconnected call,
7535 /// pushing the channel monitor update (if any) to the background events queue and removing the
7537 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
7538 for mut failure in failed_channels.drain(..) {
7539 // Either a commitment transactions has been confirmed on-chain or
7540 // Channel::block_disconnected detected that the funding transaction has been
7541 // reorganized out of the main chain.
7542 // We cannot broadcast our latest local state via monitor update (as
7543 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
7544 // so we track the update internally and handle it when the user next calls
7545 // timer_tick_occurred, guaranteeing we're running normally.
7546 if let Some((counterparty_node_id, funding_txo, channel_id, update)) = failure.monitor_update.take() {
7547 assert_eq!(update.updates.len(), 1);
7548 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
7549 assert!(should_broadcast);
7550 } else { unreachable!(); }
7551 self.pending_background_events.lock().unwrap().push(
7552 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
7553 counterparty_node_id, funding_txo, update, channel_id,
7556 self.finish_close_channel(failure);
7560 /// Creates an [`OfferBuilder`] such that the [`Offer`] it builds is recognized by the
7561 /// [`ChannelManager`] when handling [`InvoiceRequest`] messages for the offer. The offer will
7562 /// not have an expiration unless otherwise set on the builder.
7566 /// Uses [`MessageRouter::create_blinded_paths`] to construct a [`BlindedPath`] for the offer.
7567 /// However, if one is not found, uses a one-hop [`BlindedPath`] with
7568 /// [`ChannelManager::get_our_node_id`] as the introduction node instead. In the latter case,
7569 /// the node must be announced, otherwise, there is no way to find a path to the introduction in
7570 /// order to send the [`InvoiceRequest`].
7572 /// Also, uses a derived signing pubkey in the offer for recipient privacy.
7576 /// Requires a direct connection to the introduction node in the responding [`InvoiceRequest`]'s
7581 /// Errors if the parameterized [`Router`] is unable to create a blinded path for the offer.
7583 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7585 /// [`Offer`]: crate::offers::offer::Offer
7586 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7587 pub fn create_offer_builder(
7588 &self, description: String
7589 ) -> Result<OfferBuilder<DerivedMetadata, secp256k1::All>, Bolt12SemanticError> {
7590 let node_id = self.get_our_node_id();
7591 let expanded_key = &self.inbound_payment_key;
7592 let entropy = &*self.entropy_source;
7593 let secp_ctx = &self.secp_ctx;
7595 let path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7596 let builder = OfferBuilder::deriving_signing_pubkey(
7597 description, node_id, expanded_key, entropy, secp_ctx
7599 .chain_hash(self.chain_hash)
7605 /// Creates a [`RefundBuilder`] such that the [`Refund`] it builds is recognized by the
7606 /// [`ChannelManager`] when handling [`Bolt12Invoice`] messages for the refund.
7610 /// The provided `payment_id` is used to ensure that only one invoice is paid for the refund.
7611 /// See [Avoiding Duplicate Payments] for other requirements once the payment has been sent.
7613 /// The builder will have the provided expiration set. Any changes to the expiration on the
7614 /// returned builder will not be honored by [`ChannelManager`]. For `no-std`, the highest seen
7615 /// block time minus two hours is used for the current time when determining if the refund has
7618 /// To revoke the refund, use [`ChannelManager::abandon_payment`] prior to receiving the
7619 /// invoice. If abandoned, or an invoice isn't received before expiration, the payment will fail
7620 /// with an [`Event::InvoiceRequestFailed`].
7622 /// If `max_total_routing_fee_msat` is not specified, The default from
7623 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7627 /// Uses [`MessageRouter::create_blinded_paths`] to construct a [`BlindedPath`] for the refund.
7628 /// However, if one is not found, uses a one-hop [`BlindedPath`] with
7629 /// [`ChannelManager::get_our_node_id`] as the introduction node instead. In the latter case,
7630 /// the node must be announced, otherwise, there is no way to find a path to the introduction in
7631 /// order to send the [`Bolt12Invoice`].
7633 /// Also, uses a derived payer id in the refund for payer privacy.
7637 /// Requires a direct connection to an introduction node in the responding
7638 /// [`Bolt12Invoice::payment_paths`].
7643 /// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
7644 /// - `amount_msats` is invalid, or
7645 /// - the parameterized [`Router`] is unable to create a blinded path for the refund.
7647 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7649 /// [`Refund`]: crate::offers::refund::Refund
7650 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7651 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7652 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7653 pub fn create_refund_builder(
7654 &self, description: String, amount_msats: u64, absolute_expiry: Duration,
7655 payment_id: PaymentId, retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
7656 ) -> Result<RefundBuilder<secp256k1::All>, Bolt12SemanticError> {
7657 let node_id = self.get_our_node_id();
7658 let expanded_key = &self.inbound_payment_key;
7659 let entropy = &*self.entropy_source;
7660 let secp_ctx = &self.secp_ctx;
7662 let path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7663 let builder = RefundBuilder::deriving_payer_id(
7664 description, node_id, expanded_key, entropy, secp_ctx, amount_msats, payment_id
7666 .chain_hash(self.chain_hash)
7667 .absolute_expiry(absolute_expiry)
7670 let expiration = StaleExpiration::AbsoluteTimeout(absolute_expiry);
7671 self.pending_outbound_payments
7672 .add_new_awaiting_invoice(
7673 payment_id, expiration, retry_strategy, max_total_routing_fee_msat,
7675 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7680 /// Pays for an [`Offer`] using the given parameters by creating an [`InvoiceRequest`] and
7681 /// enqueuing it to be sent via an onion message. [`ChannelManager`] will pay the actual
7682 /// [`Bolt12Invoice`] once it is received.
7684 /// Uses [`InvoiceRequestBuilder`] such that the [`InvoiceRequest`] it builds is recognized by
7685 /// the [`ChannelManager`] when handling a [`Bolt12Invoice`] message in response to the request.
7686 /// The optional parameters are used in the builder, if `Some`:
7687 /// - `quantity` for [`InvoiceRequest::quantity`] which must be set if
7688 /// [`Offer::expects_quantity`] is `true`.
7689 /// - `amount_msats` if overpaying what is required for the given `quantity` is desired, and
7690 /// - `payer_note` for [`InvoiceRequest::payer_note`].
7692 /// If `max_total_routing_fee_msat` is not specified, The default from
7693 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7697 /// The provided `payment_id` is used to ensure that only one invoice is paid for the request
7698 /// when received. See [Avoiding Duplicate Payments] for other requirements once the payment has
7701 /// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
7702 /// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
7703 /// payment will fail with an [`Event::InvoiceRequestFailed`].
7707 /// Uses a one-hop [`BlindedPath`] for the reply path with [`ChannelManager::get_our_node_id`]
7708 /// as the introduction node and a derived payer id for payer privacy. As such, currently, the
7709 /// node must be announced. Otherwise, there is no way to find a path to the introduction node
7710 /// in order to send the [`Bolt12Invoice`].
7714 /// Requires a direct connection to an introduction node in [`Offer::paths`] or to
7715 /// [`Offer::signing_pubkey`], if empty. A similar restriction applies to the responding
7716 /// [`Bolt12Invoice::payment_paths`].
7721 /// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
7722 /// - the provided parameters are invalid for the offer,
7723 /// - the parameterized [`Router`] is unable to create a blinded reply path for the invoice
7726 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7727 /// [`InvoiceRequest::quantity`]: crate::offers::invoice_request::InvoiceRequest::quantity
7728 /// [`InvoiceRequest::payer_note`]: crate::offers::invoice_request::InvoiceRequest::payer_note
7729 /// [`InvoiceRequestBuilder`]: crate::offers::invoice_request::InvoiceRequestBuilder
7730 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7731 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7732 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7733 pub fn pay_for_offer(
7734 &self, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>,
7735 payer_note: Option<String>, payment_id: PaymentId, retry_strategy: Retry,
7736 max_total_routing_fee_msat: Option<u64>
7737 ) -> Result<(), Bolt12SemanticError> {
7738 let expanded_key = &self.inbound_payment_key;
7739 let entropy = &*self.entropy_source;
7740 let secp_ctx = &self.secp_ctx;
7743 .request_invoice_deriving_payer_id(expanded_key, entropy, secp_ctx, payment_id)?
7744 .chain_hash(self.chain_hash)?;
7745 let builder = match quantity {
7747 Some(quantity) => builder.quantity(quantity)?,
7749 let builder = match amount_msats {
7751 Some(amount_msats) => builder.amount_msats(amount_msats)?,
7753 let builder = match payer_note {
7755 Some(payer_note) => builder.payer_note(payer_note),
7757 let invoice_request = builder.build_and_sign()?;
7758 let reply_path = self.create_blinded_path().map_err(|_| Bolt12SemanticError::MissingPaths)?;
7760 let expiration = StaleExpiration::TimerTicks(1);
7761 self.pending_outbound_payments
7762 .add_new_awaiting_invoice(
7763 payment_id, expiration, retry_strategy, max_total_routing_fee_msat
7765 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7767 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7768 if offer.paths().is_empty() {
7769 let message = new_pending_onion_message(
7770 OffersMessage::InvoiceRequest(invoice_request),
7771 Destination::Node(offer.signing_pubkey()),
7774 pending_offers_messages.push(message);
7776 // Send as many invoice requests as there are paths in the offer (with an upper bound).
7777 // Using only one path could result in a failure if the path no longer exists. But only
7778 // one invoice for a given payment id will be paid, even if more than one is received.
7779 const REQUEST_LIMIT: usize = 10;
7780 for path in offer.paths().into_iter().take(REQUEST_LIMIT) {
7781 let message = new_pending_onion_message(
7782 OffersMessage::InvoiceRequest(invoice_request.clone()),
7783 Destination::BlindedPath(path.clone()),
7784 Some(reply_path.clone()),
7786 pending_offers_messages.push(message);
7793 /// Creates a [`Bolt12Invoice`] for a [`Refund`] and enqueues it to be sent via an onion
7796 /// The resulting invoice uses a [`PaymentHash`] recognized by the [`ChannelManager`] and a
7797 /// [`BlindedPath`] containing the [`PaymentSecret`] needed to reconstruct the corresponding
7798 /// [`PaymentPreimage`].
7802 /// Requires a direct connection to an introduction node in [`Refund::paths`] or to
7803 /// [`Refund::payer_id`], if empty. This request is best effort; an invoice will be sent to each
7804 /// node meeting the aforementioned criteria, but there's no guarantee that they will be
7805 /// received and no retries will be made.
7809 /// Errors if the parameterized [`Router`] is unable to create a blinded payment path or reply
7810 /// path for the invoice.
7812 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7813 pub fn request_refund_payment(&self, refund: &Refund) -> Result<(), Bolt12SemanticError> {
7814 let expanded_key = &self.inbound_payment_key;
7815 let entropy = &*self.entropy_source;
7816 let secp_ctx = &self.secp_ctx;
7818 let amount_msats = refund.amount_msats();
7819 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
7821 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
7822 Ok((payment_hash, payment_secret)) => {
7823 let payment_paths = self.create_blinded_payment_paths(amount_msats, payment_secret)
7824 .map_err(|_| Bolt12SemanticError::MissingPaths)?;
7826 #[cfg(feature = "std")]
7827 let builder = refund.respond_using_derived_keys(
7828 payment_paths, payment_hash, expanded_key, entropy
7830 #[cfg(not(feature = "std"))]
7831 let created_at = Duration::from_secs(
7832 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
7834 #[cfg(not(feature = "std"))]
7835 let builder = refund.respond_using_derived_keys_no_std(
7836 payment_paths, payment_hash, created_at, expanded_key, entropy
7838 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
7839 let reply_path = self.create_blinded_path()
7840 .map_err(|_| Bolt12SemanticError::MissingPaths)?;
7842 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7843 if refund.paths().is_empty() {
7844 let message = new_pending_onion_message(
7845 OffersMessage::Invoice(invoice),
7846 Destination::Node(refund.payer_id()),
7849 pending_offers_messages.push(message);
7851 for path in refund.paths() {
7852 let message = new_pending_onion_message(
7853 OffersMessage::Invoice(invoice.clone()),
7854 Destination::BlindedPath(path.clone()),
7855 Some(reply_path.clone()),
7857 pending_offers_messages.push(message);
7863 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
7867 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
7870 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
7871 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
7873 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
7874 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
7875 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
7876 /// passed directly to [`claim_funds`].
7878 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
7880 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7881 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7885 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7886 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7888 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7890 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7891 /// on versions of LDK prior to 0.0.114.
7893 /// [`claim_funds`]: Self::claim_funds
7894 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7895 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
7896 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
7897 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
7898 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
7899 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
7900 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
7901 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
7902 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7903 min_final_cltv_expiry_delta)
7906 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
7907 /// stored external to LDK.
7909 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
7910 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
7911 /// the `min_value_msat` provided here, if one is provided.
7913 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
7914 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
7917 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
7918 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
7919 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
7920 /// sender "proof-of-payment" unless they have paid the required amount.
7922 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
7923 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
7924 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
7925 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
7926 /// invoices when no timeout is set.
7928 /// Note that we use block header time to time-out pending inbound payments (with some margin
7929 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
7930 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
7931 /// If you need exact expiry semantics, you should enforce them upon receipt of
7932 /// [`PaymentClaimable`].
7934 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
7935 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
7937 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7938 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7942 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7943 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7945 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7947 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7948 /// on versions of LDK prior to 0.0.114.
7950 /// [`create_inbound_payment`]: Self::create_inbound_payment
7951 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7952 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
7953 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
7954 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
7955 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7956 min_final_cltv_expiry)
7959 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
7960 /// previously returned from [`create_inbound_payment`].
7962 /// [`create_inbound_payment`]: Self::create_inbound_payment
7963 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
7964 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
7967 /// Creates a blinded path by delegating to [`MessageRouter::create_blinded_paths`].
7969 /// Errors if the `MessageRouter` errors or returns an empty `Vec`.
7970 fn create_blinded_path(&self) -> Result<BlindedPath, ()> {
7971 let recipient = self.get_our_node_id();
7972 let entropy_source = self.entropy_source.deref();
7973 let secp_ctx = &self.secp_ctx;
7975 let peers = self.per_peer_state.read().unwrap()
7977 .filter(|(_, peer)| peer.lock().unwrap().latest_features.supports_onion_messages())
7978 .map(|(node_id, _)| *node_id)
7979 .collect::<Vec<_>>();
7982 .create_blinded_paths(recipient, peers, entropy_source, secp_ctx)
7983 .and_then(|paths| paths.into_iter().next().ok_or(()))
7986 /// Creates multi-hop blinded payment paths for the given `amount_msats` by delegating to
7987 /// [`Router::create_blinded_payment_paths`].
7988 fn create_blinded_payment_paths(
7989 &self, amount_msats: u64, payment_secret: PaymentSecret
7990 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
7991 let entropy_source = self.entropy_source.deref();
7992 let secp_ctx = &self.secp_ctx;
7994 let first_hops = self.list_usable_channels();
7995 let payee_node_id = self.get_our_node_id();
7996 let max_cltv_expiry = self.best_block.read().unwrap().height() + CLTV_FAR_FAR_AWAY
7997 + LATENCY_GRACE_PERIOD_BLOCKS;
7998 let payee_tlvs = ReceiveTlvs {
8000 payment_constraints: PaymentConstraints {
8002 htlc_minimum_msat: 1,
8005 self.router.create_blinded_payment_paths(
8006 payee_node_id, first_hops, payee_tlvs, amount_msats, entropy_source, secp_ctx
8010 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
8011 /// are used when constructing the phantom invoice's route hints.
8013 /// [phantom node payments]: crate::sign::PhantomKeysManager
8014 pub fn get_phantom_scid(&self) -> u64 {
8015 let best_block_height = self.best_block.read().unwrap().height();
8016 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
8018 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
8019 // Ensure the generated scid doesn't conflict with a real channel.
8020 match short_to_chan_info.get(&scid_candidate) {
8021 Some(_) => continue,
8022 None => return scid_candidate
8027 /// Gets route hints for use in receiving [phantom node payments].
8029 /// [phantom node payments]: crate::sign::PhantomKeysManager
8030 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
8032 channels: self.list_usable_channels(),
8033 phantom_scid: self.get_phantom_scid(),
8034 real_node_pubkey: self.get_our_node_id(),
8038 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
8039 /// used when constructing the route hints for HTLCs intended to be intercepted. See
8040 /// [`ChannelManager::forward_intercepted_htlc`].
8042 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
8043 /// times to get a unique scid.
8044 pub fn get_intercept_scid(&self) -> u64 {
8045 let best_block_height = self.best_block.read().unwrap().height();
8046 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
8048 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
8049 // Ensure the generated scid doesn't conflict with a real channel.
8050 if short_to_chan_info.contains_key(&scid_candidate) { continue }
8051 return scid_candidate
8055 /// Gets inflight HTLC information by processing pending outbound payments that are in
8056 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
8057 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
8058 let mut inflight_htlcs = InFlightHtlcs::new();
8060 let per_peer_state = self.per_peer_state.read().unwrap();
8061 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8062 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8063 let peer_state = &mut *peer_state_lock;
8064 for chan in peer_state.channel_by_id.values().filter_map(
8065 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
8067 for (htlc_source, _) in chan.inflight_htlc_sources() {
8068 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
8069 inflight_htlcs.process_path(path, self.get_our_node_id());
8078 #[cfg(any(test, feature = "_test_utils"))]
8079 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
8080 let events = core::cell::RefCell::new(Vec::new());
8081 let event_handler = |event: events::Event| events.borrow_mut().push(event);
8082 self.process_pending_events(&event_handler);
8086 #[cfg(feature = "_test_utils")]
8087 pub fn push_pending_event(&self, event: events::Event) {
8088 let mut events = self.pending_events.lock().unwrap();
8089 events.push_back((event, None));
8093 pub fn pop_pending_event(&self) -> Option<events::Event> {
8094 let mut events = self.pending_events.lock().unwrap();
8095 events.pop_front().map(|(e, _)| e)
8099 pub fn has_pending_payments(&self) -> bool {
8100 self.pending_outbound_payments.has_pending_payments()
8104 pub fn clear_pending_payments(&self) {
8105 self.pending_outbound_payments.clear_pending_payments()
8108 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
8109 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
8110 /// operation. It will double-check that nothing *else* is also blocking the same channel from
8111 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
8112 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey,
8113 channel_funding_outpoint: OutPoint, channel_id: ChannelId,
8114 mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
8116 let logger = WithContext::from(
8117 &self.logger, Some(counterparty_node_id), Some(channel_id),
8120 let per_peer_state = self.per_peer_state.read().unwrap();
8121 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
8122 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
8123 let peer_state = &mut *peer_state_lck;
8124 if let Some(blocker) = completed_blocker.take() {
8125 // Only do this on the first iteration of the loop.
8126 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
8127 .get_mut(&channel_id)
8129 blockers.retain(|iter| iter != &blocker);
8133 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
8134 channel_funding_outpoint, channel_id, counterparty_node_id) {
8135 // Check that, while holding the peer lock, we don't have anything else
8136 // blocking monitor updates for this channel. If we do, release the monitor
8137 // update(s) when those blockers complete.
8138 log_trace!(logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
8143 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(
8145 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
8146 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
8147 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
8148 log_debug!(logger, "Unlocking monitor updating for channel {} and updating monitor",
8150 handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
8151 peer_state_lck, peer_state, per_peer_state, chan);
8152 if further_update_exists {
8153 // If there are more `ChannelMonitorUpdate`s to process, restart at the
8158 log_trace!(logger, "Unlocked monitor updating for channel {} without monitors to update",
8165 "Got a release post-RAA monitor update for peer {} but the channel is gone",
8166 log_pubkey!(counterparty_node_id));
8172 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
8173 for action in actions {
8175 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
8176 channel_funding_outpoint, channel_id, counterparty_node_id
8178 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, channel_id, None);
8184 /// Processes any events asynchronously in the order they were generated since the last call
8185 /// using the given event handler.
8187 /// See the trait-level documentation of [`EventsProvider`] for requirements.
8188 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
8192 process_events_body!(self, ev, { handler(ev).await });
8196 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>
8198 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8199 T::Target: BroadcasterInterface,
8200 ES::Target: EntropySource,
8201 NS::Target: NodeSigner,
8202 SP::Target: SignerProvider,
8203 F::Target: FeeEstimator,
8207 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
8208 /// The returned array will contain `MessageSendEvent`s for different peers if
8209 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
8210 /// is always placed next to each other.
8212 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
8213 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
8214 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
8215 /// will randomly be placed first or last in the returned array.
8217 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
8218 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
8219 /// the `MessageSendEvent`s to the specific peer they were generated under.
8220 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
8221 let events = RefCell::new(Vec::new());
8222 PersistenceNotifierGuard::optionally_notify(self, || {
8223 let mut result = NotifyOption::SkipPersistNoEvents;
8225 // TODO: This behavior should be documented. It's unintuitive that we query
8226 // ChannelMonitors when clearing other events.
8227 if self.process_pending_monitor_events() {
8228 result = NotifyOption::DoPersist;
8231 if self.check_free_holding_cells() {
8232 result = NotifyOption::DoPersist;
8234 if self.maybe_generate_initial_closing_signed() {
8235 result = NotifyOption::DoPersist;
8238 let mut pending_events = Vec::new();
8239 let per_peer_state = self.per_peer_state.read().unwrap();
8240 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8241 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8242 let peer_state = &mut *peer_state_lock;
8243 if peer_state.pending_msg_events.len() > 0 {
8244 pending_events.append(&mut peer_state.pending_msg_events);
8248 if !pending_events.is_empty() {
8249 events.replace(pending_events);
8258 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>
8260 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8261 T::Target: BroadcasterInterface,
8262 ES::Target: EntropySource,
8263 NS::Target: NodeSigner,
8264 SP::Target: SignerProvider,
8265 F::Target: FeeEstimator,
8269 /// Processes events that must be periodically handled.
8271 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
8272 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
8273 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
8275 process_events_body!(self, ev, handler.handle_event(ev));
8279 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>
8281 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8282 T::Target: BroadcasterInterface,
8283 ES::Target: EntropySource,
8284 NS::Target: NodeSigner,
8285 SP::Target: SignerProvider,
8286 F::Target: FeeEstimator,
8290 fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
8292 let best_block = self.best_block.read().unwrap();
8293 assert_eq!(best_block.block_hash(), header.prev_blockhash,
8294 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
8295 assert_eq!(best_block.height(), height - 1,
8296 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
8299 self.transactions_confirmed(header, txdata, height);
8300 self.best_block_updated(header, height);
8303 fn block_disconnected(&self, header: &Header, height: u32) {
8304 let _persistence_guard =
8305 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8306 self, || -> NotifyOption { NotifyOption::DoPersist });
8307 let new_height = height - 1;
8309 let mut best_block = self.best_block.write().unwrap();
8310 assert_eq!(best_block.block_hash(), header.block_hash(),
8311 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
8312 assert_eq!(best_block.height(), height,
8313 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
8314 *best_block = BestBlock::new(header.prev_blockhash, new_height)
8317 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)));
8321 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>
8323 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8324 T::Target: BroadcasterInterface,
8325 ES::Target: EntropySource,
8326 NS::Target: NodeSigner,
8327 SP::Target: SignerProvider,
8328 F::Target: FeeEstimator,
8332 fn transactions_confirmed(&self, header: &Header, txdata: &TransactionData, height: u32) {
8333 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8334 // during initialization prior to the chain_monitor being fully configured in some cases.
8335 // See the docs for `ChannelManagerReadArgs` for more.
8337 let block_hash = header.block_hash();
8338 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
8340 let _persistence_guard =
8341 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8342 self, || -> NotifyOption { NotifyOption::DoPersist });
8343 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))
8344 .map(|(a, b)| (a, Vec::new(), b)));
8346 let last_best_block_height = self.best_block.read().unwrap().height();
8347 if height < last_best_block_height {
8348 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
8349 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)));
8353 fn best_block_updated(&self, header: &Header, height: u32) {
8354 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8355 // during initialization prior to the chain_monitor being fully configured in some cases.
8356 // See the docs for `ChannelManagerReadArgs` for more.
8358 let block_hash = header.block_hash();
8359 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
8361 let _persistence_guard =
8362 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8363 self, || -> NotifyOption { NotifyOption::DoPersist });
8364 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
8366 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)));
8368 macro_rules! max_time {
8369 ($timestamp: expr) => {
8371 // Update $timestamp to be the max of its current value and the block
8372 // timestamp. This should keep us close to the current time without relying on
8373 // having an explicit local time source.
8374 // Just in case we end up in a race, we loop until we either successfully
8375 // update $timestamp or decide we don't need to.
8376 let old_serial = $timestamp.load(Ordering::Acquire);
8377 if old_serial >= header.time as usize { break; }
8378 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
8384 max_time!(self.highest_seen_timestamp);
8385 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
8386 payment_secrets.retain(|_, inbound_payment| {
8387 inbound_payment.expiry_time > header.time as u64
8391 fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
8392 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
8393 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
8394 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8395 let peer_state = &mut *peer_state_lock;
8396 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
8397 let txid_opt = chan.context.get_funding_txo();
8398 let height_opt = chan.context.get_funding_tx_confirmation_height();
8399 let hash_opt = chan.context.get_funding_tx_confirmed_in();
8400 if let (Some(funding_txo), Some(conf_height), Some(block_hash)) = (txid_opt, height_opt, hash_opt) {
8401 res.push((funding_txo.txid, conf_height, Some(block_hash)));
8408 fn transaction_unconfirmed(&self, txid: &Txid) {
8409 let _persistence_guard =
8410 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8411 self, || -> NotifyOption { NotifyOption::DoPersist });
8412 self.do_chain_event(None, |channel| {
8413 if let Some(funding_txo) = channel.context.get_funding_txo() {
8414 if funding_txo.txid == *txid {
8415 channel.funding_transaction_unconfirmed(&&WithChannelContext::from(&self.logger, &channel.context)).map(|()| (None, Vec::new(), None))
8416 } else { Ok((None, Vec::new(), None)) }
8417 } else { Ok((None, Vec::new(), None)) }
8422 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>
8424 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8425 T::Target: BroadcasterInterface,
8426 ES::Target: EntropySource,
8427 NS::Target: NodeSigner,
8428 SP::Target: SignerProvider,
8429 F::Target: FeeEstimator,
8433 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
8434 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
8436 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
8437 (&self, height_opt: Option<u32>, f: FN) {
8438 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8439 // during initialization prior to the chain_monitor being fully configured in some cases.
8440 // See the docs for `ChannelManagerReadArgs` for more.
8442 let mut failed_channels = Vec::new();
8443 let mut timed_out_htlcs = Vec::new();
8445 let per_peer_state = self.per_peer_state.read().unwrap();
8446 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8447 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8448 let peer_state = &mut *peer_state_lock;
8449 let pending_msg_events = &mut peer_state.pending_msg_events;
8450 peer_state.channel_by_id.retain(|_, phase| {
8452 // Retain unfunded channels.
8453 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
8454 ChannelPhase::Funded(channel) => {
8455 let res = f(channel);
8456 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
8457 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
8458 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
8459 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
8460 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
8462 let logger = WithChannelContext::from(&self.logger, &channel.context);
8463 if let Some(channel_ready) = channel_ready_opt {
8464 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
8465 if channel.context.is_usable() {
8466 log_trace!(logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
8467 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
8468 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
8469 node_id: channel.context.get_counterparty_node_id(),
8474 log_trace!(logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
8479 let mut pending_events = self.pending_events.lock().unwrap();
8480 emit_channel_ready_event!(pending_events, channel);
8483 if let Some(announcement_sigs) = announcement_sigs {
8484 log_trace!(logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
8485 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
8486 node_id: channel.context.get_counterparty_node_id(),
8487 msg: announcement_sigs,
8489 if let Some(height) = height_opt {
8490 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.chain_hash, height, &self.default_configuration) {
8491 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
8493 // Note that announcement_signatures fails if the channel cannot be announced,
8494 // so get_channel_update_for_broadcast will never fail by the time we get here.
8495 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
8500 if channel.is_our_channel_ready() {
8501 if let Some(real_scid) = channel.context.get_short_channel_id() {
8502 // If we sent a 0conf channel_ready, and now have an SCID, we add it
8503 // to the short_to_chan_info map here. Note that we check whether we
8504 // can relay using the real SCID at relay-time (i.e.
8505 // enforce option_scid_alias then), and if the funding tx is ever
8506 // un-confirmed we force-close the channel, ensuring short_to_chan_info
8507 // is always consistent.
8508 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
8509 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8510 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
8511 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
8512 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
8515 } else if let Err(reason) = res {
8516 update_maps_on_chan_removal!(self, &channel.context);
8517 // It looks like our counterparty went on-chain or funding transaction was
8518 // reorged out of the main chain. Close the channel.
8519 let reason_message = format!("{}", reason);
8520 failed_channels.push(channel.context.force_shutdown(true, reason));
8521 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
8522 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
8526 pending_msg_events.push(events::MessageSendEvent::HandleError {
8527 node_id: channel.context.get_counterparty_node_id(),
8528 action: msgs::ErrorAction::DisconnectPeer {
8529 msg: Some(msgs::ErrorMessage {
8530 channel_id: channel.context.channel_id(),
8531 data: reason_message,
8544 if let Some(height) = height_opt {
8545 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
8546 payment.htlcs.retain(|htlc| {
8547 // If height is approaching the number of blocks we think it takes us to get
8548 // our commitment transaction confirmed before the HTLC expires, plus the
8549 // number of blocks we generally consider it to take to do a commitment update,
8550 // just give up on it and fail the HTLC.
8551 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
8552 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
8553 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
8555 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
8556 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
8557 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
8561 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
8564 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
8565 intercepted_htlcs.retain(|_, htlc| {
8566 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
8567 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
8568 short_channel_id: htlc.prev_short_channel_id,
8569 user_channel_id: Some(htlc.prev_user_channel_id),
8570 htlc_id: htlc.prev_htlc_id,
8571 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
8572 phantom_shared_secret: None,
8573 outpoint: htlc.prev_funding_outpoint,
8574 channel_id: htlc.prev_channel_id,
8575 blinded_failure: htlc.forward_info.routing.blinded_failure(),
8578 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
8579 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
8580 _ => unreachable!(),
8582 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
8583 HTLCFailReason::from_failure_code(0x2000 | 2),
8584 HTLCDestination::InvalidForward { requested_forward_scid }));
8585 let logger = WithContext::from(
8586 &self.logger, None, Some(htlc.prev_channel_id)
8588 log_trace!(logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
8594 self.handle_init_event_channel_failures(failed_channels);
8596 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
8597 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
8601 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
8602 /// may have events that need processing.
8604 /// In order to check if this [`ChannelManager`] needs persisting, call
8605 /// [`Self::get_and_clear_needs_persistence`].
8607 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
8608 /// [`ChannelManager`] and should instead register actions to be taken later.
8609 pub fn get_event_or_persistence_needed_future(&self) -> Future {
8610 self.event_persist_notifier.get_future()
8613 /// Returns true if this [`ChannelManager`] needs to be persisted.
8614 pub fn get_and_clear_needs_persistence(&self) -> bool {
8615 self.needs_persist_flag.swap(false, Ordering::AcqRel)
8618 #[cfg(any(test, feature = "_test_utils"))]
8619 pub fn get_event_or_persist_condvar_value(&self) -> bool {
8620 self.event_persist_notifier.notify_pending()
8623 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
8624 /// [`chain::Confirm`] interfaces.
8625 pub fn current_best_block(&self) -> BestBlock {
8626 self.best_block.read().unwrap().clone()
8629 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
8630 /// [`ChannelManager`].
8631 pub fn node_features(&self) -> NodeFeatures {
8632 provided_node_features(&self.default_configuration)
8635 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
8636 /// [`ChannelManager`].
8638 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8639 /// or not. Thus, this method is not public.
8640 #[cfg(any(feature = "_test_utils", test))]
8641 pub fn bolt11_invoice_features(&self) -> Bolt11InvoiceFeatures {
8642 provided_bolt11_invoice_features(&self.default_configuration)
8645 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
8646 /// [`ChannelManager`].
8647 fn bolt12_invoice_features(&self) -> Bolt12InvoiceFeatures {
8648 provided_bolt12_invoice_features(&self.default_configuration)
8651 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
8652 /// [`ChannelManager`].
8653 pub fn channel_features(&self) -> ChannelFeatures {
8654 provided_channel_features(&self.default_configuration)
8657 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
8658 /// [`ChannelManager`].
8659 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
8660 provided_channel_type_features(&self.default_configuration)
8663 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
8664 /// [`ChannelManager`].
8665 pub fn init_features(&self) -> InitFeatures {
8666 provided_init_features(&self.default_configuration)
8670 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8671 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
8673 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
8674 T::Target: BroadcasterInterface,
8675 ES::Target: EntropySource,
8676 NS::Target: NodeSigner,
8677 SP::Target: SignerProvider,
8678 F::Target: FeeEstimator,
8682 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
8683 // Note that we never need to persist the updated ChannelManager for an inbound
8684 // open_channel message - pre-funded channels are never written so there should be no
8685 // change to the contents.
8686 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8687 let res = self.internal_open_channel(counterparty_node_id, msg);
8688 let persist = match &res {
8689 Err(e) if e.closes_channel() => {
8690 debug_assert!(false, "We shouldn't close a new channel");
8691 NotifyOption::DoPersist
8693 _ => NotifyOption::SkipPersistHandleEvents,
8695 let _ = handle_error!(self, res, *counterparty_node_id);
8700 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
8701 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8702 "Dual-funded channels not supported".to_owned(),
8703 msg.temporary_channel_id.clone())), *counterparty_node_id);
8706 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
8707 // Note that we never need to persist the updated ChannelManager for an inbound
8708 // accept_channel message - pre-funded channels are never written so there should be no
8709 // change to the contents.
8710 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8711 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
8712 NotifyOption::SkipPersistHandleEvents
8716 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
8717 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8718 "Dual-funded channels not supported".to_owned(),
8719 msg.temporary_channel_id.clone())), *counterparty_node_id);
8722 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
8723 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8724 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
8727 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
8728 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8729 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
8732 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
8733 // Note that we never need to persist the updated ChannelManager for an inbound
8734 // channel_ready message - while the channel's state will change, any channel_ready message
8735 // will ultimately be re-sent on startup and the `ChannelMonitor` won't be updated so we
8736 // will not force-close the channel on startup.
8737 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8738 let res = self.internal_channel_ready(counterparty_node_id, msg);
8739 let persist = match &res {
8740 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8741 _ => NotifyOption::SkipPersistHandleEvents,
8743 let _ = handle_error!(self, res, *counterparty_node_id);
8748 fn handle_stfu(&self, counterparty_node_id: &PublicKey, msg: &msgs::Stfu) {
8749 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8750 "Quiescence not supported".to_owned(),
8751 msg.channel_id.clone())), *counterparty_node_id);
8754 fn handle_splice(&self, counterparty_node_id: &PublicKey, msg: &msgs::Splice) {
8755 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8756 "Splicing not supported".to_owned(),
8757 msg.channel_id.clone())), *counterparty_node_id);
8760 fn handle_splice_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceAck) {
8761 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8762 "Splicing not supported (splice_ack)".to_owned(),
8763 msg.channel_id.clone())), *counterparty_node_id);
8766 fn handle_splice_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
8767 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8768 "Splicing not supported (splice_locked)".to_owned(),
8769 msg.channel_id.clone())), *counterparty_node_id);
8772 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
8773 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8774 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
8777 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
8778 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8779 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
8782 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
8783 // Note that we never need to persist the updated ChannelManager for an inbound
8784 // update_add_htlc message - the message itself doesn't change our channel state only the
8785 // `commitment_signed` message afterwards will.
8786 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8787 let res = self.internal_update_add_htlc(counterparty_node_id, msg);
8788 let persist = match &res {
8789 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8790 Err(_) => NotifyOption::SkipPersistHandleEvents,
8791 Ok(()) => NotifyOption::SkipPersistNoEvents,
8793 let _ = handle_error!(self, res, *counterparty_node_id);
8798 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
8799 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8800 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
8803 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
8804 // Note that we never need to persist the updated ChannelManager for an inbound
8805 // update_fail_htlc message - the message itself doesn't change our channel state only the
8806 // `commitment_signed` message afterwards will.
8807 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8808 let res = self.internal_update_fail_htlc(counterparty_node_id, msg);
8809 let persist = match &res {
8810 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8811 Err(_) => NotifyOption::SkipPersistHandleEvents,
8812 Ok(()) => NotifyOption::SkipPersistNoEvents,
8814 let _ = handle_error!(self, res, *counterparty_node_id);
8819 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
8820 // Note that we never need to persist the updated ChannelManager for an inbound
8821 // update_fail_malformed_htlc message - the message itself doesn't change our channel state
8822 // only the `commitment_signed` message afterwards will.
8823 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8824 let res = self.internal_update_fail_malformed_htlc(counterparty_node_id, msg);
8825 let persist = match &res {
8826 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8827 Err(_) => NotifyOption::SkipPersistHandleEvents,
8828 Ok(()) => NotifyOption::SkipPersistNoEvents,
8830 let _ = handle_error!(self, res, *counterparty_node_id);
8835 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
8836 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8837 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
8840 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
8841 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8842 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
8845 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
8846 // Note that we never need to persist the updated ChannelManager for an inbound
8847 // update_fee message - the message itself doesn't change our channel state only the
8848 // `commitment_signed` message afterwards will.
8849 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8850 let res = self.internal_update_fee(counterparty_node_id, msg);
8851 let persist = match &res {
8852 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8853 Err(_) => NotifyOption::SkipPersistHandleEvents,
8854 Ok(()) => NotifyOption::SkipPersistNoEvents,
8856 let _ = handle_error!(self, res, *counterparty_node_id);
8861 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
8862 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8863 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
8866 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
8867 PersistenceNotifierGuard::optionally_notify(self, || {
8868 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
8871 NotifyOption::DoPersist
8876 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
8877 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8878 let res = self.internal_channel_reestablish(counterparty_node_id, msg);
8879 let persist = match &res {
8880 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8881 Err(_) => NotifyOption::SkipPersistHandleEvents,
8882 Ok(persist) => *persist,
8884 let _ = handle_error!(self, res, *counterparty_node_id);
8889 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
8890 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(
8891 self, || NotifyOption::SkipPersistHandleEvents);
8892 let mut failed_channels = Vec::new();
8893 let mut per_peer_state = self.per_peer_state.write().unwrap();
8896 WithContext::from(&self.logger, Some(*counterparty_node_id), None),
8897 "Marking channels with {} disconnected and generating channel_updates.",
8898 log_pubkey!(counterparty_node_id)
8900 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8901 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8902 let peer_state = &mut *peer_state_lock;
8903 let pending_msg_events = &mut peer_state.pending_msg_events;
8904 peer_state.channel_by_id.retain(|_, phase| {
8905 let context = match phase {
8906 ChannelPhase::Funded(chan) => {
8907 let logger = WithChannelContext::from(&self.logger, &chan.context);
8908 if chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok() {
8909 // We only retain funded channels that are not shutdown.
8914 // Unfunded channels will always be removed.
8915 ChannelPhase::UnfundedOutboundV1(chan) => {
8918 ChannelPhase::UnfundedInboundV1(chan) => {
8922 // Clean up for removal.
8923 update_maps_on_chan_removal!(self, &context);
8924 failed_channels.push(context.force_shutdown(false, ClosureReason::DisconnectedPeer));
8927 // Note that we don't bother generating any events for pre-accept channels -
8928 // they're not considered "channels" yet from the PoV of our events interface.
8929 peer_state.inbound_channel_request_by_id.clear();
8930 pending_msg_events.retain(|msg| {
8932 // V1 Channel Establishment
8933 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
8934 &events::MessageSendEvent::SendOpenChannel { .. } => false,
8935 &events::MessageSendEvent::SendFundingCreated { .. } => false,
8936 &events::MessageSendEvent::SendFundingSigned { .. } => false,
8937 // V2 Channel Establishment
8938 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
8939 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
8940 // Common Channel Establishment
8941 &events::MessageSendEvent::SendChannelReady { .. } => false,
8942 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
8944 &events::MessageSendEvent::SendStfu { .. } => false,
8946 &events::MessageSendEvent::SendSplice { .. } => false,
8947 &events::MessageSendEvent::SendSpliceAck { .. } => false,
8948 &events::MessageSendEvent::SendSpliceLocked { .. } => false,
8949 // Interactive Transaction Construction
8950 &events::MessageSendEvent::SendTxAddInput { .. } => false,
8951 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
8952 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
8953 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
8954 &events::MessageSendEvent::SendTxComplete { .. } => false,
8955 &events::MessageSendEvent::SendTxSignatures { .. } => false,
8956 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
8957 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
8958 &events::MessageSendEvent::SendTxAbort { .. } => false,
8959 // Channel Operations
8960 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
8961 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
8962 &events::MessageSendEvent::SendClosingSigned { .. } => false,
8963 &events::MessageSendEvent::SendShutdown { .. } => false,
8964 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
8965 &events::MessageSendEvent::HandleError { .. } => false,
8967 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
8968 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
8969 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
8970 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
8971 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
8972 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
8973 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
8974 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
8975 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
8978 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
8979 peer_state.is_connected = false;
8980 peer_state.ok_to_remove(true)
8981 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
8984 per_peer_state.remove(counterparty_node_id);
8986 mem::drop(per_peer_state);
8988 for failure in failed_channels.drain(..) {
8989 self.finish_close_channel(failure);
8993 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
8994 let logger = WithContext::from(&self.logger, Some(*counterparty_node_id), None);
8995 if !init_msg.features.supports_static_remote_key() {
8996 log_debug!(logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
9000 let mut res = Ok(());
9002 PersistenceNotifierGuard::optionally_notify(self, || {
9003 // If we have too many peers connected which don't have funded channels, disconnect the
9004 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
9005 // unfunded channels taking up space in memory for disconnected peers, we still let new
9006 // peers connect, but we'll reject new channels from them.
9007 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
9008 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
9011 let mut peer_state_lock = self.per_peer_state.write().unwrap();
9012 match peer_state_lock.entry(counterparty_node_id.clone()) {
9013 hash_map::Entry::Vacant(e) => {
9014 if inbound_peer_limited {
9016 return NotifyOption::SkipPersistNoEvents;
9018 e.insert(Mutex::new(PeerState {
9019 channel_by_id: HashMap::new(),
9020 inbound_channel_request_by_id: HashMap::new(),
9021 latest_features: init_msg.features.clone(),
9022 pending_msg_events: Vec::new(),
9023 in_flight_monitor_updates: BTreeMap::new(),
9024 monitor_update_blocked_actions: BTreeMap::new(),
9025 actions_blocking_raa_monitor_updates: BTreeMap::new(),
9029 hash_map::Entry::Occupied(e) => {
9030 let mut peer_state = e.get().lock().unwrap();
9031 peer_state.latest_features = init_msg.features.clone();
9033 let best_block_height = self.best_block.read().unwrap().height();
9034 if inbound_peer_limited &&
9035 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
9036 peer_state.channel_by_id.len()
9039 return NotifyOption::SkipPersistNoEvents;
9042 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
9043 peer_state.is_connected = true;
9048 log_debug!(logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
9050 let per_peer_state = self.per_peer_state.read().unwrap();
9051 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
9052 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9053 let peer_state = &mut *peer_state_lock;
9054 let pending_msg_events = &mut peer_state.pending_msg_events;
9056 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
9057 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
9059 let logger = WithChannelContext::from(&self.logger, &chan.context);
9060 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
9061 node_id: chan.context.get_counterparty_node_id(),
9062 msg: chan.get_channel_reestablish(&&logger),
9067 return NotifyOption::SkipPersistHandleEvents;
9068 //TODO: Also re-broadcast announcement_signatures
9073 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
9074 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
9076 match &msg.data as &str {
9077 "cannot co-op close channel w/ active htlcs"|
9078 "link failed to shutdown" =>
9080 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
9081 // send one while HTLCs are still present. The issue is tracked at
9082 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
9083 // to fix it but none so far have managed to land upstream. The issue appears to be
9084 // very low priority for the LND team despite being marked "P1".
9085 // We're not going to bother handling this in a sensible way, instead simply
9086 // repeating the Shutdown message on repeat until morale improves.
9087 if !msg.channel_id.is_zero() {
9088 let per_peer_state = self.per_peer_state.read().unwrap();
9089 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9090 if peer_state_mutex_opt.is_none() { return; }
9091 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
9092 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
9093 if let Some(msg) = chan.get_outbound_shutdown() {
9094 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
9095 node_id: *counterparty_node_id,
9099 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
9100 node_id: *counterparty_node_id,
9101 action: msgs::ErrorAction::SendWarningMessage {
9102 msg: msgs::WarningMessage {
9103 channel_id: msg.channel_id,
9104 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
9106 log_level: Level::Trace,
9116 if msg.channel_id.is_zero() {
9117 let channel_ids: Vec<ChannelId> = {
9118 let per_peer_state = self.per_peer_state.read().unwrap();
9119 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9120 if peer_state_mutex_opt.is_none() { return; }
9121 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
9122 let peer_state = &mut *peer_state_lock;
9123 // Note that we don't bother generating any events for pre-accept channels -
9124 // they're not considered "channels" yet from the PoV of our events interface.
9125 peer_state.inbound_channel_request_by_id.clear();
9126 peer_state.channel_by_id.keys().cloned().collect()
9128 for channel_id in channel_ids {
9129 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
9130 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
9134 // First check if we can advance the channel type and try again.
9135 let per_peer_state = self.per_peer_state.read().unwrap();
9136 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
9137 if peer_state_mutex_opt.is_none() { return; }
9138 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
9139 let peer_state = &mut *peer_state_lock;
9140 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
9141 if let Ok(msg) = chan.maybe_handle_error_without_close(self.chain_hash, &self.fee_estimator) {
9142 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
9143 node_id: *counterparty_node_id,
9151 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
9152 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
9156 fn provided_node_features(&self) -> NodeFeatures {
9157 provided_node_features(&self.default_configuration)
9160 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
9161 provided_init_features(&self.default_configuration)
9164 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
9165 Some(vec![self.chain_hash])
9168 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
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_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
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_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
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_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
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_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
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_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
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_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
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_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
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);
9216 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
9217 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
9218 "Dual-funded channels not supported".to_owned(),
9219 msg.channel_id.clone())), *counterparty_node_id);
9223 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9224 OffersMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
9226 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9227 T::Target: BroadcasterInterface,
9228 ES::Target: EntropySource,
9229 NS::Target: NodeSigner,
9230 SP::Target: SignerProvider,
9231 F::Target: FeeEstimator,
9235 fn handle_message(&self, message: OffersMessage) -> Option<OffersMessage> {
9236 let secp_ctx = &self.secp_ctx;
9237 let expanded_key = &self.inbound_payment_key;
9240 OffersMessage::InvoiceRequest(invoice_request) => {
9241 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
9244 Ok(amount_msats) => amount_msats,
9245 Err(error) => return Some(OffersMessage::InvoiceError(error.into())),
9247 let invoice_request = match invoice_request.verify(expanded_key, secp_ctx) {
9248 Ok(invoice_request) => invoice_request,
9250 let error = Bolt12SemanticError::InvalidMetadata;
9251 return Some(OffersMessage::InvoiceError(error.into()));
9255 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
9256 let (payment_hash, payment_secret) = match self.create_inbound_payment(
9257 Some(amount_msats), relative_expiry, None
9259 Ok((payment_hash, payment_secret)) => (payment_hash, payment_secret),
9261 let error = Bolt12SemanticError::InvalidAmount;
9262 return Some(OffersMessage::InvoiceError(error.into()));
9266 let payment_paths = match self.create_blinded_payment_paths(
9267 amount_msats, payment_secret
9269 Ok(payment_paths) => payment_paths,
9271 let error = Bolt12SemanticError::MissingPaths;
9272 return Some(OffersMessage::InvoiceError(error.into()));
9276 #[cfg(not(feature = "std"))]
9277 let created_at = Duration::from_secs(
9278 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9281 if invoice_request.keys.is_some() {
9282 #[cfg(feature = "std")]
9283 let builder = invoice_request.respond_using_derived_keys(
9284 payment_paths, payment_hash
9286 #[cfg(not(feature = "std"))]
9287 let builder = invoice_request.respond_using_derived_keys_no_std(
9288 payment_paths, payment_hash, created_at
9290 match builder.and_then(|b| b.allow_mpp().build_and_sign(secp_ctx)) {
9291 Ok(invoice) => Some(OffersMessage::Invoice(invoice)),
9292 Err(error) => Some(OffersMessage::InvoiceError(error.into())),
9295 #[cfg(feature = "std")]
9296 let builder = invoice_request.respond_with(payment_paths, payment_hash);
9297 #[cfg(not(feature = "std"))]
9298 let builder = invoice_request.respond_with_no_std(
9299 payment_paths, payment_hash, created_at
9301 let response = builder.and_then(|builder| builder.allow_mpp().build())
9302 .map_err(|e| OffersMessage::InvoiceError(e.into()))
9304 match invoice.sign(|invoice| self.node_signer.sign_bolt12_invoice(invoice)) {
9305 Ok(invoice) => Ok(OffersMessage::Invoice(invoice)),
9306 Err(SignError::Signing(())) => Err(OffersMessage::InvoiceError(
9307 InvoiceError::from_string("Failed signing invoice".to_string())
9309 Err(SignError::Verification(_)) => Err(OffersMessage::InvoiceError(
9310 InvoiceError::from_string("Failed invoice signature verification".to_string())
9314 Ok(invoice) => Some(invoice),
9315 Err(error) => Some(error),
9319 OffersMessage::Invoice(invoice) => {
9320 match invoice.verify(expanded_key, secp_ctx) {
9322 Some(OffersMessage::InvoiceError(InvoiceError::from_string("Unrecognized invoice".to_owned())))
9324 Ok(_) if invoice.invoice_features().requires_unknown_bits_from(&self.bolt12_invoice_features()) => {
9325 Some(OffersMessage::InvoiceError(Bolt12SemanticError::UnknownRequiredFeatures.into()))
9328 if let Err(e) = self.send_payment_for_bolt12_invoice(&invoice, payment_id) {
9329 log_trace!(self.logger, "Failed paying invoice: {:?}", e);
9330 Some(OffersMessage::InvoiceError(InvoiceError::from_string(format!("{:?}", e))))
9337 OffersMessage::InvoiceError(invoice_error) => {
9338 log_trace!(self.logger, "Received invoice_error: {}", invoice_error);
9344 fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> {
9345 core::mem::take(&mut self.pending_offers_messages.lock().unwrap())
9349 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
9350 /// [`ChannelManager`].
9351 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
9352 let mut node_features = provided_init_features(config).to_context();
9353 node_features.set_keysend_optional();
9357 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
9358 /// [`ChannelManager`].
9360 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
9361 /// or not. Thus, this method is not public.
9362 #[cfg(any(feature = "_test_utils", test))]
9363 pub(crate) fn provided_bolt11_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
9364 provided_init_features(config).to_context()
9367 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
9368 /// [`ChannelManager`].
9369 pub(crate) fn provided_bolt12_invoice_features(config: &UserConfig) -> Bolt12InvoiceFeatures {
9370 provided_init_features(config).to_context()
9373 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
9374 /// [`ChannelManager`].
9375 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
9376 provided_init_features(config).to_context()
9379 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
9380 /// [`ChannelManager`].
9381 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
9382 ChannelTypeFeatures::from_init(&provided_init_features(config))
9385 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
9386 /// [`ChannelManager`].
9387 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
9388 // Note that if new features are added here which other peers may (eventually) require, we
9389 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
9390 // [`ErroringMessageHandler`].
9391 let mut features = InitFeatures::empty();
9392 features.set_data_loss_protect_required();
9393 features.set_upfront_shutdown_script_optional();
9394 features.set_variable_length_onion_required();
9395 features.set_static_remote_key_required();
9396 features.set_payment_secret_required();
9397 features.set_basic_mpp_optional();
9398 features.set_wumbo_optional();
9399 features.set_shutdown_any_segwit_optional();
9400 features.set_channel_type_optional();
9401 features.set_scid_privacy_optional();
9402 features.set_zero_conf_optional();
9403 features.set_route_blinding_optional();
9404 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
9405 features.set_anchors_zero_fee_htlc_tx_optional();
9410 const SERIALIZATION_VERSION: u8 = 1;
9411 const MIN_SERIALIZATION_VERSION: u8 = 1;
9413 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
9414 (2, fee_base_msat, required),
9415 (4, fee_proportional_millionths, required),
9416 (6, cltv_expiry_delta, required),
9419 impl_writeable_tlv_based!(ChannelCounterparty, {
9420 (2, node_id, required),
9421 (4, features, required),
9422 (6, unspendable_punishment_reserve, required),
9423 (8, forwarding_info, option),
9424 (9, outbound_htlc_minimum_msat, option),
9425 (11, outbound_htlc_maximum_msat, option),
9428 impl Writeable for ChannelDetails {
9429 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9430 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9431 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9432 let user_channel_id_low = self.user_channel_id as u64;
9433 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
9434 write_tlv_fields!(writer, {
9435 (1, self.inbound_scid_alias, option),
9436 (2, self.channel_id, required),
9437 (3, self.channel_type, option),
9438 (4, self.counterparty, required),
9439 (5, self.outbound_scid_alias, option),
9440 (6, self.funding_txo, option),
9441 (7, self.config, option),
9442 (8, self.short_channel_id, option),
9443 (9, self.confirmations, option),
9444 (10, self.channel_value_satoshis, required),
9445 (12, self.unspendable_punishment_reserve, option),
9446 (14, user_channel_id_low, required),
9447 (16, self.balance_msat, required),
9448 (18, self.outbound_capacity_msat, required),
9449 (19, self.next_outbound_htlc_limit_msat, required),
9450 (20, self.inbound_capacity_msat, required),
9451 (21, self.next_outbound_htlc_minimum_msat, required),
9452 (22, self.confirmations_required, option),
9453 (24, self.force_close_spend_delay, option),
9454 (26, self.is_outbound, required),
9455 (28, self.is_channel_ready, required),
9456 (30, self.is_usable, required),
9457 (32, self.is_public, required),
9458 (33, self.inbound_htlc_minimum_msat, option),
9459 (35, self.inbound_htlc_maximum_msat, option),
9460 (37, user_channel_id_high_opt, option),
9461 (39, self.feerate_sat_per_1000_weight, option),
9462 (41, self.channel_shutdown_state, option),
9468 impl Readable for ChannelDetails {
9469 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9470 _init_and_read_len_prefixed_tlv_fields!(reader, {
9471 (1, inbound_scid_alias, option),
9472 (2, channel_id, required),
9473 (3, channel_type, option),
9474 (4, counterparty, required),
9475 (5, outbound_scid_alias, option),
9476 (6, funding_txo, option),
9477 (7, config, option),
9478 (8, short_channel_id, option),
9479 (9, confirmations, option),
9480 (10, channel_value_satoshis, required),
9481 (12, unspendable_punishment_reserve, option),
9482 (14, user_channel_id_low, required),
9483 (16, balance_msat, required),
9484 (18, outbound_capacity_msat, required),
9485 // Note that by the time we get past the required read above, outbound_capacity_msat will be
9486 // filled in, so we can safely unwrap it here.
9487 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
9488 (20, inbound_capacity_msat, required),
9489 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
9490 (22, confirmations_required, option),
9491 (24, force_close_spend_delay, option),
9492 (26, is_outbound, required),
9493 (28, is_channel_ready, required),
9494 (30, is_usable, required),
9495 (32, is_public, required),
9496 (33, inbound_htlc_minimum_msat, option),
9497 (35, inbound_htlc_maximum_msat, option),
9498 (37, user_channel_id_high_opt, option),
9499 (39, feerate_sat_per_1000_weight, option),
9500 (41, channel_shutdown_state, option),
9503 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9504 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9505 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
9506 let user_channel_id = user_channel_id_low as u128 +
9507 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
9511 channel_id: channel_id.0.unwrap(),
9513 counterparty: counterparty.0.unwrap(),
9514 outbound_scid_alias,
9518 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
9519 unspendable_punishment_reserve,
9521 balance_msat: balance_msat.0.unwrap(),
9522 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
9523 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
9524 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
9525 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
9526 confirmations_required,
9528 force_close_spend_delay,
9529 is_outbound: is_outbound.0.unwrap(),
9530 is_channel_ready: is_channel_ready.0.unwrap(),
9531 is_usable: is_usable.0.unwrap(),
9532 is_public: is_public.0.unwrap(),
9533 inbound_htlc_minimum_msat,
9534 inbound_htlc_maximum_msat,
9535 feerate_sat_per_1000_weight,
9536 channel_shutdown_state,
9541 impl_writeable_tlv_based!(PhantomRouteHints, {
9542 (2, channels, required_vec),
9543 (4, phantom_scid, required),
9544 (6, real_node_pubkey, required),
9547 impl_writeable_tlv_based!(BlindedForward, {
9548 (0, inbound_blinding_point, required),
9549 (1, failure, (default_value, BlindedFailure::FromIntroductionNode)),
9552 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
9554 (0, onion_packet, required),
9555 (1, blinded, option),
9556 (2, short_channel_id, required),
9559 (0, payment_data, required),
9560 (1, phantom_shared_secret, option),
9561 (2, incoming_cltv_expiry, required),
9562 (3, payment_metadata, option),
9563 (5, custom_tlvs, optional_vec),
9564 (7, requires_blinded_error, (default_value, false)),
9566 (2, ReceiveKeysend) => {
9567 (0, payment_preimage, required),
9568 (2, incoming_cltv_expiry, required),
9569 (3, payment_metadata, option),
9570 (4, payment_data, option), // Added in 0.0.116
9571 (5, custom_tlvs, optional_vec),
9575 impl_writeable_tlv_based!(PendingHTLCInfo, {
9576 (0, routing, required),
9577 (2, incoming_shared_secret, required),
9578 (4, payment_hash, required),
9579 (6, outgoing_amt_msat, required),
9580 (8, outgoing_cltv_value, required),
9581 (9, incoming_amt_msat, option),
9582 (10, skimmed_fee_msat, option),
9586 impl Writeable for HTLCFailureMsg {
9587 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9589 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
9591 channel_id.write(writer)?;
9592 htlc_id.write(writer)?;
9593 reason.write(writer)?;
9595 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9596 channel_id, htlc_id, sha256_of_onion, failure_code
9599 channel_id.write(writer)?;
9600 htlc_id.write(writer)?;
9601 sha256_of_onion.write(writer)?;
9602 failure_code.write(writer)?;
9609 impl Readable for HTLCFailureMsg {
9610 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9611 let id: u8 = Readable::read(reader)?;
9614 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
9615 channel_id: Readable::read(reader)?,
9616 htlc_id: Readable::read(reader)?,
9617 reason: Readable::read(reader)?,
9621 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9622 channel_id: Readable::read(reader)?,
9623 htlc_id: Readable::read(reader)?,
9624 sha256_of_onion: Readable::read(reader)?,
9625 failure_code: Readable::read(reader)?,
9628 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
9629 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
9630 // messages contained in the variants.
9631 // In version 0.0.101, support for reading the variants with these types was added, and
9632 // we should migrate to writing these variants when UpdateFailHTLC or
9633 // UpdateFailMalformedHTLC get TLV fields.
9635 let length: BigSize = Readable::read(reader)?;
9636 let mut s = FixedLengthReader::new(reader, length.0);
9637 let res = Readable::read(&mut s)?;
9638 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9639 Ok(HTLCFailureMsg::Relay(res))
9642 let length: BigSize = Readable::read(reader)?;
9643 let mut s = FixedLengthReader::new(reader, length.0);
9644 let res = Readable::read(&mut s)?;
9645 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9646 Ok(HTLCFailureMsg::Malformed(res))
9648 _ => Err(DecodeError::UnknownRequiredFeature),
9653 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
9658 impl_writeable_tlv_based_enum!(BlindedFailure,
9659 (0, FromIntroductionNode) => {},
9660 (2, FromBlindedNode) => {}, ;
9663 impl_writeable_tlv_based!(HTLCPreviousHopData, {
9664 (0, short_channel_id, required),
9665 (1, phantom_shared_secret, option),
9666 (2, outpoint, required),
9667 (3, blinded_failure, option),
9668 (4, htlc_id, required),
9669 (6, incoming_packet_shared_secret, required),
9670 (7, user_channel_id, option),
9671 // Note that by the time we get past the required read for type 2 above, outpoint will be
9672 // filled in, so we can safely unwrap it here.
9673 (9, channel_id, (default_value, ChannelId::v1_from_funding_outpoint(outpoint.0.unwrap()))),
9676 impl Writeable for ClaimableHTLC {
9677 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9678 let (payment_data, keysend_preimage) = match &self.onion_payload {
9679 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
9680 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
9682 write_tlv_fields!(writer, {
9683 (0, self.prev_hop, required),
9684 (1, self.total_msat, required),
9685 (2, self.value, required),
9686 (3, self.sender_intended_value, required),
9687 (4, payment_data, option),
9688 (5, self.total_value_received, option),
9689 (6, self.cltv_expiry, required),
9690 (8, keysend_preimage, option),
9691 (10, self.counterparty_skimmed_fee_msat, option),
9697 impl Readable for ClaimableHTLC {
9698 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9699 _init_and_read_len_prefixed_tlv_fields!(reader, {
9700 (0, prev_hop, required),
9701 (1, total_msat, option),
9702 (2, value_ser, required),
9703 (3, sender_intended_value, option),
9704 (4, payment_data_opt, option),
9705 (5, total_value_received, option),
9706 (6, cltv_expiry, required),
9707 (8, keysend_preimage, option),
9708 (10, counterparty_skimmed_fee_msat, option),
9710 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
9711 let value = value_ser.0.unwrap();
9712 let onion_payload = match keysend_preimage {
9714 if payment_data.is_some() {
9715 return Err(DecodeError::InvalidValue)
9717 if total_msat.is_none() {
9718 total_msat = Some(value);
9720 OnionPayload::Spontaneous(p)
9723 if total_msat.is_none() {
9724 if payment_data.is_none() {
9725 return Err(DecodeError::InvalidValue)
9727 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
9729 OnionPayload::Invoice { _legacy_hop_data: payment_data }
9733 prev_hop: prev_hop.0.unwrap(),
9736 sender_intended_value: sender_intended_value.unwrap_or(value),
9737 total_value_received,
9738 total_msat: total_msat.unwrap(),
9740 cltv_expiry: cltv_expiry.0.unwrap(),
9741 counterparty_skimmed_fee_msat,
9746 impl Readable for HTLCSource {
9747 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9748 let id: u8 = Readable::read(reader)?;
9751 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
9752 let mut first_hop_htlc_msat: u64 = 0;
9753 let mut path_hops = Vec::new();
9754 let mut payment_id = None;
9755 let mut payment_params: Option<PaymentParameters> = None;
9756 let mut blinded_tail: Option<BlindedTail> = None;
9757 read_tlv_fields!(reader, {
9758 (0, session_priv, required),
9759 (1, payment_id, option),
9760 (2, first_hop_htlc_msat, required),
9761 (4, path_hops, required_vec),
9762 (5, payment_params, (option: ReadableArgs, 0)),
9763 (6, blinded_tail, option),
9765 if payment_id.is_none() {
9766 // For backwards compat, if there was no payment_id written, use the session_priv bytes
9768 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
9770 let path = Path { hops: path_hops, blinded_tail };
9771 if path.hops.len() == 0 {
9772 return Err(DecodeError::InvalidValue);
9774 if let Some(params) = payment_params.as_mut() {
9775 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
9776 if final_cltv_expiry_delta == &0 {
9777 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
9781 Ok(HTLCSource::OutboundRoute {
9782 session_priv: session_priv.0.unwrap(),
9783 first_hop_htlc_msat,
9785 payment_id: payment_id.unwrap(),
9788 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
9789 _ => Err(DecodeError::UnknownRequiredFeature),
9794 impl Writeable for HTLCSource {
9795 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
9797 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
9799 let payment_id_opt = Some(payment_id);
9800 write_tlv_fields!(writer, {
9801 (0, session_priv, required),
9802 (1, payment_id_opt, option),
9803 (2, first_hop_htlc_msat, required),
9804 // 3 was previously used to write a PaymentSecret for the payment.
9805 (4, path.hops, required_vec),
9806 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
9807 (6, path.blinded_tail, option),
9810 HTLCSource::PreviousHopData(ref field) => {
9812 field.write(writer)?;
9819 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
9820 (0, forward_info, required),
9821 (1, prev_user_channel_id, (default_value, 0)),
9822 (2, prev_short_channel_id, required),
9823 (4, prev_htlc_id, required),
9824 (6, prev_funding_outpoint, required),
9825 // Note that by the time we get past the required read for type 6 above, prev_funding_outpoint will be
9826 // filled in, so we can safely unwrap it here.
9827 (7, prev_channel_id, (default_value, ChannelId::v1_from_funding_outpoint(prev_funding_outpoint.0.unwrap()))),
9830 impl Writeable for HTLCForwardInfo {
9831 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9832 const FAIL_HTLC_VARIANT_ID: u8 = 1;
9834 Self::AddHTLC(info) => {
9838 Self::FailHTLC { htlc_id, err_packet } => {
9839 FAIL_HTLC_VARIANT_ID.write(w)?;
9840 write_tlv_fields!(w, {
9841 (0, htlc_id, required),
9842 (2, err_packet, required),
9845 Self::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
9846 // Since this variant was added in 0.0.119, write this as `::FailHTLC` with an empty error
9847 // packet so older versions have something to fail back with, but serialize the real data as
9848 // optional TLVs for the benefit of newer versions.
9849 FAIL_HTLC_VARIANT_ID.write(w)?;
9850 let dummy_err_packet = msgs::OnionErrorPacket { data: Vec::new() };
9851 write_tlv_fields!(w, {
9852 (0, htlc_id, required),
9853 (1, failure_code, required),
9854 (2, dummy_err_packet, required),
9855 (3, sha256_of_onion, required),
9863 impl Readable for HTLCForwardInfo {
9864 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
9865 let id: u8 = Readable::read(r)?;
9867 0 => Self::AddHTLC(Readable::read(r)?),
9869 _init_and_read_len_prefixed_tlv_fields!(r, {
9870 (0, htlc_id, required),
9871 (1, malformed_htlc_failure_code, option),
9872 (2, err_packet, required),
9873 (3, sha256_of_onion, option),
9875 if let Some(failure_code) = malformed_htlc_failure_code {
9876 Self::FailMalformedHTLC {
9877 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9879 sha256_of_onion: sha256_of_onion.ok_or(DecodeError::InvalidValue)?,
9883 htlc_id: _init_tlv_based_struct_field!(htlc_id, required),
9884 err_packet: _init_tlv_based_struct_field!(err_packet, required),
9888 _ => return Err(DecodeError::InvalidValue),
9893 impl_writeable_tlv_based!(PendingInboundPayment, {
9894 (0, payment_secret, required),
9895 (2, expiry_time, required),
9896 (4, user_payment_id, required),
9897 (6, payment_preimage, required),
9898 (8, min_value_msat, required),
9901 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>
9903 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
9904 T::Target: BroadcasterInterface,
9905 ES::Target: EntropySource,
9906 NS::Target: NodeSigner,
9907 SP::Target: SignerProvider,
9908 F::Target: FeeEstimator,
9912 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9913 let _consistency_lock = self.total_consistency_lock.write().unwrap();
9915 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
9917 self.chain_hash.write(writer)?;
9919 let best_block = self.best_block.read().unwrap();
9920 best_block.height().write(writer)?;
9921 best_block.block_hash().write(writer)?;
9924 let mut serializable_peer_count: u64 = 0;
9926 let per_peer_state = self.per_peer_state.read().unwrap();
9927 let mut number_of_funded_channels = 0;
9928 for (_, peer_state_mutex) in per_peer_state.iter() {
9929 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9930 let peer_state = &mut *peer_state_lock;
9931 if !peer_state.ok_to_remove(false) {
9932 serializable_peer_count += 1;
9935 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
9936 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_broadcast() } else { false }
9940 (number_of_funded_channels as u64).write(writer)?;
9942 for (_, peer_state_mutex) in per_peer_state.iter() {
9943 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9944 let peer_state = &mut *peer_state_lock;
9945 for channel in peer_state.channel_by_id.iter().filter_map(
9946 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
9947 if channel.context.is_funding_broadcast() { Some(channel) } else { None }
9950 channel.write(writer)?;
9956 let forward_htlcs = self.forward_htlcs.lock().unwrap();
9957 (forward_htlcs.len() as u64).write(writer)?;
9958 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
9959 short_channel_id.write(writer)?;
9960 (pending_forwards.len() as u64).write(writer)?;
9961 for forward in pending_forwards {
9962 forward.write(writer)?;
9967 let per_peer_state = self.per_peer_state.write().unwrap();
9969 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
9970 let claimable_payments = self.claimable_payments.lock().unwrap();
9971 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
9973 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
9974 let mut htlc_onion_fields: Vec<&_> = Vec::new();
9975 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
9976 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
9977 payment_hash.write(writer)?;
9978 (payment.htlcs.len() as u64).write(writer)?;
9979 for htlc in payment.htlcs.iter() {
9980 htlc.write(writer)?;
9982 htlc_purposes.push(&payment.purpose);
9983 htlc_onion_fields.push(&payment.onion_fields);
9986 let mut monitor_update_blocked_actions_per_peer = None;
9987 let mut peer_states = Vec::new();
9988 for (_, peer_state_mutex) in per_peer_state.iter() {
9989 // Because we're holding the owning `per_peer_state` write lock here there's no chance
9990 // of a lockorder violation deadlock - no other thread can be holding any
9991 // per_peer_state lock at all.
9992 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
9995 (serializable_peer_count).write(writer)?;
9996 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9997 // Peers which we have no channels to should be dropped once disconnected. As we
9998 // disconnect all peers when shutting down and serializing the ChannelManager, we
9999 // consider all peers as disconnected here. There's therefore no need write peers with
10001 if !peer_state.ok_to_remove(false) {
10002 peer_pubkey.write(writer)?;
10003 peer_state.latest_features.write(writer)?;
10004 if !peer_state.monitor_update_blocked_actions.is_empty() {
10005 monitor_update_blocked_actions_per_peer
10006 .get_or_insert_with(Vec::new)
10007 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
10012 let events = self.pending_events.lock().unwrap();
10013 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
10014 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
10015 // refuse to read the new ChannelManager.
10016 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
10017 if events_not_backwards_compatible {
10018 // If we're gonna write a even TLV that will overwrite our events anyway we might as
10019 // well save the space and not write any events here.
10020 0u64.write(writer)?;
10022 (events.len() as u64).write(writer)?;
10023 for (event, _) in events.iter() {
10024 event.write(writer)?;
10028 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
10029 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
10030 // the closing monitor updates were always effectively replayed on startup (either directly
10031 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
10032 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
10033 0u64.write(writer)?;
10035 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
10036 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
10037 // likely to be identical.
10038 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
10039 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
10041 (pending_inbound_payments.len() as u64).write(writer)?;
10042 for (hash, pending_payment) in pending_inbound_payments.iter() {
10043 hash.write(writer)?;
10044 pending_payment.write(writer)?;
10047 // For backwards compat, write the session privs and their total length.
10048 let mut num_pending_outbounds_compat: u64 = 0;
10049 for (_, outbound) in pending_outbound_payments.iter() {
10050 if !outbound.is_fulfilled() && !outbound.abandoned() {
10051 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
10054 num_pending_outbounds_compat.write(writer)?;
10055 for (_, outbound) in pending_outbound_payments.iter() {
10057 PendingOutboundPayment::Legacy { session_privs } |
10058 PendingOutboundPayment::Retryable { session_privs, .. } => {
10059 for session_priv in session_privs.iter() {
10060 session_priv.write(writer)?;
10063 PendingOutboundPayment::AwaitingInvoice { .. } => {},
10064 PendingOutboundPayment::InvoiceReceived { .. } => {},
10065 PendingOutboundPayment::Fulfilled { .. } => {},
10066 PendingOutboundPayment::Abandoned { .. } => {},
10070 // Encode without retry info for 0.0.101 compatibility.
10071 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
10072 for (id, outbound) in pending_outbound_payments.iter() {
10074 PendingOutboundPayment::Legacy { session_privs } |
10075 PendingOutboundPayment::Retryable { session_privs, .. } => {
10076 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
10082 let mut pending_intercepted_htlcs = None;
10083 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
10084 if our_pending_intercepts.len() != 0 {
10085 pending_intercepted_htlcs = Some(our_pending_intercepts);
10088 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
10089 if pending_claiming_payments.as_ref().unwrap().is_empty() {
10090 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
10091 // map. Thus, if there are no entries we skip writing a TLV for it.
10092 pending_claiming_payments = None;
10095 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
10096 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
10097 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
10098 if !updates.is_empty() {
10099 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
10100 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
10105 write_tlv_fields!(writer, {
10106 (1, pending_outbound_payments_no_retry, required),
10107 (2, pending_intercepted_htlcs, option),
10108 (3, pending_outbound_payments, required),
10109 (4, pending_claiming_payments, option),
10110 (5, self.our_network_pubkey, required),
10111 (6, monitor_update_blocked_actions_per_peer, option),
10112 (7, self.fake_scid_rand_bytes, required),
10113 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
10114 (9, htlc_purposes, required_vec),
10115 (10, in_flight_monitor_updates, option),
10116 (11, self.probing_cookie_secret, required),
10117 (13, htlc_onion_fields, optional_vec),
10124 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
10125 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
10126 (self.len() as u64).write(w)?;
10127 for (event, action) in self.iter() {
10130 #[cfg(debug_assertions)] {
10131 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
10132 // be persisted and are regenerated on restart. However, if such an event has a
10133 // post-event-handling action we'll write nothing for the event and would have to
10134 // either forget the action or fail on deserialization (which we do below). Thus,
10135 // check that the event is sane here.
10136 let event_encoded = event.encode();
10137 let event_read: Option<Event> =
10138 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
10139 if action.is_some() { assert!(event_read.is_some()); }
10145 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
10146 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
10147 let len: u64 = Readable::read(reader)?;
10148 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
10149 let mut events: Self = VecDeque::with_capacity(cmp::min(
10150 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
10153 let ev_opt = MaybeReadable::read(reader)?;
10154 let action = Readable::read(reader)?;
10155 if let Some(ev) = ev_opt {
10156 events.push_back((ev, action));
10157 } else if action.is_some() {
10158 return Err(DecodeError::InvalidValue);
10165 impl_writeable_tlv_based_enum!(ChannelShutdownState,
10166 (0, NotShuttingDown) => {},
10167 (2, ShutdownInitiated) => {},
10168 (4, ResolvingHTLCs) => {},
10169 (6, NegotiatingClosingFee) => {},
10170 (8, ShutdownComplete) => {}, ;
10173 /// Arguments for the creation of a ChannelManager that are not deserialized.
10175 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
10177 /// 1) Deserialize all stored [`ChannelMonitor`]s.
10178 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
10179 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
10180 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
10181 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
10182 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
10183 /// same way you would handle a [`chain::Filter`] call using
10184 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
10185 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
10186 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
10187 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
10188 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
10189 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
10191 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
10192 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
10194 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
10195 /// call any other methods on the newly-deserialized [`ChannelManager`].
10197 /// Note that because some channels may be closed during deserialization, it is critical that you
10198 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
10199 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
10200 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
10201 /// not force-close the same channels but consider them live), you may end up revoking a state for
10202 /// which you've already broadcasted the transaction.
10204 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
10205 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10207 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10208 T::Target: BroadcasterInterface,
10209 ES::Target: EntropySource,
10210 NS::Target: NodeSigner,
10211 SP::Target: SignerProvider,
10212 F::Target: FeeEstimator,
10216 /// A cryptographically secure source of entropy.
10217 pub entropy_source: ES,
10219 /// A signer that is able to perform node-scoped cryptographic operations.
10220 pub node_signer: NS,
10222 /// The keys provider which will give us relevant keys. Some keys will be loaded during
10223 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
10225 pub signer_provider: SP,
10227 /// The fee_estimator for use in the ChannelManager in the future.
10229 /// No calls to the FeeEstimator will be made during deserialization.
10230 pub fee_estimator: F,
10231 /// The chain::Watch for use in the ChannelManager in the future.
10233 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
10234 /// you have deserialized ChannelMonitors separately and will add them to your
10235 /// chain::Watch after deserializing this ChannelManager.
10236 pub chain_monitor: M,
10238 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
10239 /// used to broadcast the latest local commitment transactions of channels which must be
10240 /// force-closed during deserialization.
10241 pub tx_broadcaster: T,
10242 /// The router which will be used in the ChannelManager in the future for finding routes
10243 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
10245 /// No calls to the router will be made during deserialization.
10247 /// The Logger for use in the ChannelManager and which may be used to log information during
10248 /// deserialization.
10250 /// Default settings used for new channels. Any existing channels will continue to use the
10251 /// runtime settings which were stored when the ChannelManager was serialized.
10252 pub default_config: UserConfig,
10254 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
10255 /// value.context.get_funding_txo() should be the key).
10257 /// If a monitor is inconsistent with the channel state during deserialization the channel will
10258 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
10259 /// is true for missing channels as well. If there is a monitor missing for which we find
10260 /// channel data Err(DecodeError::InvalidValue) will be returned.
10262 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
10265 /// This is not exported to bindings users because we have no HashMap bindings
10266 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>,
10269 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10270 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
10272 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10273 T::Target: BroadcasterInterface,
10274 ES::Target: EntropySource,
10275 NS::Target: NodeSigner,
10276 SP::Target: SignerProvider,
10277 F::Target: FeeEstimator,
10281 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
10282 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
10283 /// populate a HashMap directly from C.
10284 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,
10285 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>>) -> Self {
10287 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
10288 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
10293 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
10294 // SipmleArcChannelManager type:
10295 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10296 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
10298 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10299 T::Target: BroadcasterInterface,
10300 ES::Target: EntropySource,
10301 NS::Target: NodeSigner,
10302 SP::Target: SignerProvider,
10303 F::Target: FeeEstimator,
10307 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10308 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
10309 Ok((blockhash, Arc::new(chan_manager)))
10313 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
10314 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
10316 M::Target: chain::Watch<<SP::Target as SignerProvider>::EcdsaSigner>,
10317 T::Target: BroadcasterInterface,
10318 ES::Target: EntropySource,
10319 NS::Target: NodeSigner,
10320 SP::Target: SignerProvider,
10321 F::Target: FeeEstimator,
10325 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10326 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
10328 let chain_hash: ChainHash = Readable::read(reader)?;
10329 let best_block_height: u32 = Readable::read(reader)?;
10330 let best_block_hash: BlockHash = Readable::read(reader)?;
10332 let mut failed_htlcs = Vec::new();
10334 let channel_count: u64 = Readable::read(reader)?;
10335 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
10336 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10337 let mut outpoint_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10338 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10339 let mut channel_closures = VecDeque::new();
10340 let mut close_background_events = Vec::new();
10341 let mut funding_txo_to_channel_id = HashMap::with_capacity(channel_count as usize);
10342 for _ in 0..channel_count {
10343 let mut channel: Channel<SP> = Channel::read(reader, (
10344 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
10346 let logger = WithChannelContext::from(&args.logger, &channel.context);
10347 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10348 funding_txo_to_channel_id.insert(funding_txo, channel.context.channel_id());
10349 funding_txo_set.insert(funding_txo.clone());
10350 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
10351 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
10352 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
10353 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
10354 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10355 // But if the channel is behind of the monitor, close the channel:
10356 log_error!(logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
10357 log_error!(logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
10358 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10359 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
10360 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
10362 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
10363 log_error!(logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
10364 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
10366 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
10367 log_error!(logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
10368 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
10370 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
10371 log_error!(logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
10372 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
10374 let mut shutdown_result = channel.context.force_shutdown(true, ClosureReason::OutdatedChannelManager);
10375 if shutdown_result.unbroadcasted_batch_funding_txid.is_some() {
10376 return Err(DecodeError::InvalidValue);
10378 if let Some((counterparty_node_id, funding_txo, channel_id, update)) = shutdown_result.monitor_update {
10379 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10380 counterparty_node_id, funding_txo, channel_id, update
10383 failed_htlcs.append(&mut shutdown_result.dropped_outbound_htlcs);
10384 channel_closures.push_back((events::Event::ChannelClosed {
10385 channel_id: channel.context.channel_id(),
10386 user_channel_id: channel.context.get_user_id(),
10387 reason: ClosureReason::OutdatedChannelManager,
10388 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10389 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10390 channel_funding_txo: channel.context.get_funding_txo(),
10392 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
10393 let mut found_htlc = false;
10394 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
10395 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
10398 // If we have some HTLCs in the channel which are not present in the newer
10399 // ChannelMonitor, they have been removed and should be failed back to
10400 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
10401 // were actually claimed we'd have generated and ensured the previous-hop
10402 // claim update ChannelMonitor updates were persisted prior to persising
10403 // the ChannelMonitor update for the forward leg, so attempting to fail the
10404 // backwards leg of the HTLC will simply be rejected.
10406 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
10407 &channel.context.channel_id(), &payment_hash);
10408 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10412 log_info!(logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
10413 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
10414 monitor.get_latest_update_id());
10415 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
10416 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10418 if let Some(funding_txo) = channel.context.get_funding_txo() {
10419 outpoint_to_peer.insert(funding_txo, channel.context.get_counterparty_node_id());
10421 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
10422 hash_map::Entry::Occupied(mut entry) => {
10423 let by_id_map = entry.get_mut();
10424 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10426 hash_map::Entry::Vacant(entry) => {
10427 let mut by_id_map = HashMap::new();
10428 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10429 entry.insert(by_id_map);
10433 } else if channel.is_awaiting_initial_mon_persist() {
10434 // If we were persisted and shut down while the initial ChannelMonitor persistence
10435 // was in-progress, we never broadcasted the funding transaction and can still
10436 // safely discard the channel.
10437 let _ = channel.context.force_shutdown(false, ClosureReason::DisconnectedPeer);
10438 channel_closures.push_back((events::Event::ChannelClosed {
10439 channel_id: channel.context.channel_id(),
10440 user_channel_id: channel.context.get_user_id(),
10441 reason: ClosureReason::DisconnectedPeer,
10442 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10443 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10444 channel_funding_txo: channel.context.get_funding_txo(),
10447 log_error!(logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
10448 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10449 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10450 log_error!(logger, " Without the ChannelMonitor we cannot continue without risking funds.");
10451 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10452 return Err(DecodeError::InvalidValue);
10456 for (funding_txo, monitor) in args.channel_monitors.iter() {
10457 if !funding_txo_set.contains(funding_txo) {
10458 let logger = WithChannelMonitor::from(&args.logger, monitor);
10459 let channel_id = monitor.channel_id();
10460 log_info!(logger, "Queueing monitor update to ensure missing channel {} is force closed",
10462 let monitor_update = ChannelMonitorUpdate {
10463 update_id: CLOSED_CHANNEL_UPDATE_ID,
10464 counterparty_node_id: None,
10465 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
10466 channel_id: Some(monitor.channel_id()),
10468 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, channel_id, monitor_update)));
10472 const MAX_ALLOC_SIZE: usize = 1024 * 64;
10473 let forward_htlcs_count: u64 = Readable::read(reader)?;
10474 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
10475 for _ in 0..forward_htlcs_count {
10476 let short_channel_id = Readable::read(reader)?;
10477 let pending_forwards_count: u64 = Readable::read(reader)?;
10478 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
10479 for _ in 0..pending_forwards_count {
10480 pending_forwards.push(Readable::read(reader)?);
10482 forward_htlcs.insert(short_channel_id, pending_forwards);
10485 let claimable_htlcs_count: u64 = Readable::read(reader)?;
10486 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
10487 for _ in 0..claimable_htlcs_count {
10488 let payment_hash = Readable::read(reader)?;
10489 let previous_hops_len: u64 = Readable::read(reader)?;
10490 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
10491 for _ in 0..previous_hops_len {
10492 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
10494 claimable_htlcs_list.push((payment_hash, previous_hops));
10497 let peer_state_from_chans = |channel_by_id| {
10500 inbound_channel_request_by_id: HashMap::new(),
10501 latest_features: InitFeatures::empty(),
10502 pending_msg_events: Vec::new(),
10503 in_flight_monitor_updates: BTreeMap::new(),
10504 monitor_update_blocked_actions: BTreeMap::new(),
10505 actions_blocking_raa_monitor_updates: BTreeMap::new(),
10506 is_connected: false,
10510 let peer_count: u64 = Readable::read(reader)?;
10511 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
10512 for _ in 0..peer_count {
10513 let peer_pubkey = Readable::read(reader)?;
10514 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
10515 let mut peer_state = peer_state_from_chans(peer_chans);
10516 peer_state.latest_features = Readable::read(reader)?;
10517 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
10520 let event_count: u64 = Readable::read(reader)?;
10521 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
10522 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
10523 for _ in 0..event_count {
10524 match MaybeReadable::read(reader)? {
10525 Some(event) => pending_events_read.push_back((event, None)),
10530 let background_event_count: u64 = Readable::read(reader)?;
10531 for _ in 0..background_event_count {
10532 match <u8 as Readable>::read(reader)? {
10534 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
10535 // however we really don't (and never did) need them - we regenerate all
10536 // on-startup monitor updates.
10537 let _: OutPoint = Readable::read(reader)?;
10538 let _: ChannelMonitorUpdate = Readable::read(reader)?;
10540 _ => return Err(DecodeError::InvalidValue),
10544 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
10545 let highest_seen_timestamp: u32 = Readable::read(reader)?;
10547 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
10548 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
10549 for _ in 0..pending_inbound_payment_count {
10550 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
10551 return Err(DecodeError::InvalidValue);
10555 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
10556 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
10557 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
10558 for _ in 0..pending_outbound_payments_count_compat {
10559 let session_priv = Readable::read(reader)?;
10560 let payment = PendingOutboundPayment::Legacy {
10561 session_privs: [session_priv].iter().cloned().collect()
10563 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
10564 return Err(DecodeError::InvalidValue)
10568 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
10569 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
10570 let mut pending_outbound_payments = None;
10571 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
10572 let mut received_network_pubkey: Option<PublicKey> = None;
10573 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
10574 let mut probing_cookie_secret: Option<[u8; 32]> = None;
10575 let mut claimable_htlc_purposes = None;
10576 let mut claimable_htlc_onion_fields = None;
10577 let mut pending_claiming_payments = Some(HashMap::new());
10578 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
10579 let mut events_override = None;
10580 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
10581 read_tlv_fields!(reader, {
10582 (1, pending_outbound_payments_no_retry, option),
10583 (2, pending_intercepted_htlcs, option),
10584 (3, pending_outbound_payments, option),
10585 (4, pending_claiming_payments, option),
10586 (5, received_network_pubkey, option),
10587 (6, monitor_update_blocked_actions_per_peer, option),
10588 (7, fake_scid_rand_bytes, option),
10589 (8, events_override, option),
10590 (9, claimable_htlc_purposes, optional_vec),
10591 (10, in_flight_monitor_updates, option),
10592 (11, probing_cookie_secret, option),
10593 (13, claimable_htlc_onion_fields, optional_vec),
10595 if fake_scid_rand_bytes.is_none() {
10596 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
10599 if probing_cookie_secret.is_none() {
10600 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
10603 if let Some(events) = events_override {
10604 pending_events_read = events;
10607 if !channel_closures.is_empty() {
10608 pending_events_read.append(&mut channel_closures);
10611 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
10612 pending_outbound_payments = Some(pending_outbound_payments_compat);
10613 } else if pending_outbound_payments.is_none() {
10614 let mut outbounds = HashMap::new();
10615 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
10616 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
10618 pending_outbound_payments = Some(outbounds);
10620 let pending_outbounds = OutboundPayments {
10621 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
10622 retry_lock: Mutex::new(())
10625 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
10626 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
10627 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
10628 // replayed, and for each monitor update we have to replay we have to ensure there's a
10629 // `ChannelMonitor` for it.
10631 // In order to do so we first walk all of our live channels (so that we can check their
10632 // state immediately after doing the update replays, when we have the `update_id`s
10633 // available) and then walk any remaining in-flight updates.
10635 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
10636 let mut pending_background_events = Vec::new();
10637 macro_rules! handle_in_flight_updates {
10638 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
10639 $monitor: expr, $peer_state: expr, $logger: expr, $channel_info_log: expr
10641 let mut max_in_flight_update_id = 0;
10642 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
10643 for update in $chan_in_flight_upds.iter() {
10644 log_trace!($logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
10645 update.update_id, $channel_info_log, &$monitor.channel_id());
10646 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
10647 pending_background_events.push(
10648 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10649 counterparty_node_id: $counterparty_node_id,
10650 funding_txo: $funding_txo,
10651 channel_id: $monitor.channel_id(),
10652 update: update.clone(),
10655 if $chan_in_flight_upds.is_empty() {
10656 // We had some updates to apply, but it turns out they had completed before we
10657 // were serialized, we just weren't notified of that. Thus, we may have to run
10658 // the completion actions for any monitor updates, but otherwise are done.
10659 pending_background_events.push(
10660 BackgroundEvent::MonitorUpdatesComplete {
10661 counterparty_node_id: $counterparty_node_id,
10662 channel_id: $monitor.channel_id(),
10665 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
10666 log_error!($logger, "Duplicate in-flight monitor update set for the same channel!");
10667 return Err(DecodeError::InvalidValue);
10669 max_in_flight_update_id
10673 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
10674 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
10675 let peer_state = &mut *peer_state_lock;
10676 for phase in peer_state.channel_by_id.values() {
10677 if let ChannelPhase::Funded(chan) = phase {
10678 let logger = WithChannelContext::from(&args.logger, &chan.context);
10680 // Channels that were persisted have to be funded, otherwise they should have been
10682 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10683 let monitor = args.channel_monitors.get(&funding_txo)
10684 .expect("We already checked for monitor presence when loading channels");
10685 let mut max_in_flight_update_id = monitor.get_latest_update_id();
10686 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
10687 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
10688 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
10689 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
10690 funding_txo, monitor, peer_state, logger, ""));
10693 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
10694 // If the channel is ahead of the monitor, return InvalidValue:
10695 log_error!(logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
10696 log_error!(logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
10697 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
10698 log_error!(logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
10699 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10700 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10701 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10702 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10703 return Err(DecodeError::InvalidValue);
10706 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10707 // created in this `channel_by_id` map.
10708 debug_assert!(false);
10709 return Err(DecodeError::InvalidValue);
10714 if let Some(in_flight_upds) = in_flight_monitor_updates {
10715 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
10716 let channel_id = funding_txo_to_channel_id.get(&funding_txo).copied();
10717 let logger = WithContext::from(&args.logger, Some(counterparty_id), channel_id);
10718 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
10719 // Now that we've removed all the in-flight monitor updates for channels that are
10720 // still open, we need to replay any monitor updates that are for closed channels,
10721 // creating the neccessary peer_state entries as we go.
10722 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
10723 Mutex::new(peer_state_from_chans(HashMap::new()))
10725 let mut peer_state = peer_state_mutex.lock().unwrap();
10726 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
10727 funding_txo, monitor, peer_state, logger, "closed ");
10729 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!");
10730 log_error!(logger, " The ChannelMonitor for channel {} is missing.", if let Some(channel_id) =
10731 channel_id { channel_id.to_string() } else { format!("with outpoint {}", funding_txo) } );
10732 log_error!(logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10733 log_error!(logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10734 log_error!(logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10735 log_error!(logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10736 return Err(DecodeError::InvalidValue);
10741 // Note that we have to do the above replays before we push new monitor updates.
10742 pending_background_events.append(&mut close_background_events);
10744 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
10745 // should ensure we try them again on the inbound edge. We put them here and do so after we
10746 // have a fully-constructed `ChannelManager` at the end.
10747 let mut pending_claims_to_replay = Vec::new();
10750 // If we're tracking pending payments, ensure we haven't lost any by looking at the
10751 // ChannelMonitor data for any channels for which we do not have authorative state
10752 // (i.e. those for which we just force-closed above or we otherwise don't have a
10753 // corresponding `Channel` at all).
10754 // This avoids several edge-cases where we would otherwise "forget" about pending
10755 // payments which are still in-flight via their on-chain state.
10756 // We only rebuild the pending payments map if we were most recently serialized by
10758 for (_, monitor) in args.channel_monitors.iter() {
10759 let counterparty_opt = outpoint_to_peer.get(&monitor.get_funding_txo().0);
10760 if counterparty_opt.is_none() {
10761 let logger = WithChannelMonitor::from(&args.logger, monitor);
10762 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
10763 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
10764 if path.hops.is_empty() {
10765 log_error!(logger, "Got an empty path for a pending payment");
10766 return Err(DecodeError::InvalidValue);
10769 let path_amt = path.final_value_msat();
10770 let mut session_priv_bytes = [0; 32];
10771 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
10772 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
10773 hash_map::Entry::Occupied(mut entry) => {
10774 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
10775 log_info!(logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
10776 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), htlc.payment_hash);
10778 hash_map::Entry::Vacant(entry) => {
10779 let path_fee = path.fee_msat();
10780 entry.insert(PendingOutboundPayment::Retryable {
10781 retry_strategy: None,
10782 attempts: PaymentAttempts::new(),
10783 payment_params: None,
10784 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
10785 payment_hash: htlc.payment_hash,
10786 payment_secret: None, // only used for retries, and we'll never retry on startup
10787 payment_metadata: None, // only used for retries, and we'll never retry on startup
10788 keysend_preimage: None, // only used for retries, and we'll never retry on startup
10789 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
10790 pending_amt_msat: path_amt,
10791 pending_fee_msat: Some(path_fee),
10792 total_msat: path_amt,
10793 starting_block_height: best_block_height,
10794 remaining_max_total_routing_fee_msat: None, // only used for retries, and we'll never retry on startup
10796 log_info!(logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
10797 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
10802 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
10803 match htlc_source {
10804 HTLCSource::PreviousHopData(prev_hop_data) => {
10805 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
10806 info.prev_funding_outpoint == prev_hop_data.outpoint &&
10807 info.prev_htlc_id == prev_hop_data.htlc_id
10809 // The ChannelMonitor is now responsible for this HTLC's
10810 // failure/success and will let us know what its outcome is. If we
10811 // still have an entry for this HTLC in `forward_htlcs` or
10812 // `pending_intercepted_htlcs`, we were apparently not persisted after
10813 // the monitor was when forwarding the payment.
10814 forward_htlcs.retain(|_, forwards| {
10815 forwards.retain(|forward| {
10816 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
10817 if pending_forward_matches_htlc(&htlc_info) {
10818 log_info!(logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
10819 &htlc.payment_hash, &monitor.channel_id());
10824 !forwards.is_empty()
10826 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
10827 if pending_forward_matches_htlc(&htlc_info) {
10828 log_info!(logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
10829 &htlc.payment_hash, &monitor.channel_id());
10830 pending_events_read.retain(|(event, _)| {
10831 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
10832 intercepted_id != ev_id
10839 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
10840 if let Some(preimage) = preimage_opt {
10841 let pending_events = Mutex::new(pending_events_read);
10842 // Note that we set `from_onchain` to "false" here,
10843 // deliberately keeping the pending payment around forever.
10844 // Given it should only occur when we have a channel we're
10845 // force-closing for being stale that's okay.
10846 // The alternative would be to wipe the state when claiming,
10847 // generating a `PaymentPathSuccessful` event but regenerating
10848 // it and the `PaymentSent` on every restart until the
10849 // `ChannelMonitor` is removed.
10851 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
10852 channel_funding_outpoint: monitor.get_funding_txo().0,
10853 channel_id: monitor.channel_id(),
10854 counterparty_node_id: path.hops[0].pubkey,
10856 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
10857 path, false, compl_action, &pending_events, &&logger);
10858 pending_events_read = pending_events.into_inner().unwrap();
10865 // Whether the downstream channel was closed or not, try to re-apply any payment
10866 // preimages from it which may be needed in upstream channels for forwarded
10868 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
10870 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
10871 if let HTLCSource::PreviousHopData(_) = htlc_source {
10872 if let Some(payment_preimage) = preimage_opt {
10873 Some((htlc_source, payment_preimage, htlc.amount_msat,
10874 // Check if `counterparty_opt.is_none()` to see if the
10875 // downstream chan is closed (because we don't have a
10876 // channel_id -> peer map entry).
10877 counterparty_opt.is_none(),
10878 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
10879 monitor.get_funding_txo().0, monitor.channel_id()))
10882 // If it was an outbound payment, we've handled it above - if a preimage
10883 // came in and we persisted the `ChannelManager` we either handled it and
10884 // are good to go or the channel force-closed - we don't have to handle the
10885 // channel still live case here.
10889 for tuple in outbound_claimed_htlcs_iter {
10890 pending_claims_to_replay.push(tuple);
10895 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
10896 // If we have pending HTLCs to forward, assume we either dropped a
10897 // `PendingHTLCsForwardable` or the user received it but never processed it as they
10898 // shut down before the timer hit. Either way, set the time_forwardable to a small
10899 // constant as enough time has likely passed that we should simply handle the forwards
10900 // now, or at least after the user gets a chance to reconnect to our peers.
10901 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
10902 time_forwardable: Duration::from_secs(2),
10906 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
10907 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
10909 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
10910 if let Some(purposes) = claimable_htlc_purposes {
10911 if purposes.len() != claimable_htlcs_list.len() {
10912 return Err(DecodeError::InvalidValue);
10914 if let Some(onion_fields) = claimable_htlc_onion_fields {
10915 if onion_fields.len() != claimable_htlcs_list.len() {
10916 return Err(DecodeError::InvalidValue);
10918 for (purpose, (onion, (payment_hash, htlcs))) in
10919 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
10921 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10922 purpose, htlcs, onion_fields: onion,
10924 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10927 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
10928 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10929 purpose, htlcs, onion_fields: None,
10931 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10935 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
10936 // include a `_legacy_hop_data` in the `OnionPayload`.
10937 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
10938 if htlcs.is_empty() {
10939 return Err(DecodeError::InvalidValue);
10941 let purpose = match &htlcs[0].onion_payload {
10942 OnionPayload::Invoice { _legacy_hop_data } => {
10943 if let Some(hop_data) = _legacy_hop_data {
10944 events::PaymentPurpose::InvoicePayment {
10945 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
10946 Some(inbound_payment) => inbound_payment.payment_preimage,
10947 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
10948 Ok((payment_preimage, _)) => payment_preimage,
10950 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);
10951 return Err(DecodeError::InvalidValue);
10955 payment_secret: hop_data.payment_secret,
10957 } else { return Err(DecodeError::InvalidValue); }
10959 OnionPayload::Spontaneous(payment_preimage) =>
10960 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
10962 claimable_payments.insert(payment_hash, ClaimablePayment {
10963 purpose, htlcs, onion_fields: None,
10968 let mut secp_ctx = Secp256k1::new();
10969 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
10971 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
10973 Err(()) => return Err(DecodeError::InvalidValue)
10975 if let Some(network_pubkey) = received_network_pubkey {
10976 if network_pubkey != our_network_pubkey {
10977 log_error!(args.logger, "Key that was generated does not match the existing key.");
10978 return Err(DecodeError::InvalidValue);
10982 let mut outbound_scid_aliases = HashSet::new();
10983 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
10984 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
10985 let peer_state = &mut *peer_state_lock;
10986 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
10987 if let ChannelPhase::Funded(chan) = phase {
10988 let logger = WithChannelContext::from(&args.logger, &chan.context);
10989 if chan.context.outbound_scid_alias() == 0 {
10990 let mut outbound_scid_alias;
10992 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
10993 .get_fake_scid(best_block_height, &chain_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
10994 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
10996 chan.context.set_outbound_scid_alias(outbound_scid_alias);
10997 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
10998 // Note that in rare cases its possible to hit this while reading an older
10999 // channel if we just happened to pick a colliding outbound alias above.
11000 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
11001 return Err(DecodeError::InvalidValue);
11003 if chan.context.is_usable() {
11004 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
11005 // Note that in rare cases its possible to hit this while reading an older
11006 // channel if we just happened to pick a colliding outbound alias above.
11007 log_error!(logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
11008 return Err(DecodeError::InvalidValue);
11012 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
11013 // created in this `channel_by_id` map.
11014 debug_assert!(false);
11015 return Err(DecodeError::InvalidValue);
11020 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
11022 for (_, monitor) in args.channel_monitors.iter() {
11023 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
11024 if let Some(payment) = claimable_payments.remove(&payment_hash) {
11025 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
11026 let mut claimable_amt_msat = 0;
11027 let mut receiver_node_id = Some(our_network_pubkey);
11028 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
11029 if phantom_shared_secret.is_some() {
11030 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
11031 .expect("Failed to get node_id for phantom node recipient");
11032 receiver_node_id = Some(phantom_pubkey)
11034 for claimable_htlc in &payment.htlcs {
11035 claimable_amt_msat += claimable_htlc.value;
11037 // Add a holding-cell claim of the payment to the Channel, which should be
11038 // applied ~immediately on peer reconnection. Because it won't generate a
11039 // new commitment transaction we can just provide the payment preimage to
11040 // the corresponding ChannelMonitor and nothing else.
11042 // We do so directly instead of via the normal ChannelMonitor update
11043 // procedure as the ChainMonitor hasn't yet been initialized, implying
11044 // we're not allowed to call it directly yet. Further, we do the update
11045 // without incrementing the ChannelMonitor update ID as there isn't any
11047 // If we were to generate a new ChannelMonitor update ID here and then
11048 // crash before the user finishes block connect we'd end up force-closing
11049 // this channel as well. On the flip side, there's no harm in restarting
11050 // without the new monitor persisted - we'll end up right back here on
11052 let previous_channel_id = claimable_htlc.prev_hop.channel_id;
11053 if let Some(peer_node_id) = outpoint_to_peer.get(&claimable_htlc.prev_hop.outpoint) {
11054 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
11055 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
11056 let peer_state = &mut *peer_state_lock;
11057 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
11058 let logger = WithChannelContext::from(&args.logger, &channel.context);
11059 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &&logger);
11062 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
11063 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
11066 pending_events_read.push_back((events::Event::PaymentClaimed {
11069 purpose: payment.purpose,
11070 amount_msat: claimable_amt_msat,
11071 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
11072 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
11078 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
11079 if let Some(peer_state) = per_peer_state.get(&node_id) {
11080 for (channel_id, actions) in monitor_update_blocked_actions.iter() {
11081 let logger = WithContext::from(&args.logger, Some(node_id), Some(*channel_id));
11082 for action in actions.iter() {
11083 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
11084 downstream_counterparty_and_funding_outpoint:
11085 Some((blocked_node_id, _blocked_channel_outpoint, blocked_channel_id, blocking_action)), ..
11087 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
11089 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
11090 blocked_channel_id);
11091 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
11092 .entry(*blocked_channel_id)
11093 .or_insert_with(Vec::new).push(blocking_action.clone());
11095 // If the channel we were blocking has closed, we don't need to
11096 // worry about it - the blocked monitor update should never have
11097 // been released from the `Channel` object so it can't have
11098 // completed, and if the channel closed there's no reason to bother
11102 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately { .. } = action {
11103 debug_assert!(false, "Non-event-generating channel freeing should not appear in our queue");
11107 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
11109 log_error!(WithContext::from(&args.logger, Some(node_id), None), "Got blocked actions without a per-peer-state for {}", node_id);
11110 return Err(DecodeError::InvalidValue);
11114 let channel_manager = ChannelManager {
11116 fee_estimator: bounded_fee_estimator,
11117 chain_monitor: args.chain_monitor,
11118 tx_broadcaster: args.tx_broadcaster,
11119 router: args.router,
11121 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
11123 inbound_payment_key: expanded_inbound_key,
11124 pending_inbound_payments: Mutex::new(pending_inbound_payments),
11125 pending_outbound_payments: pending_outbounds,
11126 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
11128 forward_htlcs: Mutex::new(forward_htlcs),
11129 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
11130 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
11131 outpoint_to_peer: Mutex::new(outpoint_to_peer),
11132 short_to_chan_info: FairRwLock::new(short_to_chan_info),
11133 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
11135 probing_cookie_secret: probing_cookie_secret.unwrap(),
11137 our_network_pubkey,
11140 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
11142 per_peer_state: FairRwLock::new(per_peer_state),
11144 pending_events: Mutex::new(pending_events_read),
11145 pending_events_processor: AtomicBool::new(false),
11146 pending_background_events: Mutex::new(pending_background_events),
11147 total_consistency_lock: RwLock::new(()),
11148 background_events_processed_since_startup: AtomicBool::new(false),
11150 event_persist_notifier: Notifier::new(),
11151 needs_persist_flag: AtomicBool::new(false),
11153 funding_batch_states: Mutex::new(BTreeMap::new()),
11155 pending_offers_messages: Mutex::new(Vec::new()),
11157 entropy_source: args.entropy_source,
11158 node_signer: args.node_signer,
11159 signer_provider: args.signer_provider,
11161 logger: args.logger,
11162 default_configuration: args.default_config,
11165 for htlc_source in failed_htlcs.drain(..) {
11166 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
11167 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
11168 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
11169 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
11172 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding, downstream_channel_id) in pending_claims_to_replay {
11173 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
11174 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
11175 // channel is closed we just assume that it probably came from an on-chain claim.
11176 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value), None,
11177 downstream_closed, true, downstream_node_id, downstream_funding, downstream_channel_id);
11180 //TODO: Broadcast channel update for closed channels, but only after we've made a
11181 //connection or two.
11183 Ok((best_block_hash.clone(), channel_manager))
11189 use bitcoin::hashes::Hash;
11190 use bitcoin::hashes::sha256::Hash as Sha256;
11191 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
11192 use core::sync::atomic::Ordering;
11193 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
11194 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
11195 use crate::ln::ChannelId;
11196 use crate::ln::channelmanager::{create_recv_pending_htlc_info, HTLCForwardInfo, inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
11197 use crate::ln::functional_test_utils::*;
11198 use crate::ln::msgs::{self, ErrorAction};
11199 use crate::ln::msgs::ChannelMessageHandler;
11200 use crate::prelude::*;
11201 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
11202 use crate::util::errors::APIError;
11203 use crate::util::ser::Writeable;
11204 use crate::util::test_utils;
11205 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
11206 use crate::sign::EntropySource;
11209 fn test_notify_limits() {
11210 // Check that a few cases which don't require the persistence of a new ChannelManager,
11211 // indeed, do not cause the persistence of a new ChannelManager.
11212 let chanmon_cfgs = create_chanmon_cfgs(3);
11213 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
11214 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
11215 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
11217 // All nodes start with a persistable update pending as `create_network` connects each node
11218 // with all other nodes to make most tests simpler.
11219 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11220 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11221 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11223 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11225 // We check that the channel info nodes have doesn't change too early, even though we try
11226 // to connect messages with new values
11227 chan.0.contents.fee_base_msat *= 2;
11228 chan.1.contents.fee_base_msat *= 2;
11229 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
11230 &nodes[1].node.get_our_node_id()).pop().unwrap();
11231 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
11232 &nodes[0].node.get_our_node_id()).pop().unwrap();
11234 // The first two nodes (which opened a channel) should now require 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());
11237 // ... but the last node should not.
11238 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11239 // After persisting the first two nodes they should no longer need fresh persistence.
11240 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11241 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11243 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
11244 // about the channel.
11245 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
11246 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
11247 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
11249 // The nodes which are a party to the channel should also ignore messages from unrelated
11251 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11252 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11253 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
11254 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
11255 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11256 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11258 // At this point the channel info given by peers should still be the same.
11259 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11260 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11262 // An earlier version of handle_channel_update didn't check the directionality of the
11263 // update message and would always update the local fee info, even if our peer was
11264 // (spuriously) forwarding us our own channel_update.
11265 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
11266 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
11267 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
11269 // First deliver each peers' own message, checking that the node doesn't need to be
11270 // persisted and that its channel info remains the same.
11271 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
11272 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
11273 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11274 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11275 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
11276 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
11278 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
11279 // the channel info has updated.
11280 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
11281 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
11282 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
11283 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
11284 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
11285 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
11289 fn test_keysend_dup_hash_partial_mpp() {
11290 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
11292 let chanmon_cfgs = create_chanmon_cfgs(2);
11293 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11294 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11295 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11296 create_announced_chan_between_nodes(&nodes, 0, 1);
11298 // First, send a partial MPP payment.
11299 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
11300 let mut mpp_route = route.clone();
11301 mpp_route.paths.push(mpp_route.paths[0].clone());
11303 let payment_id = PaymentId([42; 32]);
11304 // Use the utility function send_payment_along_path to send the payment with MPP data which
11305 // indicates there are more HTLCs coming.
11306 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.
11307 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
11308 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
11309 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
11310 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
11311 check_added_monitors!(nodes[0], 1);
11312 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11313 assert_eq!(events.len(), 1);
11314 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
11316 // Next, send a keysend payment with the same payment_hash and make sure it fails.
11317 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11318 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11319 check_added_monitors!(nodes[0], 1);
11320 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11321 assert_eq!(events.len(), 1);
11322 let ev = events.drain(..).next().unwrap();
11323 let payment_event = SendEvent::from_event(ev);
11324 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11325 check_added_monitors!(nodes[1], 0);
11326 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11327 expect_pending_htlcs_forwardable!(nodes[1]);
11328 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
11329 check_added_monitors!(nodes[1], 1);
11330 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11331 assert!(updates.update_add_htlcs.is_empty());
11332 assert!(updates.update_fulfill_htlcs.is_empty());
11333 assert_eq!(updates.update_fail_htlcs.len(), 1);
11334 assert!(updates.update_fail_malformed_htlcs.is_empty());
11335 assert!(updates.update_fee.is_none());
11336 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11337 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11338 expect_payment_failed!(nodes[0], our_payment_hash, true);
11340 // Send the second half of the original MPP payment.
11341 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
11342 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
11343 check_added_monitors!(nodes[0], 1);
11344 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11345 assert_eq!(events.len(), 1);
11346 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
11348 // Claim the full MPP payment. Note that we can't use a test utility like
11349 // claim_funds_along_route because the ordering of the messages causes the second half of the
11350 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
11351 // lightning messages manually.
11352 nodes[1].node.claim_funds(payment_preimage);
11353 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
11354 check_added_monitors!(nodes[1], 2);
11356 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11357 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
11358 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
11359 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
11360 check_added_monitors!(nodes[0], 1);
11361 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11362 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
11363 check_added_monitors!(nodes[1], 1);
11364 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11365 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
11366 check_added_monitors!(nodes[1], 1);
11367 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11368 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
11369 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
11370 check_added_monitors!(nodes[0], 1);
11371 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
11372 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
11373 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11374 check_added_monitors!(nodes[0], 1);
11375 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
11376 check_added_monitors!(nodes[1], 1);
11377 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
11378 check_added_monitors!(nodes[1], 1);
11379 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11380 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
11381 check_added_monitors!(nodes[0], 1);
11383 // Note that successful MPP payments will generate a single PaymentSent event upon the first
11384 // path's success and a PaymentPathSuccessful event for each path's success.
11385 let events = nodes[0].node.get_and_clear_pending_events();
11386 assert_eq!(events.len(), 2);
11388 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11389 assert_eq!(payment_id, *actual_payment_id);
11390 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11391 assert_eq!(route.paths[0], *path);
11393 _ => panic!("Unexpected event"),
11396 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11397 assert_eq!(payment_id, *actual_payment_id);
11398 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11399 assert_eq!(route.paths[0], *path);
11401 _ => panic!("Unexpected event"),
11406 fn test_keysend_dup_payment_hash() {
11407 do_test_keysend_dup_payment_hash(false);
11408 do_test_keysend_dup_payment_hash(true);
11411 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
11412 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
11413 // outbound regular payment fails as expected.
11414 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
11415 // fails as expected.
11416 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
11417 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
11418 // reject MPP keysend payments, since in this case where the payment has no payment
11419 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
11420 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
11421 // payment secrets and reject otherwise.
11422 let chanmon_cfgs = create_chanmon_cfgs(2);
11423 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11424 let mut mpp_keysend_cfg = test_default_channel_config();
11425 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
11426 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
11427 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11428 create_announced_chan_between_nodes(&nodes, 0, 1);
11429 let scorer = test_utils::TestScorer::new();
11430 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11432 // To start (1), send a regular payment but don't claim it.
11433 let expected_route = [&nodes[1]];
11434 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
11436 // Next, attempt a keysend payment and make sure it fails.
11437 let route_params = RouteParameters::from_payment_params_and_value(
11438 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
11439 TEST_FINAL_CLTV, false), 100_000);
11440 let route = find_route(
11441 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11442 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11444 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11445 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11446 check_added_monitors!(nodes[0], 1);
11447 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11448 assert_eq!(events.len(), 1);
11449 let ev = events.drain(..).next().unwrap();
11450 let payment_event = SendEvent::from_event(ev);
11451 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11452 check_added_monitors!(nodes[1], 0);
11453 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11454 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
11455 // fails), the second will process the resulting failure and fail the HTLC backward
11456 expect_pending_htlcs_forwardable!(nodes[1]);
11457 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11458 check_added_monitors!(nodes[1], 1);
11459 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11460 assert!(updates.update_add_htlcs.is_empty());
11461 assert!(updates.update_fulfill_htlcs.is_empty());
11462 assert_eq!(updates.update_fail_htlcs.len(), 1);
11463 assert!(updates.update_fail_malformed_htlcs.is_empty());
11464 assert!(updates.update_fee.is_none());
11465 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11466 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11467 expect_payment_failed!(nodes[0], payment_hash, true);
11469 // Finally, claim the original payment.
11470 claim_payment(&nodes[0], &expected_route, payment_preimage);
11472 // To start (2), send a keysend payment but don't claim it.
11473 let payment_preimage = PaymentPreimage([42; 32]);
11474 let route = find_route(
11475 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11476 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11478 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11479 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11480 check_added_monitors!(nodes[0], 1);
11481 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11482 assert_eq!(events.len(), 1);
11483 let event = events.pop().unwrap();
11484 let path = vec![&nodes[1]];
11485 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11487 // Next, attempt a regular payment and make sure it fails.
11488 let payment_secret = PaymentSecret([43; 32]);
11489 nodes[0].node.send_payment_with_route(&route, payment_hash,
11490 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
11491 check_added_monitors!(nodes[0], 1);
11492 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11493 assert_eq!(events.len(), 1);
11494 let ev = events.drain(..).next().unwrap();
11495 let payment_event = SendEvent::from_event(ev);
11496 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11497 check_added_monitors!(nodes[1], 0);
11498 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11499 expect_pending_htlcs_forwardable!(nodes[1]);
11500 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11501 check_added_monitors!(nodes[1], 1);
11502 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11503 assert!(updates.update_add_htlcs.is_empty());
11504 assert!(updates.update_fulfill_htlcs.is_empty());
11505 assert_eq!(updates.update_fail_htlcs.len(), 1);
11506 assert!(updates.update_fail_malformed_htlcs.is_empty());
11507 assert!(updates.update_fee.is_none());
11508 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11509 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11510 expect_payment_failed!(nodes[0], payment_hash, true);
11512 // Finally, succeed the keysend payment.
11513 claim_payment(&nodes[0], &expected_route, payment_preimage);
11515 // To start (3), send a keysend payment but don't claim it.
11516 let payment_id_1 = PaymentId([44; 32]);
11517 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11518 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
11519 check_added_monitors!(nodes[0], 1);
11520 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11521 assert_eq!(events.len(), 1);
11522 let event = events.pop().unwrap();
11523 let path = vec![&nodes[1]];
11524 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11526 // Next, attempt a keysend payment and make sure it fails.
11527 let route_params = RouteParameters::from_payment_params_and_value(
11528 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
11531 let route = find_route(
11532 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11533 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11535 let payment_id_2 = PaymentId([45; 32]);
11536 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11537 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
11538 check_added_monitors!(nodes[0], 1);
11539 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11540 assert_eq!(events.len(), 1);
11541 let ev = events.drain(..).next().unwrap();
11542 let payment_event = SendEvent::from_event(ev);
11543 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11544 check_added_monitors!(nodes[1], 0);
11545 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11546 expect_pending_htlcs_forwardable!(nodes[1]);
11547 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11548 check_added_monitors!(nodes[1], 1);
11549 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11550 assert!(updates.update_add_htlcs.is_empty());
11551 assert!(updates.update_fulfill_htlcs.is_empty());
11552 assert_eq!(updates.update_fail_htlcs.len(), 1);
11553 assert!(updates.update_fail_malformed_htlcs.is_empty());
11554 assert!(updates.update_fee.is_none());
11555 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11556 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11557 expect_payment_failed!(nodes[0], payment_hash, true);
11559 // Finally, claim the original payment.
11560 claim_payment(&nodes[0], &expected_route, payment_preimage);
11564 fn test_keysend_hash_mismatch() {
11565 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
11566 // preimage doesn't match the msg's payment hash.
11567 let chanmon_cfgs = create_chanmon_cfgs(2);
11568 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11569 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11570 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11572 let payer_pubkey = nodes[0].node.get_our_node_id();
11573 let payee_pubkey = nodes[1].node.get_our_node_id();
11575 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11576 let route_params = RouteParameters::from_payment_params_and_value(
11577 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11578 let network_graph = nodes[0].network_graph;
11579 let first_hops = nodes[0].node.list_usable_channels();
11580 let scorer = test_utils::TestScorer::new();
11581 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11582 let route = find_route(
11583 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11584 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11587 let test_preimage = PaymentPreimage([42; 32]);
11588 let mismatch_payment_hash = PaymentHash([43; 32]);
11589 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
11590 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
11591 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
11592 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
11593 check_added_monitors!(nodes[0], 1);
11595 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11596 assert_eq!(updates.update_add_htlcs.len(), 1);
11597 assert!(updates.update_fulfill_htlcs.is_empty());
11598 assert!(updates.update_fail_htlcs.is_empty());
11599 assert!(updates.update_fail_malformed_htlcs.is_empty());
11600 assert!(updates.update_fee.is_none());
11601 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11603 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
11607 fn test_keysend_msg_with_secret_err() {
11608 // Test that we error as expected if we receive a keysend payment that includes a payment
11609 // secret when we don't support MPP keysend.
11610 let mut reject_mpp_keysend_cfg = test_default_channel_config();
11611 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
11612 let chanmon_cfgs = create_chanmon_cfgs(2);
11613 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11614 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
11615 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11617 let payer_pubkey = nodes[0].node.get_our_node_id();
11618 let payee_pubkey = nodes[1].node.get_our_node_id();
11620 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11621 let route_params = RouteParameters::from_payment_params_and_value(
11622 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11623 let network_graph = nodes[0].network_graph;
11624 let first_hops = nodes[0].node.list_usable_channels();
11625 let scorer = test_utils::TestScorer::new();
11626 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11627 let route = find_route(
11628 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11629 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11632 let test_preimage = PaymentPreimage([42; 32]);
11633 let test_secret = PaymentSecret([43; 32]);
11634 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).to_byte_array());
11635 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
11636 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
11637 nodes[0].node.test_send_payment_internal(&route, payment_hash,
11638 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
11639 PaymentId(payment_hash.0), None, session_privs).unwrap();
11640 check_added_monitors!(nodes[0], 1);
11642 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11643 assert_eq!(updates.update_add_htlcs.len(), 1);
11644 assert!(updates.update_fulfill_htlcs.is_empty());
11645 assert!(updates.update_fail_htlcs.is_empty());
11646 assert!(updates.update_fail_malformed_htlcs.is_empty());
11647 assert!(updates.update_fee.is_none());
11648 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11650 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
11654 fn test_multi_hop_missing_secret() {
11655 let chanmon_cfgs = create_chanmon_cfgs(4);
11656 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
11657 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
11658 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
11660 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
11661 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
11662 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
11663 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
11665 // Marshall an MPP route.
11666 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
11667 let path = route.paths[0].clone();
11668 route.paths.push(path);
11669 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
11670 route.paths[0].hops[0].short_channel_id = chan_1_id;
11671 route.paths[0].hops[1].short_channel_id = chan_3_id;
11672 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
11673 route.paths[1].hops[0].short_channel_id = chan_2_id;
11674 route.paths[1].hops[1].short_channel_id = chan_4_id;
11676 match nodes[0].node.send_payment_with_route(&route, payment_hash,
11677 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
11679 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
11680 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
11682 _ => panic!("unexpected error")
11687 fn test_drop_disconnected_peers_when_removing_channels() {
11688 let chanmon_cfgs = create_chanmon_cfgs(2);
11689 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11690 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11691 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11693 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11695 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
11696 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11698 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
11699 check_closed_broadcast!(nodes[0], true);
11700 check_added_monitors!(nodes[0], 1);
11701 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
11704 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
11705 // disconnected and the channel between has been force closed.
11706 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
11707 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
11708 assert_eq!(nodes_0_per_peer_state.len(), 1);
11709 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
11712 nodes[0].node.timer_tick_occurred();
11715 // Assert that nodes[1] has now been removed.
11716 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
11721 fn bad_inbound_payment_hash() {
11722 // Add coverage for checking that a user-provided payment hash matches the payment secret.
11723 let chanmon_cfgs = create_chanmon_cfgs(2);
11724 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11725 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11726 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11728 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
11729 let payment_data = msgs::FinalOnionHopData {
11731 total_msat: 100_000,
11734 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
11735 // payment verification fails as expected.
11736 let mut bad_payment_hash = payment_hash.clone();
11737 bad_payment_hash.0[0] += 1;
11738 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) {
11739 Ok(_) => panic!("Unexpected ok"),
11741 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
11745 // Check that using the original payment hash succeeds.
11746 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());
11750 fn test_outpoint_to_peer_coverage() {
11751 // Test that the `ChannelManager:outpoint_to_peer` contains channels which have been assigned
11752 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
11753 // the channel is successfully closed.
11754 let chanmon_cfgs = create_chanmon_cfgs(2);
11755 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11756 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11757 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11759 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, None).unwrap();
11760 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11761 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
11762 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11763 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11765 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
11766 let channel_id = ChannelId::from_bytes(tx.txid().to_byte_array());
11768 // Ensure that the `outpoint_to_peer` map is empty until either party has received the
11769 // funding transaction, and have the real `channel_id`.
11770 assert_eq!(nodes[0].node.outpoint_to_peer.lock().unwrap().len(), 0);
11771 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11774 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
11776 // Assert that `nodes[0]`'s `outpoint_to_peer` map is populated with the channel as soon as
11777 // as it has the funding transaction.
11778 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11779 assert_eq!(nodes_0_lock.len(), 1);
11780 assert!(nodes_0_lock.contains_key(&funding_output));
11783 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11785 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11787 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11789 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11790 assert_eq!(nodes_0_lock.len(), 1);
11791 assert!(nodes_0_lock.contains_key(&funding_output));
11793 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11796 // Assert that `nodes[1]`'s `outpoint_to_peer` map is populated with the channel as
11797 // soon as it has the funding transaction.
11798 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11799 assert_eq!(nodes_1_lock.len(), 1);
11800 assert!(nodes_1_lock.contains_key(&funding_output));
11802 check_added_monitors!(nodes[1], 1);
11803 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11804 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11805 check_added_monitors!(nodes[0], 1);
11806 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11807 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
11808 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
11809 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
11811 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
11812 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()));
11813 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
11814 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
11816 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
11817 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
11819 // Assert that the channel is kept in the `outpoint_to_peer` map for both nodes until the
11820 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
11821 // fee for the closing transaction has been negotiated and the parties has the other
11822 // party's signature for the fee negotiated closing transaction.)
11823 let nodes_0_lock = nodes[0].node.outpoint_to_peer.lock().unwrap();
11824 assert_eq!(nodes_0_lock.len(), 1);
11825 assert!(nodes_0_lock.contains_key(&funding_output));
11829 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
11830 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
11831 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
11832 // kept in the `nodes[1]`'s `outpoint_to_peer` map.
11833 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11834 assert_eq!(nodes_1_lock.len(), 1);
11835 assert!(nodes_1_lock.contains_key(&funding_output));
11838 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()));
11840 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
11841 // therefore has all it needs to fully close the channel (both signatures for the
11842 // closing transaction).
11843 // Assert that the channel is removed from `nodes[0]`'s `outpoint_to_peer` map as it can be
11844 // fully closed by `nodes[0]`.
11845 assert_eq!(nodes[0].node.outpoint_to_peer.lock().unwrap().len(), 0);
11847 // Assert that the channel is still in `nodes[1]`'s `outpoint_to_peer` map, as `nodes[1]`
11848 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
11849 let nodes_1_lock = nodes[1].node.outpoint_to_peer.lock().unwrap();
11850 assert_eq!(nodes_1_lock.len(), 1);
11851 assert!(nodes_1_lock.contains_key(&funding_output));
11854 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
11856 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
11858 // Assert that the channel has now been removed from both parties `outpoint_to_peer` map once
11859 // they both have everything required to fully close the channel.
11860 assert_eq!(nodes[1].node.outpoint_to_peer.lock().unwrap().len(), 0);
11862 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
11864 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
11865 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
11868 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11869 let expected_message = format!("Not connected to node: {}", expected_public_key);
11870 check_api_error_message(expected_message, res_err)
11873 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11874 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
11875 check_api_error_message(expected_message, res_err)
11878 fn check_channel_unavailable_error<T>(res_err: Result<T, APIError>, expected_channel_id: ChannelId, peer_node_id: PublicKey) {
11879 let expected_message = format!("Channel with id {} not found for the passed counterparty node_id {}", expected_channel_id, peer_node_id);
11880 check_api_error_message(expected_message, res_err)
11883 fn check_api_misuse_error<T>(res_err: Result<T, APIError>) {
11884 let expected_message = "No such channel awaiting to be accepted.".to_string();
11885 check_api_error_message(expected_message, res_err)
11888 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
11890 Err(APIError::APIMisuseError { err }) => {
11891 assert_eq!(err, expected_err_message);
11893 Err(APIError::ChannelUnavailable { err }) => {
11894 assert_eq!(err, expected_err_message);
11896 Ok(_) => panic!("Unexpected Ok"),
11897 Err(_) => panic!("Unexpected Error"),
11902 fn test_api_calls_with_unkown_counterparty_node() {
11903 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
11904 // expected if the `counterparty_node_id` is an unkown peer in the
11905 // `ChannelManager::per_peer_state` map.
11906 let chanmon_cfg = create_chanmon_cfgs(2);
11907 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11908 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11909 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11912 let channel_id = ChannelId::from_bytes([4; 32]);
11913 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
11914 let intercept_id = InterceptId([0; 32]);
11916 // Test the API functions.
11917 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);
11919 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
11921 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
11923 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
11925 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
11927 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
11929 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
11933 fn test_api_calls_with_unavailable_channel() {
11934 // Tests that our API functions that expects a `counterparty_node_id` and a `channel_id`
11935 // as input, behaves as expected if the `counterparty_node_id` is a known peer in the
11936 // `ChannelManager::per_peer_state` map, but the peer state doesn't contain a channel with
11937 // the given `channel_id`.
11938 let chanmon_cfg = create_chanmon_cfgs(2);
11939 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11940 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11941 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11943 let counterparty_node_id = nodes[1].node.get_our_node_id();
11946 let channel_id = ChannelId::from_bytes([4; 32]);
11948 // Test the API functions.
11949 check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42));
11951 check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11953 check_channel_unavailable_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11955 check_channel_unavailable_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11957 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);
11959 check_channel_unavailable_error(nodes[0].node.update_channel_config(&counterparty_node_id, &[channel_id], &ChannelConfig::default()), channel_id, counterparty_node_id);
11963 fn test_connection_limiting() {
11964 // Test that we limit un-channel'd peers and un-funded channels properly.
11965 let chanmon_cfgs = create_chanmon_cfgs(2);
11966 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11967 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11968 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11970 // Note that create_network connects the nodes together for us
11972 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11973 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11975 let mut funding_tx = None;
11976 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
11977 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11978 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11981 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11982 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
11983 funding_tx = Some(tx.clone());
11984 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
11985 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11987 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11988 check_added_monitors!(nodes[1], 1);
11989 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11991 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11993 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11994 check_added_monitors!(nodes[0], 1);
11995 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11997 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12000 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
12001 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12002 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12003 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12004 open_channel_msg.temporary_channel_id);
12006 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
12007 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
12009 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
12010 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
12011 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12012 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12013 peer_pks.push(random_pk);
12014 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
12015 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12018 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12019 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12020 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12021 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12022 }, true).unwrap_err();
12024 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
12025 // them if we have too many un-channel'd peers.
12026 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12027 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
12028 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
12029 for ev in chan_closed_events {
12030 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
12032 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12033 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
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 }, true).unwrap_err();
12039 // but of course if the connection is outbound its allowed...
12040 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12041 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12042 }, false).unwrap();
12043 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12045 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
12046 // Even though we accept one more connection from new peers, we won't actually let them
12048 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
12049 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
12050 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
12051 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
12052 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12054 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12055 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
12056 open_channel_msg.temporary_channel_id);
12058 // Of course, however, outbound channels are always allowed
12059 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None, None).unwrap();
12060 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
12062 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
12063 // "protected" and can connect again.
12064 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
12065 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12066 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12068 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
12070 // Further, because the first channel was funded, we can open another channel with
12072 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12073 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
12077 fn test_outbound_chans_unlimited() {
12078 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
12079 let chanmon_cfgs = create_chanmon_cfgs(2);
12080 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12081 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
12082 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12084 // Note that create_network connects the nodes together for us
12086 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12087 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12089 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
12090 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12091 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12092 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12095 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
12097 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12098 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12099 open_channel_msg.temporary_channel_id);
12101 // but we can still open an outbound channel.
12102 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12103 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
12105 // but even with such an outbound channel, additional inbound channels will still fail.
12106 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12107 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
12108 open_channel_msg.temporary_channel_id);
12112 fn test_0conf_limiting() {
12113 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12114 // flag set and (sometimes) accept channels as 0conf.
12115 let chanmon_cfgs = create_chanmon_cfgs(2);
12116 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12117 let mut settings = test_default_channel_config();
12118 settings.manually_accept_inbound_channels = true;
12119 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
12120 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12122 // Note that create_network connects the nodes together for us
12124 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12125 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12127 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
12128 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
12129 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12130 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12131 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
12132 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12135 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
12136 let events = nodes[1].node.get_and_clear_pending_events();
12138 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12139 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
12141 _ => panic!("Unexpected event"),
12143 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
12144 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
12147 // If we try to accept a channel from another peer non-0conf it will fail.
12148 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
12149 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
12150 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
12151 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12153 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12154 let events = nodes[1].node.get_and_clear_pending_events();
12156 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12157 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
12158 Err(APIError::APIMisuseError { err }) =>
12159 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
12163 _ => panic!("Unexpected event"),
12165 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
12166 open_channel_msg.temporary_channel_id);
12168 // ...however if we accept the same channel 0conf it should work just fine.
12169 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
12170 let events = nodes[1].node.get_and_clear_pending_events();
12172 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12173 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
12175 _ => panic!("Unexpected event"),
12177 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
12181 fn reject_excessively_underpaying_htlcs() {
12182 let chanmon_cfg = create_chanmon_cfgs(1);
12183 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12184 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12185 let node = create_network(1, &node_cfg, &node_chanmgr);
12186 let sender_intended_amt_msat = 100;
12187 let extra_fee_msat = 10;
12188 let hop_data = msgs::InboundOnionPayload::Receive {
12189 sender_intended_htlc_amt_msat: 100,
12190 cltv_expiry_height: 42,
12191 payment_metadata: None,
12192 keysend_preimage: None,
12193 payment_data: Some(msgs::FinalOnionHopData {
12194 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12196 custom_tlvs: Vec::new(),
12198 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
12199 // intended amount, we fail the payment.
12200 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12201 if let Err(crate::ln::channelmanager::InboundHTLCErr { err_code, .. }) =
12202 create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12203 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat),
12204 current_height, node[0].node.default_configuration.accept_mpp_keysend)
12206 assert_eq!(err_code, 19);
12207 } else { panic!(); }
12209 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
12210 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
12211 sender_intended_htlc_amt_msat: 100,
12212 cltv_expiry_height: 42,
12213 payment_metadata: None,
12214 keysend_preimage: None,
12215 payment_data: Some(msgs::FinalOnionHopData {
12216 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
12218 custom_tlvs: Vec::new(),
12220 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12221 assert!(create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
12222 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat),
12223 current_height, node[0].node.default_configuration.accept_mpp_keysend).is_ok());
12227 fn test_final_incorrect_cltv(){
12228 let chanmon_cfg = create_chanmon_cfgs(1);
12229 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12230 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
12231 let node = create_network(1, &node_cfg, &node_chanmgr);
12233 let current_height: u32 = node[0].node.best_block.read().unwrap().height();
12234 let result = create_recv_pending_htlc_info(msgs::InboundOnionPayload::Receive {
12235 sender_intended_htlc_amt_msat: 100,
12236 cltv_expiry_height: 22,
12237 payment_metadata: None,
12238 keysend_preimage: None,
12239 payment_data: Some(msgs::FinalOnionHopData {
12240 payment_secret: PaymentSecret([0; 32]), total_msat: 100,
12242 custom_tlvs: Vec::new(),
12243 }, [0; 32], PaymentHash([0; 32]), 100, 23, None, true, None, current_height,
12244 node[0].node.default_configuration.accept_mpp_keysend);
12246 // Should not return an error as this condition:
12247 // https://github.com/lightning/bolts/blob/4dcc377209509b13cf89a4b91fde7d478f5b46d8/04-onion-routing.md?plain=1#L334
12248 // is not satisfied.
12249 assert!(result.is_ok());
12253 fn test_inbound_anchors_manual_acceptance() {
12254 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
12255 // flag set and (sometimes) accept channels as 0conf.
12256 let mut anchors_cfg = test_default_channel_config();
12257 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12259 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
12260 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
12262 let chanmon_cfgs = create_chanmon_cfgs(3);
12263 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
12264 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
12265 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
12266 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
12268 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
12269 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12271 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12272 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12273 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
12274 match &msg_events[0] {
12275 MessageSendEvent::HandleError { node_id, action } => {
12276 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
12278 ErrorAction::SendErrorMessage { msg } =>
12279 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
12280 _ => panic!("Unexpected error action"),
12283 _ => panic!("Unexpected event"),
12286 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12287 let events = nodes[2].node.get_and_clear_pending_events();
12289 Event::OpenChannelRequest { temporary_channel_id, .. } =>
12290 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
12291 _ => panic!("Unexpected event"),
12293 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
12297 fn test_anchors_zero_fee_htlc_tx_fallback() {
12298 // Tests that if both nodes support anchors, but the remote node does not want to accept
12299 // anchor channels at the moment, an error it sent to the local node such that it can retry
12300 // the channel without the anchors feature.
12301 let chanmon_cfgs = create_chanmon_cfgs(2);
12302 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
12303 let mut anchors_config = test_default_channel_config();
12304 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
12305 anchors_config.manually_accept_inbound_channels = true;
12306 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
12307 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
12309 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None, None).unwrap();
12310 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12311 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
12313 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
12314 let events = nodes[1].node.get_and_clear_pending_events();
12316 Event::OpenChannelRequest { temporary_channel_id, .. } => {
12317 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
12319 _ => panic!("Unexpected event"),
12322 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
12323 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
12325 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
12326 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
12328 // Since nodes[1] should not have accepted the channel, it should
12329 // not have generated any events.
12330 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
12334 fn test_update_channel_config() {
12335 let chanmon_cfg = create_chanmon_cfgs(2);
12336 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12337 let mut user_config = test_default_channel_config();
12338 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12339 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12340 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
12341 let channel = &nodes[0].node.list_channels()[0];
12343 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12344 let events = nodes[0].node.get_and_clear_pending_msg_events();
12345 assert_eq!(events.len(), 0);
12347 user_config.channel_config.forwarding_fee_base_msat += 10;
12348 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
12349 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
12350 let events = nodes[0].node.get_and_clear_pending_msg_events();
12351 assert_eq!(events.len(), 1);
12353 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12354 _ => panic!("expected BroadcastChannelUpdate event"),
12357 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
12358 let events = nodes[0].node.get_and_clear_pending_msg_events();
12359 assert_eq!(events.len(), 0);
12361 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
12362 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12363 cltv_expiry_delta: Some(new_cltv_expiry_delta),
12364 ..Default::default()
12366 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12367 let events = nodes[0].node.get_and_clear_pending_msg_events();
12368 assert_eq!(events.len(), 1);
12370 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12371 _ => panic!("expected BroadcastChannelUpdate event"),
12374 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
12375 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12376 forwarding_fee_proportional_millionths: Some(new_fee),
12377 ..Default::default()
12379 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12380 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
12381 let events = nodes[0].node.get_and_clear_pending_msg_events();
12382 assert_eq!(events.len(), 1);
12384 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12385 _ => panic!("expected BroadcastChannelUpdate event"),
12388 // If we provide a channel_id not associated with the peer, we should get an error and no updates
12389 // should be applied to ensure update atomicity as specified in the API docs.
12390 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
12391 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
12392 let new_fee = current_fee + 100;
12395 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
12396 forwarding_fee_proportional_millionths: Some(new_fee),
12397 ..Default::default()
12399 Err(APIError::ChannelUnavailable { err: _ }),
12402 // Check that the fee hasn't changed for the channel that exists.
12403 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
12404 let events = nodes[0].node.get_and_clear_pending_msg_events();
12405 assert_eq!(events.len(), 0);
12409 fn test_payment_display() {
12410 let payment_id = PaymentId([42; 32]);
12411 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12412 let payment_hash = PaymentHash([42; 32]);
12413 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12414 let payment_preimage = PaymentPreimage([42; 32]);
12415 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12419 fn test_trigger_lnd_force_close() {
12420 let chanmon_cfg = create_chanmon_cfgs(2);
12421 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12422 let user_config = test_default_channel_config();
12423 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12424 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12426 // Open a channel, immediately disconnect each other, and broadcast Alice's latest state.
12427 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
12428 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
12429 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12430 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
12431 check_closed_broadcast(&nodes[0], 1, true);
12432 check_added_monitors(&nodes[0], 1);
12433 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
12435 let txn = nodes[0].tx_broadcaster.txn_broadcast();
12436 assert_eq!(txn.len(), 1);
12437 check_spends!(txn[0], funding_tx);
12440 // Since they're disconnected, Bob won't receive Alice's `Error` message. Reconnect them
12441 // such that Bob sends a `ChannelReestablish` to Alice since the channel is still open from
12443 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
12444 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
12446 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12447 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12448 }, false).unwrap();
12449 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
12450 let channel_reestablish = get_event_msg!(
12451 nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()
12453 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &channel_reestablish);
12455 // Alice should respond with an error since the channel isn't known, but a bogus
12456 // `ChannelReestablish` should be sent first, such that we actually trigger Bob to force
12457 // close even if it was an lnd node.
12458 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
12459 assert_eq!(msg_events.len(), 2);
12460 if let MessageSendEvent::SendChannelReestablish { node_id, msg } = &msg_events[0] {
12461 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
12462 assert_eq!(msg.next_local_commitment_number, 0);
12463 assert_eq!(msg.next_remote_commitment_number, 0);
12464 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &msg);
12465 } else { panic!() };
12466 check_closed_broadcast(&nodes[1], 1, true);
12467 check_added_monitors(&nodes[1], 1);
12468 let expected_close_reason = ClosureReason::ProcessingError {
12469 err: "Peer sent an invalid channel_reestablish to force close in a non-standard way".to_string()
12471 check_closed_event!(nodes[1], 1, expected_close_reason, [nodes[0].node.get_our_node_id()], 100000);
12473 let txn = nodes[1].tx_broadcaster.txn_broadcast();
12474 assert_eq!(txn.len(), 1);
12475 check_spends!(txn[0], funding_tx);
12480 fn test_malformed_forward_htlcs_ser() {
12481 // Ensure that `HTLCForwardInfo::FailMalformedHTLC`s are (de)serialized properly.
12482 let chanmon_cfg = create_chanmon_cfgs(1);
12483 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
12486 let chanmgrs = create_node_chanmgrs(1, &node_cfg, &[None]);
12487 let deserialized_chanmgr;
12488 let mut nodes = create_network(1, &node_cfg, &chanmgrs);
12490 let dummy_failed_htlc = |htlc_id| {
12491 HTLCForwardInfo::FailHTLC { htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }, }
12493 let dummy_malformed_htlc = |htlc_id| {
12494 HTLCForwardInfo::FailMalformedHTLC { htlc_id, failure_code: 0x4000, sha256_of_onion: [0; 32] }
12497 let dummy_htlcs_1: Vec<HTLCForwardInfo> = (1..10).map(|htlc_id| {
12498 if htlc_id % 2 == 0 {
12499 dummy_failed_htlc(htlc_id)
12501 dummy_malformed_htlc(htlc_id)
12505 let dummy_htlcs_2: Vec<HTLCForwardInfo> = (1..10).map(|htlc_id| {
12506 if htlc_id % 2 == 1 {
12507 dummy_failed_htlc(htlc_id)
12509 dummy_malformed_htlc(htlc_id)
12514 let (scid_1, scid_2) = (42, 43);
12515 let mut forward_htlcs = HashMap::new();
12516 forward_htlcs.insert(scid_1, dummy_htlcs_1.clone());
12517 forward_htlcs.insert(scid_2, dummy_htlcs_2.clone());
12519 let mut chanmgr_fwd_htlcs = nodes[0].node.forward_htlcs.lock().unwrap();
12520 *chanmgr_fwd_htlcs = forward_htlcs.clone();
12521 core::mem::drop(chanmgr_fwd_htlcs);
12523 reload_node!(nodes[0], nodes[0].node.encode(), &[], persister, chain_monitor, deserialized_chanmgr);
12525 let mut deserialized_fwd_htlcs = nodes[0].node.forward_htlcs.lock().unwrap();
12526 for scid in [scid_1, scid_2].iter() {
12527 let deserialized_htlcs = deserialized_fwd_htlcs.remove(scid).unwrap();
12528 assert_eq!(forward_htlcs.remove(scid).unwrap(), deserialized_htlcs);
12530 assert!(deserialized_fwd_htlcs.is_empty());
12531 core::mem::drop(deserialized_fwd_htlcs);
12533 expect_pending_htlcs_forwardable!(nodes[0]);
12539 use crate::chain::Listen;
12540 use crate::chain::chainmonitor::{ChainMonitor, Persist};
12541 use crate::sign::{KeysManager, InMemorySigner};
12542 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
12543 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
12544 use crate::ln::functional_test_utils::*;
12545 use crate::ln::msgs::{ChannelMessageHandler, Init};
12546 use crate::routing::gossip::NetworkGraph;
12547 use crate::routing::router::{PaymentParameters, RouteParameters};
12548 use crate::util::test_utils;
12549 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
12551 use bitcoin::blockdata::locktime::absolute::LockTime;
12552 use bitcoin::hashes::Hash;
12553 use bitcoin::hashes::sha256::Hash as Sha256;
12554 use bitcoin::{Transaction, TxOut};
12556 use crate::sync::{Arc, Mutex, RwLock};
12558 use criterion::Criterion;
12560 type Manager<'a, P> = ChannelManager<
12561 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
12562 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
12563 &'a test_utils::TestLogger, &'a P>,
12564 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
12565 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
12566 &'a test_utils::TestLogger>;
12568 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
12569 node: &'node_cfg Manager<'chan_mon_cfg, P>,
12571 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
12572 type CM = Manager<'chan_mon_cfg, P>;
12574 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
12576 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
12579 pub fn bench_sends(bench: &mut Criterion) {
12580 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
12583 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
12584 // Do a simple benchmark of sending a payment back and forth between two nodes.
12585 // Note that this is unrealistic as each payment send will require at least two fsync
12587 let network = bitcoin::Network::Testnet;
12588 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
12590 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
12591 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
12592 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
12593 let scorer = RwLock::new(test_utils::TestScorer::new());
12594 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &logger_a, &scorer);
12596 let mut config: UserConfig = Default::default();
12597 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
12598 config.channel_handshake_config.minimum_depth = 1;
12600 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
12601 let seed_a = [1u8; 32];
12602 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
12603 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 {
12605 best_block: BestBlock::from_network(network),
12606 }, genesis_block.header.time);
12607 let node_a_holder = ANodeHolder { node: &node_a };
12609 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
12610 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
12611 let seed_b = [2u8; 32];
12612 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
12613 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 {
12615 best_block: BestBlock::from_network(network),
12616 }, genesis_block.header.time);
12617 let node_b_holder = ANodeHolder { node: &node_b };
12619 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
12620 features: node_b.init_features(), networks: None, remote_network_address: None
12622 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
12623 features: node_a.init_features(), networks: None, remote_network_address: None
12624 }, false).unwrap();
12625 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None, None).unwrap();
12626 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()));
12627 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()));
12630 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
12631 tx = Transaction { version: 2, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
12632 value: 8_000_000, script_pubkey: output_script,
12634 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
12635 } else { panic!(); }
12637 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()));
12638 let events_b = node_b.get_and_clear_pending_events();
12639 assert_eq!(events_b.len(), 1);
12640 match events_b[0] {
12641 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12642 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12644 _ => panic!("Unexpected event"),
12647 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()));
12648 let events_a = node_a.get_and_clear_pending_events();
12649 assert_eq!(events_a.len(), 1);
12650 match events_a[0] {
12651 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12652 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12654 _ => panic!("Unexpected event"),
12657 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
12659 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
12660 Listen::block_connected(&node_a, &block, 1);
12661 Listen::block_connected(&node_b, &block, 1);
12663 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()));
12664 let msg_events = node_a.get_and_clear_pending_msg_events();
12665 assert_eq!(msg_events.len(), 2);
12666 match msg_events[0] {
12667 MessageSendEvent::SendChannelReady { ref msg, .. } => {
12668 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
12669 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
12673 match msg_events[1] {
12674 MessageSendEvent::SendChannelUpdate { .. } => {},
12678 let events_a = node_a.get_and_clear_pending_events();
12679 assert_eq!(events_a.len(), 1);
12680 match events_a[0] {
12681 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12682 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12684 _ => panic!("Unexpected event"),
12687 let events_b = node_b.get_and_clear_pending_events();
12688 assert_eq!(events_b.len(), 1);
12689 match events_b[0] {
12690 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12691 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12693 _ => panic!("Unexpected event"),
12696 let mut payment_count: u64 = 0;
12697 macro_rules! send_payment {
12698 ($node_a: expr, $node_b: expr) => {
12699 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
12700 .with_bolt11_features($node_b.bolt11_invoice_features()).unwrap();
12701 let mut payment_preimage = PaymentPreimage([0; 32]);
12702 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
12703 payment_count += 1;
12704 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
12705 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
12707 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
12708 PaymentId(payment_hash.0),
12709 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
12710 Retry::Attempts(0)).unwrap();
12711 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
12712 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
12713 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
12714 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
12715 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
12716 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
12717 $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()));
12719 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
12720 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
12721 $node_b.claim_funds(payment_preimage);
12722 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
12724 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
12725 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
12726 assert_eq!(node_id, $node_a.get_our_node_id());
12727 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
12728 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
12730 _ => panic!("Failed to generate claim event"),
12733 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
12734 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
12735 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
12736 $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()));
12738 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
12742 bench.bench_function(bench_name, |b| b.iter(|| {
12743 send_payment!(node_a, node_b);
12744 send_payment!(node_b, node_a);